az network cross-connection peering

Note

This reference is part of the express-route-cross-connection extension for the Azure CLI (version 2.61.0 or higher). The extension will automatically install the first time you run an az network cross-connection peering command. Learn more about extensions.

Manage express route cross connection peering.

Commands

Name	Description	Type	Status
az network cross-connection peering create	Create peering settings for an express route 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 express route cross connection.	Extension	GA
az network cross-connection peering show	Show the details of an express route peering.	Extension	GA
az network cross-connection peering update	Update peering settings for an express route cross connection.	Extension	GA
az network cross-connection peering wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az network cross-connection peering create

Create peering settings for an express route 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]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--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

Express route cross-connection name.

--peer-asn

Autonomous system number of the customer/connectivity provider.

--peering-type

BGP peering type for the circuit.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--advertised-public-prefixes

Space-separated list of prefixes to be advertised through the BGP peering. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Microsoft Peering Arguments

--customer-asn

Autonomous system number of the customer.

Property	Value
Parameter group:	Microsoft Peering Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--routing-registry-name

Internet Routing Registry / Regional Internet Registry.

Property	Value
Parameter group:	Microsoft Peering Arguments
Accepted values:	AFRINIC, ALTDB, APNIC, ARIN, LACNIC, LEVEL3, RADB, RIPENCC

--shared-key

Key for generating an MD5 for the BGP session.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az network cross-connection peering delete

Delete peering settings.

az network cross-connection peering delete [--cross-connection-name]
                                           [--ids]
                                           [--name]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--resource-group]
                                           [--subscription]
                                           [--yes]

Examples

Delete private peering.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cross-connection-name

Express route cross-connection name.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The name of the peering.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az network cross-connection peering list

List peering settings of an express route cross connection.

az network cross-connection peering list --cross-connection-name
                                         --resource-group
                                         [--max-items]
                                         [--next-token]

Examples

List peering settings of an express route cross-connection.

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

Required Parameters

--cross-connection-name

Express route cross-connection name.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

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.

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az network cross-connection peering show

Show the details of an express route peering.

az network cross-connection peering show [--cross-connection-name]
                                         [--ids]
                                         [--name]
                                         [--resource-group]
                                         [--subscription]

Examples

Show private peering details of an express route cross-connection.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cross-connection-name

Express route cross-connection name.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The name of the peering.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az network cross-connection peering update

Update peering settings for an express route cross connection.

az network cross-connection peering update [--add]
                                           [--advertised-public-prefixes]
                                           [--cross-connection-name]
                                           [--customer-asn]
                                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--ids]
                                           [--ip-version {IPv4, IPv6}]
                                           [--name]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Generic Update Arguments

--advertised-public-prefixes

Space-separated list of prefixes to be advertised through the BGP peering. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Microsoft Peering Arguments

--cross-connection-name

Express route cross-connection name.

Property	Value
Parameter group:	Resource Id Arguments

--customer-asn

Autonomous system number of the customer.

Property	Value
Parameter group:	Microsoft Peering Arguments

--force-string

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

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--ids

Property	Value
Parameter group:	Resource Id Arguments

--ip-version

The IP version to update Microsoft Peering settings for.

Property	Value
Parameter group:	Microsoft Peering Arguments
Default value:	IPv4
Accepted values:	IPv4, IPv6

--name -n

The name of the peering.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--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 <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--routing-registry-name

Internet Routing Registry / Regional Internet Registry.

Property	Value
Parameter group:	Microsoft Peering Arguments
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=<value>.

Property	Value
Parameter group:	Generic Update Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--vlan-id

Identifier used to identify the customer.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az network cross-connection peering wait

Place the CLI in a waiting state until a condition is met.

az network cross-connection peering wait [--created]
                                         [--cross-connection-name]
                                         [--custom]
                                         [--deleted]
                                         [--exists]
                                         [--ids]
                                         [--interval]
                                         [--name]
                                         [--resource-group]
                                         [--subscription]
                                         [--timeout]
                                         [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--cross-connection-name

Express route cross-connection name.

Property	Value
Parameter group:	Resource Id Arguments

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--name -n

The name of the peering.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

Share via

az network cross-connection peering

Commands

az network cross-connection peering create

Examples

Required Parameters

Optional Parameters

az network cross-connection peering delete

Examples

Optional Parameters

az network cross-connection peering list

Examples

Required Parameters

Optional Parameters

az network cross-connection peering show

Examples

Optional Parameters

az network cross-connection peering update

Optional Parameters

az network cross-connection peering wait

Optional Parameters

Feedback