az network cross-connection peering
Note
This reference is part of the express-route-cross-connection extension for the Azure CLI (version 2.0.41 or higher). The extension will automatically install the first time you run an az network cross-connection peering command. Learn more about extensions.
Manage ExpressRoute peering of an ExpressRoute cross-connection.
Commands
Name | Description | Type | Status |
---|---|---|---|
az network cross-connection peering create |
Create peering settings for an ExpressRoute cross-connection. |
Extension | GA |
az network cross-connection peering delete |
Delete peering settings. |
Extension | GA |
az network cross-connection peering list |
List peering settings of an ExpressRoute cross-connection. |
Extension | GA |
az network cross-connection peering show |
Get the details of an express route peering. |
Extension | GA |
az network cross-connection peering update |
Update peering settings for an ExpressRoute cross-connection. |
Extension | GA |
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
ExpressRoute cross-connection name.
Autonomous system number of the customer/connectivity provider.
BGP peering type for the circuit.
/30 subnet used to configure IP addresses for primary interface.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
/30 subnet used to configure IP addresses for secondary interface.
Identifier used to identify the customer.
Optional Parameters
Space-separated list of prefixes to be advertised through the BGP peering.
Autonomous system number of the customer.
Internet Routing Registry / Regional Internet Registry.
Key for generating an MD5 for the BGP session.
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 cross-connection peering delete
Delete peering settings.
az network cross-connection peering delete [--cross-connection-name]
[--ids]
[--name]
[--resource-group]
[--subscription]
Examples
Delete private peering.
az network cross-connection peering delete -g MyResourceGroup --cross-connection-name MyCircuit -n AzurePrivatePeering
Optional Parameters
ExpressRoute cross-connection 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 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
ExpressRoute cross-connection name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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 cross-connection peering show
Get the details of an express route peering.
az network cross-connection peering show [--cross-connection-name]
[--ids]
[--name]
[--resource-group]
[--subscription]
Examples
Get private peering details of an ExpressRoute cross-connection.
az network cross-connection peering show -g MyResourceGroup --cross-connection-name MyCircuit -n AzurePrivatePeering
Optional Parameters
ExpressRoute cross-connection 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 cross-connection peering update
Update peering settings for an ExpressRoute cross-connection.
az network cross-connection peering update [--add]
[--advertised-public-prefixes]
[--cross-connection-name]
[--customer-asn]
[--force-string]
[--ids]
[--ip-version {IPv4, IPv6}]
[--name]
[--peer-asn]
[--primary-peer-subnet]
[--remove]
[--resource-group]
[--routing-registry-name {AFRINIC, ALTDB, APNIC, ARIN, LACNIC, LEVEL3, RADB, RIPENCC}]
[--secondary-peer-subnet]
[--set]
[--shared-key]
[--subscription]
[--vlan-id]
Optional 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.
ExpressRoute cross-connection 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.
The name of the peering.
Autonomous system number of the customer/connectivity provider.
/30 subnet used to configure IP addresses for primary interface.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Internet Routing Registry / Regional Internet Registry.
/30 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=<value>
.
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.