az network cross-connection peering

Manage ExpressRoute peering of an ExpressRoute cross-connection.

Commands

az network cross-connection peering create

Create peering settings for an ExpressRoute cross-connection.

az network cross-connection peering delete

Delete peering settings.

az network cross-connection peering list

List peering settings of an ExpressRoute cross-connection.

az network cross-connection peering show

Get the details of an express route peering.

az network cross-connection peering update

Update peering settings for an ExpressRoute cross-connection.

az network cross-connection peering create

Create peering settings for an ExpressRoute cross-connection.

az network cross-connection peering create --cross-connection-name
                                           --peer-asn
                                           --peering-type {AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering}
                                           --primary-peer-subnet
                                           --resource-group
                                           --secondary-peer-subnet
                                           --vlan-id
                                           [--advertised-public-prefixes]
                                           [--customer-asn]
                                           [--routing-registry-name {AFRINIC, ALTDB, APNIC, ARIN, LACNIC, LEVEL3, RADB, RIPENCC}]
                                           [--shared-key]

Examples

Create Microsoft Peering settings with IPv4 configuration.

az network cross-connection peering create -g MyResourceGroup --cross-connection-name MyCircuit \
    --peering-type MicrosoftPeering --peer-asn 10002 --vlan-id 103 \
    --primary-peer-subnet 101.0.0.0/30 --secondary-peer-subnet 102.0.0.0/30 \
    --advertised-public-prefixes 101.0.0.0/30

Required Parameters

--cross-connection-name

ExpressRoute cross-connection name.

--peer-asn

Autonomous system number of the customer/connectivity provider.

--peering-type

BGP peering type for the circuit.

accepted values: AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering
--primary-peer-subnet

/30 subnet used to configure IP addresses for primary interface.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--secondary-peer-subnet

/30 subnet used to configure IP addresses for secondary interface.

--vlan-id

Identifier used to identify the customer.

Optional Parameters

--advertised-public-prefixes

Space-separated list of prefixes to be advertised through the BGP peering.

--customer-asn

Autonomous system number of the customer.

--routing-registry-name

Internet Routing Registry / Regional Internet Registry.

accepted values: AFRINIC, ALTDB, APNIC, ARIN, LACNIC, LEVEL3, RADB, RIPENCC
--shared-key

Key for generating an MD5 for the BGP session.

az network cross-connection peering delete

Delete peering settings.

az network cross-connection peering delete --cross-connection-name
                                           --name
                                           --resource-group

Examples

Delete private peering.

az network cross-connection peering delete -g MyResourceGroup --cross-connection-name MyCircuit -n AzurePrivatePeering

Required Parameters

--cross-connection-name

ExpressRoute cross-connection name.

--name -n

The name of the peering.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

az network cross-connection peering list

List peering settings of an ExpressRoute cross-connection.

az network cross-connection peering list --cross-connection-name
                                         --resource-group

Examples

List peering settings of an ExpressRoute cross-connection.

az network cross-connection peering list -g MyResourceGroup --cross-connection-name MyCircuit

Required Parameters

--cross-connection-name

ExpressRoute cross-connection name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

az network cross-connection peering show

Get the details of an express route peering.

az network cross-connection peering show --cross-connection-name
                                         --name
                                         --resource-group

Examples

Get private peering details of an ExpressRoute cross-connection.

az network cross-connection peering show -g MyResourceGroup --cross-connection-name MyCircuit -n AzurePrivatePeering

Required Parameters

--cross-connection-name

ExpressRoute cross-connection name.

--name -n

The name of the peering.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

az network cross-connection peering update

Update peering settings for an ExpressRoute cross-connection.

az network cross-connection peering update --cross-connection-name
                                           --name
                                           --resource-group
                                           [--add]
                                           [--advertised-public-prefixes]
                                           [--customer-asn]
                                           [--force-string]
                                           [--ip-version {IPv4, IPv6}]
                                           [--peer-asn]
                                           [--primary-peer-subnet]
                                           [--remove]
                                           [--routing-registry-name {AFRINIC, ALTDB, APNIC, ARIN, LACNIC, LEVEL3, RADB, RIPENCC}]
                                           [--secondary-peer-subnet]
                                           [--set]
                                           [--shared-key]
                                           [--vlan-id]

Required Parameters

--cross-connection-name

ExpressRoute cross-connection name.

--name -n

The name of the peering.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--advertised-public-prefixes

Space-separated list of prefixes to be advertised through the BGP peering.

--customer-asn

Autonomous system number of the customer.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

--ip-version

The IP version to update Microsoft Peering settings for.

accepted values: IPv4, IPv6
default value: IPv4
--peer-asn

Autonomous system number of the customer/connectivity provider.

--primary-peer-subnet

/30 subnet used to configure IP addresses for primary interface.

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--routing-registry-name

Internet Routing Registry / Regional Internet Registry.

accepted values: AFRINIC, ALTDB, APNIC, ARIN, LACNIC, LEVEL3, RADB, RIPENCC
--secondary-peer-subnet

/30 subnet used to configure IP addresses for secondary interface.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--shared-key

Key for generating an MD5 for the BGP session.

--vlan-id

Identifier used to identify the customer.