express_route_cross_connection_peerings

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

Overview

Name	express_route_cross_connection_peerings
Type	Resource
Id	azure.network.express_route_cross_connection_peerings

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
azureASN	integer	The Azure ASN.
etag	string	A unique read-only string that changes whenever the resource is updated.
gatewayManagerEtag	string	The GatewayManager Etag.
ipv6PeeringConfig	object	The IPv6 peering configuration.
lastModifiedBy	string	Who was the last to modify the peering.
microsoftPeeringConfig	object	The Microsoft peering configuration.
peerASN	integer	The peer ASN.
peeringType	string	The peering type. Known values are: "AzurePublicPeering", "AzurePrivatePeering", and "MicrosoftPeering". (AzurePublicPeering, AzurePrivatePeering, MicrosoftPeering)
primaryAzurePort	string	The primary port.
primaryPeerAddressPrefix	string	The primary address prefix.
provisioningState	string	The provisioning state of the express route cross connection peering resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
secondaryAzurePort	string	The secondary port.
secondaryPeerAddressPrefix	string	The secondary address prefix.
sharedKey	string	The shared key.
state	string	The peering state. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
vlanId	integer	The VLAN ID.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
azureASN	integer	The Azure ASN.
etag	string	A unique read-only string that changes whenever the resource is updated.
gatewayManagerEtag	string	The GatewayManager Etag.
ipv6PeeringConfig	object	The IPv6 peering configuration.
lastModifiedBy	string	Who was the last to modify the peering.
microsoftPeeringConfig	object	The Microsoft peering configuration.
peerASN	integer	The peer ASN.
peeringType	string	The peering type. Known values are: "AzurePublicPeering", "AzurePrivatePeering", and "MicrosoftPeering". (AzurePublicPeering, AzurePrivatePeering, MicrosoftPeering)
primaryAzurePort	string	The primary port.
primaryPeerAddressPrefix	string	The primary address prefix.
provisioningState	string	The provisioning state of the express route cross connection peering resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
secondaryAzurePort	string	The secondary port.
secondaryPeerAddressPrefix	string	The secondary address prefix.
sharedKey	string	The shared key.
state	string	The peering state. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
vlanId	integer	The VLAN ID.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, cross_connection_name, peering_name, subscription_id		Gets the specified peering for the ExpressRouteCrossConnection.
list	select	resource_group_name, cross_connection_name, subscription_id		Gets all peerings in a specified ExpressRouteCrossConnection.
create_or_update	insert	resource_group_name, cross_connection_name, peering_name, subscription_id		Creates or updates a peering in the specified ExpressRouteCrossConnection.
create_or_update	replace	resource_group_name, cross_connection_name, peering_name, subscription_id		Creates or updates a peering in the specified ExpressRouteCrossConnection.
delete	delete	resource_group_name, cross_connection_name, peering_name, subscription_id		Deletes the specified peering from the ExpressRouteCrossConnection.

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
cross_connection_name	string	Name for the express route cross connection. Required.
peering_name	string	The name of the peering. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the specified peering for the ExpressRouteCrossConnection.

SELECT
id,
name,
azureASN,
etag,
gatewayManagerEtag,
ipv6PeeringConfig,
lastModifiedBy,
microsoftPeeringConfig,
peerASN,
peeringType,
primaryAzurePort,
primaryPeerAddressPrefix,
provisioningState,
secondaryAzurePort,
secondaryPeerAddressPrefix,
sharedKey,
state,
vlanId
FROM azure.network.express_route_cross_connection_peerings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cross_connection_name = '{{ cross_connection_name }}' -- required
AND peering_name = '{{ peering_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all peerings in a specified ExpressRouteCrossConnection.

SELECT
id,
name,
azureASN,
etag,
gatewayManagerEtag,
ipv6PeeringConfig,
lastModifiedBy,
microsoftPeeringConfig,
peerASN,
peeringType,
primaryAzurePort,
primaryPeerAddressPrefix,
provisioningState,
secondaryAzurePort,
secondaryPeerAddressPrefix,
sharedKey,
state,
vlanId
FROM azure.network.express_route_cross_connection_peerings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cross_connection_name = '{{ cross_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a peering in the specified ExpressRouteCrossConnection.

INSERT INTO azure.network.express_route_cross_connection_peerings (
id,
properties,
name,
resource_group_name,
cross_connection_name,
peering_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ properties }}',
'{{ name }}',
'{{ resource_group_name }}',
'{{ cross_connection_name }}',
'{{ peering_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties
;

Manifest

# Description fields are for documentation purposes
- name: express_route_cross_connection_peerings
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the express_route_cross_connection_peerings resource.
  - name: cross_connection_name
    value: "{{ cross_connection_name }}"
    description: Required parameter for the express_route_cross_connection_peerings resource.
  - name: peering_name
    value: "{{ peering_name }}"
    description: Required parameter for the express_route_cross_connection_peerings resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the express_route_cross_connection_peerings resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: properties
    description: |
      Properties of the express route cross connection peering.
    value:
      peeringType: "{{ peeringType }}"
      state: "{{ state }}"
      azureASN: {{ azureASN }}
      peerASN: {{ peerASN }}
      primaryPeerAddressPrefix: "{{ primaryPeerAddressPrefix }}"
      secondaryPeerAddressPrefix: "{{ secondaryPeerAddressPrefix }}"
      primaryAzurePort: "{{ primaryAzurePort }}"
      secondaryAzurePort: "{{ secondaryAzurePort }}"
      sharedKey: "{{ sharedKey }}"
      vlanId: {{ vlanId }}
      microsoftPeeringConfig:
        advertisedPublicPrefixes:
          - "{{ advertisedPublicPrefixes }}"
        advertisedCommunities:
          - "{{ advertisedCommunities }}"
        advertisedPublicPrefixesState: "{{ advertisedPublicPrefixesState }}"
        legacyMode: {{ legacyMode }}
        customerASN: {{ customerASN }}
        routingRegistryName: "{{ routingRegistryName }}"
        advertisedPublicPrefixInfo:
          - prefix: "{{ prefix }}"
            validationId: "{{ validationId }}"
            signature: "{{ signature }}"
            validationState: "{{ validationState }}"
      provisioningState: "{{ provisioningState }}"
      gatewayManagerEtag: "{{ gatewayManagerEtag }}"
      lastModifiedBy: "{{ lastModifiedBy }}"
      ipv6PeeringConfig:
        primaryPeerAddressPrefix: "{{ primaryPeerAddressPrefix }}"
        secondaryPeerAddressPrefix: "{{ secondaryPeerAddressPrefix }}"
        microsoftPeeringConfig:
          advertisedPublicPrefixes:
            - "{{ advertisedPublicPrefixes }}"
          advertisedCommunities:
            - "{{ advertisedCommunities }}"
          advertisedPublicPrefixesState: "{{ advertisedPublicPrefixesState }}"
          legacyMode: {{ legacyMode }}
          customerASN: {{ customerASN }}
          routingRegistryName: "{{ routingRegistryName }}"
          advertisedPublicPrefixInfo:
            - prefix: "{{ prefix }}"
              validationId: "{{ validationId }}"
              signature: "{{ signature }}"
              validationState: "{{ validationState }}"
        routeFilter:
          id: "{{ id }}"
        state: "{{ state }}"
  - name: name
    value: "{{ name }}"
    description: |
      The name of the resource that is unique within a resource group. This name can be used to access the resource.

REPLACE examples

create_or_update

Creates or updates a peering in the specified ExpressRouteCrossConnection.

REPLACE azure.network.express_route_cross_connection_peerings
SET 
id = '{{ id }}',
properties = '{{ properties }}',
name = '{{ name }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cross_connection_name = '{{ cross_connection_name }}' --required
AND peering_name = '{{ peering_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties;

DELETE examples

delete

Deletes the specified peering from the ExpressRouteCrossConnection.

DELETE FROM azure.network.express_route_cross_connection_peerings
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cross_connection_name = '{{ cross_connection_name }}' --required
AND peering_name = '{{ peering_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;