az network express-route peering
Manage ExpressRoute peering of an ExpressRoute circuit.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az network express-route peering connection |
Manage ExpressRoute circuit connections. |
Core | GA |
| az network express-route peering connection create |
Create connections between two ExpressRoute circuits. |
Core | GA |
| az network express-route peering connection delete |
Delete the specified Express Route Circuit Connection from the specified express route circuit. |
Core | GA |
| az network express-route peering connection ipv6-config |
Manage ExpressRoute circuit connection configs. |
Core | GA |
| az network express-route peering connection ipv6-config remove |
Remove connection config to ExpressRoute circuit connection. |
Core | GA |
| az network express-route peering connection ipv6-config set |
Set connection config to ExpressRoute circuit connection. |
Core | GA |
| az network express-route peering connection ipv6-config wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
| az network express-route peering connection list |
List all global reach connections associated with a private peering in an express route circuit. |
Core | GA |
| az network express-route peering connection show |
Get the specified Express Route Circuit Connection from the specified express route circuit. |
Core | GA |
| az network express-route peering connection wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
| az network express-route peering create |
Create peering settings for an ExpressRoute circuit. |
Core | GA |
| az network express-route peering delete |
Delete peering settings. |
Core | GA |
| az network express-route peering get-stats |
Get all traffic stats of an ExpressRoute peering. |
Core | Preview |
| az network express-route peering list |
List peering settings of an ExpressRoute circuit. |
Core | GA |
| az network express-route peering peer-connection |
Manage ExpressRoute circuit peer connections. |
Core | Preview |
| az network express-route peering peer-connection list |
Gets all global reach peer connections associated with a private peering in an express route circuit. |
Core | Preview |
| az network express-route peering peer-connection show |
Get the specified Peer Express Route Circuit Connection from the specified express route circuit. |
Core | Preview |
| az network express-route peering show |
Get the details of an express route peering. |
Core | GA |
| az network express-route peering update |
Update peering settings of an ExpressRoute circuit. |
Core | GA |
| az network express-route peering wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
az network express-route peering create
Create peering settings for an ExpressRoute circuit.
az network express-route peering create --circuit-name
--resource-group
[--advertised-public-prefixes]
[--customer-asn]
[--ip-version]
[--legacy-mode]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--peer-asn]
[--peering-type {AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering}]
[--primary-peer-subnet]
[--route-filter]
[--routing-registry-name {AFRINIC, ALTDB, APNIC, ARIN, LACNIC, LEVEL3, RADB, RIPENCC}]
[--secondary-peer-subnet]
[--shared-key]
[--vlan-id]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/30Create Microsoft Peering settings with IPv6 configuration.
az network express-route peering create -g MyResourceGroup --circuit-name MyCircuit --peering-type AzurePrivatePeering --peer-asn 10002 --vlan-id 103 --ip-version ipv6 --primary-peer-subnet 2002:db00::/126 --secondary-peer-subnet 2003:db00::/126Create peering settings for an ExpressRoute circuit. (autogenerated)
az network express-route peering create --circuit-name MyCircuit --peer-asn 10002 --peering-type AzurePublicPeering --primary-peer-subnet 101.0.0.0/30 --resource-group MyResourceGroup --secondary-peer-subnet 102.0.0.0/30 --shared-key Abc123 --vlan-id 103Required Parameters
ExpressRoute circuit name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Space-separated list of prefixes to be advertised through the BGP peering. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Autonomous system number of the customer.
The IP version to update Microsoft Peering settings for. Allowed values: IPv4, IPv6. Default: IPv4.
Integer representing the legacy mode of the peering.
Do not wait for the long-running operation to finish.
Autonomous system number of the customer/connectivity provider.
BGP peering type for the circuit. Allowed values: AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering.
/30(ipv4) or /126(ipv6) subnet used to configure IP addresses for primary interface.
Name or ID of a route filter to apply to the peering settings.
Internet Routing Registry / Regional Internet Registry. Allowed values: AFRINIC, ALTDB, APNIC, ARIN, LACNIC, LEVEL3, RADB, RIPENCC.
/30(ipv4) or /126(ipv6) subnet used to configure IP addresses for secondary interface.
Key for generating an MD5 for the BGP session.
Identifier used to identify the customer.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network express-route peering delete
Delete peering settings.
az network express-route peering delete [--circuit-name]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]Examples
Delete private peering.
az network express-route peering delete -g MyResourceGroup --circuit-name MyCircuit -n AzurePrivatePeeringOptional Parameters
ExpressRoute circuit name.
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.
The name of the peering.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network express-route peering get-stats
This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Get all traffic stats of an ExpressRoute peering.
az network express-route peering get-stats [--circuit-name]
[--ids]
[--name]
[--resource-group]
[--subscription]Examples
Get ExpressRoute Circuit Peering Traffic Stats
az network express-route peering get-stats --circuit-name MyCircuit --name MyPeering --resource-group MyResourceGroupOptional Parameters
ExpressRoute circuit name.
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.
The name of the peering.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network express-route peering list
List peering settings of an ExpressRoute circuit.
az network express-route peering list --circuit-name
--resource-group
[--max-items]
[--next-token]Examples
List peering settings of an ExpressRoute circuit.
az network express-route peering list -g MyResourceGroup --circuit-name MyCircuitRequired Parameters
ExpressRoute circuit name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network express-route peering show
Get the details of an express route peering.
az network express-route peering show [--circuit-name]
[--ids]
[--name]
[--resource-group]
[--subscription]Examples
Get private peering details of an ExpressRoute circuit.
az network express-route peering show -g MyResourceGroup --circuit-name MyCircuit -n AzurePrivatePeeringOptional Parameters
ExpressRoute circuit name.
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.
The name of the peering.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
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 {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--ip-version]
[--legacy-mode]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--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::/126Update 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 103Optional Parameters
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>.
Space-separated list of prefixes to be advertised through the BGP peering. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
ExpressRoute circuit name.
Autonomous system number of the customer.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
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.
The IP version to update Microsoft Peering settings for. Allowed values: IPv4, IPv6. Default: IPv4.
Integer representing the legacy mode of the peering.
The name of the peering.
Do not wait for the long-running operation to finish.
Autonomous system number of the customer/connectivity provider.
/30(ipv4) or /126(ipv6) subnet used to configure IP addresses for primary interface.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of a route filter to apply to the peering settings.
Internet Routing Registry / Regional Internet Registry. Allowed values: AFRINIC, ALTDB, APNIC, ARIN, LACNIC, LEVEL3, RADB, RIPENCC.
/30(ipv4) or /126(ipv6) subnet used to configure IP addresses for secondary interface.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Key for generating an MD5 for the BGP session.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Identifier used to identify the customer.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network express-route peering wait
Place the CLI in a waiting state until a condition is met.
az network express-route peering wait [--circuit-name]
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]Optional Parameters
ExpressRoute circuit name.
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
The name of the peering.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for