az network express-route peering

Manage ExpressRoute peering.

Commands

az network express-route peering create Create peering settings.
az network express-route peering delete Delete peering settings.
az network express-route peering list List peering settings.
az network express-route peering show Get the details for an express route peering.
az network express-route peering update Update peering settings.

az network express-route peering create

Create peering settings.

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

Examples

Create Microsoft Peering settings with IPv4 configuration.

az network express-route peering create -g myrg --circuit-name circuit1 --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

Add IPv6 Microsoft Peering settings to existing IPv4 config.

az network express-route peering update -g myrg --circuit-name circuit1 --peering-type MicrosoftPeering --ip-version ipv6 --primary-peer-subnet 2002:db00::/126 --secondary-peer-subnet 2003:db00::/126 --advertised-public-prefixes 2002:db00::/126

Required Parameters

--circuit-name
ExpressRoute circuit 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
List of prefixes to be advertised through the BGP peering. Required to set up Microsoft Peering.
--customer-asn
Autonomous system number of the customer.
--route-filter
Name or ID of a route filter to apply to the peering settings.
--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 express-route peering delete

Delete peering settings.

az network express-route peering delete --circuit-name
--name
--resource-group

Required Parameters

--circuit-name
ExpressRoute circuit 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 express-route peering list

List peering settings.

az network express-route peering list --circuit-name
--resource-group

Required Parameters

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

az network express-route peering show

Get the details for an express route peering.

az network express-route peering show --circuit-name
--name
--resource-group

Required Parameters

--circuit-name
ExpressRoute circuit 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 express-route peering update

Update peering settings.

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

Examples

Add IPv6 Microsoft Peering settings to existing IPv4 config.

az network express-route peering update -g myrg --circuit-name circuit1 --peering-type MicrosoftPeering --ip-version ipv6 --primary-peer-subnet 2002:db00::/126 --secondary-peer-subnet 2003:db00::/126 --advertised-public-prefixes 2002:db00::/126

Required Parameters

--circuit-name
ExpressRoute circuit 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 .
--advertised-public-prefixes
List of prefixes to be advertised through the BGP peering. Required to set up Microsoft Peering.
--customer-asn
Autonomous system number of the customer.
--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.
--route-filter
Name or ID of a route filter to apply to the peering settings.
--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.