az network express-route peering

Manage ExpressRoute peering of an ExpressRoute circuit.

Commands

az network express-route peering connection

Manage ExpressRoute circuit connections.

az network express-route peering connection create

Create connections between two ExpressRoute circuits.

az network express-route peering connection delete

Delete an ExpressRoute circuit connection.

az network express-route peering connection show

Get the details of an ExpressRoute circuit connection.

az network express-route peering create

Create peering settings for an ExpressRoute circuit.

az network express-route peering delete

Delete peering settings.

az network express-route peering list

List peering settings of an ExpressRoute circuit.

az network express-route peering peer-connection

Manage ExpressRoute circuit peer connections.

az network express-route peering peer-connection list

Gets all global reach peer connections associated with a private peering in an express route circuit.

az network express-route peering peer-connection show

Gets the specified Peer Express Route Circuit Connection from the specified express route circuit.

az network express-route peering show

Get the details of an express route peering.

az network express-route peering update

Update peering settings of an ExpressRoute circuit.

az network express-route peering create

Create peering settings for an ExpressRoute circuit.

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]
                                        [--legacy-mode]
                                        [--route-filter]
                                        [--routing-registry-name {AFRINIC, ALTDB, APNIC, ARIN, LACNIC, LEVEL3, RADB, RIPENCC}]
                                        [--shared-key]
                                        [--subscription]

Examples

Create Microsoft Peering settings with IPv4 configuration.

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

--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

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

--customer-asn

Autonomous system number of the customer.

--legacy-mode

Integer representing the legacy mode of the peering.

--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.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az network express-route peering delete

Delete peering settings.

az network express-route peering delete [--circuit-name]
                                        [--ids]
                                        [--name]
                                        [--resource-group]
                                        [--subscription]

Examples

Delete private peering.

az network express-route peering delete -g MyResourceGroup --circuit-name MyCircuit -n AzurePrivatePeering

Optional Parameters

--circuit-name

ExpressRoute circuit name.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--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>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az network express-route peering list

List peering settings of an ExpressRoute circuit.

az network express-route peering list --circuit-name
                                      --resource-group
                                      [--query-examples]
                                      [--subscription]

Examples

List peering settings of an ExpressRoute circuit.

az network express-route peering list -g MyResourceGroup --circuit-name MyCircuit

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>.

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az network express-route peering show

Get the details of an express route peering.

az network express-route peering show [--circuit-name]
                                      [--ids]
                                      [--name]
                                      [--query-examples]
                                      [--resource-group]
                                      [--subscription]

Examples

Get private peering details of an ExpressRoute circuit.

az network express-route peering show -g MyResourceGroup --circuit-name MyCircuit -n AzurePrivatePeering

Optional Parameters

--circuit-name

ExpressRoute circuit name.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The name of the peering.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az network express-route peering update

Update peering settings of an ExpressRoute circuit.

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

Examples

Add IPv6 Microsoft Peering settings to existing IPv4 config.

az network express-route peering update -g MyResourceGroup --circuit-name MyCircuit \
    --ip-version ipv6 --primary-peer-subnet 2002:db00::/126 \
    --secondary-peer-subnet 2003:db00::/126 --advertised-public-prefixes 2002:db00::/126

Update peering settings of an ExpressRoute circuit. (autogenerated)

az network express-route peering update --circuit-name MyCircuit --name MyPeering --peer-asn 10002 --primary-peer-subnet 2002:db00::/126 --resource-group MyResourceGroup --secondary-peer-subnet 2003:db00::/126 --shared-key Abc123 --vlan-id 103

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.

--circuit-name

ExpressRoute circuit name.

--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.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--ip-version

The IP version to update Microsoft Peering settings for.

accepted values: IPv4, IPv6
default value: IPv4
--legacy-mode

Integer representing the legacy mode of the peering.

--name -n

The name of the peering.

--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.

--resource-group -g

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

--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.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--vlan-id

Identifier used to identify the customer.