access_bridges

Creates, updates, deletes, gets or lists an access_bridges resource.

Overview

Name	access_bridges
Type	Resource
Id	azure_extras.network_cloud.access_bridges

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
detailedStatus	string	The detailed status reported by the access bridge. Known values are: "Running", "Degraded", and "Failed". (Running, Degraded, Failed)
detailedStatusMessage	string	The descriptive message that accompanies the detailed status.
endpoints	array	The observed endpoints that clients should use to reach the access bridge.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
extendedLocation	object	The extended location of the resource. This property is required when creating the resource. Required.
ipv4ConnectedPrefix	string	The IPv4 subnet from which the access bridge allocates an address. This subnet must be part of the internal network specified by networkId.
ipv6ConnectedPrefix	string	The IPv6 subnet from which the access bridge allocates an address. This subnet must be part of the internal network specified by networkId.
location	string	The geo-location where the resource lives. Required.
networkId	string	The resource ID of the internal network in a layer 3 isolation domain containing the IP subnets to use. Required.
protocol	string	The protocol advertised by the access bridge endpoints. Known values are: "TCP" and "UDP". (TCP, UDP)
provisioningState	string	The provisioning state of the access bridge. Known values are: "Accepted", "Canceled", "Failed", "Provisioning", and "Succeeded". (Accepted, Canceled, Failed, Provisioning, Succeeded)
securityRules	array	The list of security rules enforced by the access bridge.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
detailedStatus	string	The detailed status reported by the access bridge. Known values are: "Running", "Degraded", and "Failed". (Running, Degraded, Failed)
detailedStatusMessage	string	The descriptive message that accompanies the detailed status.
endpoints	array	The observed endpoints that clients should use to reach the access bridge.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
extendedLocation	object	The extended location of the resource. This property is required when creating the resource. Required.
ipv4ConnectedPrefix	string	The IPv4 subnet from which the access bridge allocates an address. This subnet must be part of the internal network specified by networkId.
ipv6ConnectedPrefix	string	The IPv6 subnet from which the access bridge allocates an address. This subnet must be part of the internal network specified by networkId.
location	string	The geo-location where the resource lives. Required.
networkId	string	The resource ID of the internal network in a layer 3 isolation domain containing the IP subnets to use. Required.
protocol	string	The protocol advertised by the access bridge endpoints. Known values are: "TCP" and "UDP". (TCP, UDP)
provisioningState	string	The provisioning state of the access bridge. Known values are: "Accepted", "Canceled", "Failed", "Provisioning", and "Succeeded". (Accepted, Canceled, Failed, Provisioning, Succeeded)
securityRules	array	The list of security rules enforced by the access bridge.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
detailedStatus	string	The detailed status reported by the access bridge. Known values are: "Running", "Degraded", and "Failed". (Running, Degraded, Failed)
detailedStatusMessage	string	The descriptive message that accompanies the detailed status.
endpoints	array	The observed endpoints that clients should use to reach the access bridge.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
extendedLocation	object	The extended location of the resource. This property is required when creating the resource. Required.
ipv4ConnectedPrefix	string	The IPv4 subnet from which the access bridge allocates an address. This subnet must be part of the internal network specified by networkId.
ipv6ConnectedPrefix	string	The IPv6 subnet from which the access bridge allocates an address. This subnet must be part of the internal network specified by networkId.
location	string	The geo-location where the resource lives. Required.
networkId	string	The resource ID of the internal network in a layer 3 isolation domain containing the IP subnets to use. Required.
protocol	string	The protocol advertised by the access bridge endpoints. Known values are: "TCP" and "UDP". (TCP, UDP)
provisioningState	string	The provisioning state of the access bridge. Known values are: "Accepted", "Canceled", "Failed", "Provisioning", and "Succeeded". (Accepted, Canceled, Failed, Provisioning, Succeeded)
securityRules	array	The list of security rules enforced by the access bridge.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, access_bridge_name, subscription_id		Get the properties of the provided access bridge.
list_by_resource_group	select	resource_group_name, subscription_id	$top, $skipToken	Get a list of access bridges in the provided resource group.
list_by_subscription	select	subscription_id	$top, $skipToken	Get a list of access bridges in the provided subscription.
create_or_update	insert	resource_group_name, access_bridge_name, subscription_id, location, properties, extendedLocation		Create a new access bridge or update the properties of the existing access bridge.
update	update	resource_group_name, access_bridge_name, subscription_id		Update properties of the provided access bridge, or update tags associated with the access bridge. Properties and tag updates can be done independently.
create_or_update	replace	resource_group_name, access_bridge_name, subscription_id, location, properties, extendedLocation		Create a new access bridge or update the properties of the existing access bridge.
delete	delete	resource_group_name, access_bridge_name, subscription_id		Delete the specified access bridge.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
access_bridge_name	string	The name of the access bridge. Known values are: "Bastion", "PrivateVault", and "StorageDashboard". Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$skipToken	string	The opaque token that the server returns to indicate where to continue listing resources from. This is used for paging through large result sets. Default value is None.
$top	integer	The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

SELECT examples

get

Get the properties of the provided access bridge.

SELECT
id,
name,
detailedStatus,
detailedStatusMessage,
endpoints,
etag,
extendedLocation,
ipv4ConnectedPrefix,
ipv6ConnectedPrefix,
location,
networkId,
protocol,
provisioningState,
securityRules,
systemData,
tags,
type
FROM azure_extras.network_cloud.access_bridges
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND access_bridge_name = '{{ access_bridge_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Get a list of access bridges in the provided resource group.

SELECT
id,
name,
detailedStatus,
detailedStatusMessage,
endpoints,
etag,
extendedLocation,
ipv4ConnectedPrefix,
ipv6ConnectedPrefix,
location,
networkId,
protocol,
provisioningState,
securityRules,
systemData,
tags,
type
FROM azure_extras.network_cloud.access_bridges
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

list_by_subscription

Get a list of access bridges in the provided subscription.

SELECT
id,
name,
detailedStatus,
detailedStatusMessage,
endpoints,
etag,
extendedLocation,
ipv4ConnectedPrefix,
ipv6ConnectedPrefix,
location,
networkId,
protocol,
provisioningState,
securityRules,
systemData,
tags,
type
FROM azure_extras.network_cloud.access_bridges
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Create a new access bridge or update the properties of the existing access bridge.

INSERT INTO azure_extras.network_cloud.access_bridges (
tags,
location,
properties,
extendedLocation,
resource_group_name,
access_bridge_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ extendedLocation }}' /* required */,
'{{ resource_group_name }}',
'{{ access_bridge_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: access_bridges
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the access_bridges resource.
  - name: access_bridge_name
    value: "{{ access_bridge_name }}"
    description: Required parameter for the access_bridges resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the access_bridges resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The list of the resource properties. Required.
    value:
      ipv4ConnectedPrefix: "{{ ipv4ConnectedPrefix }}"
      ipv6ConnectedPrefix: "{{ ipv6ConnectedPrefix }}"
      networkId: "{{ networkId }}"
      securityRules:
        - description: "{{ description }}"
          direction: "{{ direction }}"
          ipv4Addresses: "{{ ipv4Addresses }}"
          ipv6Addresses: "{{ ipv6Addresses }}"
          port: "{{ port }}"
      detailedStatus: "{{ detailedStatus }}"
      detailedStatusMessage: "{{ detailedStatusMessage }}"
      endpoints:
        - fqdn: "{{ fqdn }}"
          ipv4Address: "{{ ipv4Address }}"
          ipv6Address: "{{ ipv6Address }}"
          name: "{{ name }}"
      protocol: "{{ protocol }}"
      provisioningState: "{{ provisioningState }}"
  - name: extendedLocation
    description: |
      The extended location of the resource. This property is required when creating the resource. Required.
    value:
      name: "{{ name }}"
      type: "{{ type }}"

UPDATE examples

update

Update properties of the provided access bridge, or update tags associated with the access bridge. Properties and tag updates can be done independently.

UPDATE azure_extras.network_cloud.access_bridges
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND access_bridge_name = '{{ access_bridge_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a new access bridge or update the properties of the existing access bridge.

REPLACE azure_extras.network_cloud.access_bridges
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND access_bridge_name = '{{ access_bridge_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND properties = '{{ properties }}' --required
AND extendedLocation = '{{ extendedLocation }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete the specified access bridge.

DELETE FROM azure_extras.network_cloud.access_bridges
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND access_bridge_name = '{{ access_bridge_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;