Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

az network vnet peering

Manage peering connections between Azure Virtual Networks.

To learn more about virtual network peering visit https://learn.microsoft.com/en-us/azure/virtual-network/virtual-network-manage-peering.

Commands

Name Description Type Status
az network vnet peering create

Create a virtual network peering connection.

 Core GA
az network vnet peering delete

Delete a peering.

 Core GA
az network vnet peering list

List peerings.

 Core GA
az network vnet peering show

Show details of a peering.

 Core GA
az network vnet peering sync

Sync a virtual network peering connection.

 Core GA
az network vnet peering update

Update a peering in the specified virtual network.

 Core GA
az network vnet peering wait

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

 Core GA

az network vnet peering create

Create a virtual network peering connection.

To successfully peer two virtual networks this command must be called twice with the values for --vnet-name and --remote-vnet reversed.

az network vnet peering create --name
 --remote-vnet
 --resource-group
 --vnet-name
 [--acquire-policy-token]
 [--allow-forwarded-traffic {0, 1, f, false, n, no, t, true, y, yes}]
 [--allow-gateway-transit {0, 1, f, false, n, no, t, true, y, yes}]
 [--allow-vnet-access {0, 1, f, false, n, no, t, true, y, yes}]
 [--change-reference]
 [--enable-only-ipv6 {0, 1, f, false, n, no, t, true, y, yes}]
 [--local-subnet-names]
 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
 [--peer-complete-vnets {0, 1, f, false, n, no, t, true, y, yes}]
 [--remote-subnet-names]
 [--use-remote-gateways {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Create a peering connection between two virtual networks.

az network vnet peering create -g MyResourceGroup -n MyVnet1ToMyVnet2 --vnet-name MyVnet1 --remote-vnet MyVnet2Id --allow-vnet-access

Required Parameters

--name -n

The name of the VNet peering.

--remote-vnet

Name or ID of the remote VNet.

--resource-group -g

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

--vnet-name

The virtual network (VNet) 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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--allow-forwarded-traffic

Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.

Property Value
Default value: False
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--allow-gateway-transit

If gateway links can be used in remote virtual networking to link to this virtual network.

Property Value
Default value: False
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--allow-vnet-access

Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.

Property Value
Default value: False
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--enable-only-ipv6

Whether only Ipv6 address space is peered for subnet peering.

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

List of local subnet names that are subnet peered with remote virtual network. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

Whether complete virtual network address space is peered.

Property Value
Default value: True
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--remote-subnet-names

List of remote subnet names from remote virtual network that are subnet peered. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--use-remote-gateways

Allows VNet to use the remote VNet's gateway. Remote VNet gateway must have --allow-gateway-transit enabled for remote peering. Only 1 peering can have this flag enabled. Cannot be set if the VNet already has a gateway.

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

az network vnet peering delete

Delete a peering.

az network vnet peering delete [--acquire-policy-token]
 [--change-reference]
 [--ids]
 [--name]
 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
 [--resource-group]
 [--subscription]
 [--vnet-name]

Examples

Delete a virtual network peering connection.

az network vnet peering delete -g MyResourceGroup -n MyVnet1ToMyVnet2 --vnet-name MyVnet1

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy 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 VNet 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
--vnet-name

The virtual network (VNet) name.

Property Value
Parameter group: Resource Id Arguments

az network vnet peering list

List peerings.

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

Examples

List all peerings of a specified virtual network.

az network vnet peering list -g MyResourceGroup --vnet-name MyVnet1

Required Parameters

--resource-group -g

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

--vnet-name

The virtual network (VNet) 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

az network vnet peering show

Show details of a peering.

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

Examples

Show all details of the specified virtual network peering.

az network vnet peering show -g MyResourceGroup -n MyVnet1ToMyVnet2 --vnet-name MyVnet1

Optional Parameters

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

--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 VNet 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
--vnet-name

The virtual network (VNet) name.

Property Value
Parameter group: Resource Id Arguments

az network vnet peering sync

Sync a virtual network peering connection.

az network vnet peering sync [--acquire-policy-token]
 [--change-reference]
 [--ids]
 [--name]
 [--resource-group]
 [--subscription]
 [--vnet-name]

Examples

Sync a peering connection.

az network vnet peering sync -g MyResourceGroup -n MyVnet1ToMyVnet2 --vnet-name MyVnet1

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy 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 VNet 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
--vnet-name

The virtual network (VNet) name.

Property Value
Parameter group: Resource Id Arguments

az network vnet peering update

Update a peering in the specified virtual network.

az network vnet peering update [--acquire-policy-token]
 [--add]
 [--allow-forwarded-traffic {0, 1, f, false, n, no, t, true, y, yes}]
 [--allow-gateway-transit {0, 1, f, false, n, no, t, true, y, yes}]
 [--allow-vnet-access {0, 1, f, false, n, no, t, true, y, yes}]
 [--change-reference]
 [--enable-only-ipv6 {0, 1, f, false, n, no, t, true, y, yes}]
 [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
 [--ids]
 [--local-subnet-names]
 [--name]
 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
 [--peer-complete-vnets {0, 1, f, false, n, no, t, true, y, yes}]
 [--remote-subnet-names]
 [--remote-vnet]
 [--remove]
 [--resource-group]
 [--set]
 [--subscription]
 [--sync-remote {true}]
 [--use-remote-gateways {0, 1, f, false, n, no, t, true, y, yes}]
 [--vnet-name]

Examples

Change forwarded traffic configuration of a virtual network peering.

az network vnet peering update -g MyResourceGroup -n MyVnet1ToMyVnet2 --vnet-name MyVnet1 --set allowForwardedTraffic=true

Change virtual network access of a virtual network peering.

az network vnet peering update -g MyResourceGroup -n MyVnet1ToMyVnet2 --vnet-name MyVnet1 --set allowVirtualNetworkAccess=true

Change gateway transit property configuration of a virtual network peering.

az network vnet peering update -g MyResourceGroup -n MyVnet1ToMyVnet2 --vnet-name MyVnet1 --set allowGatewayTransit=true

Use remote gateways in virtual network peering.

az network vnet peering update -g MyResourceGroup -n MyVnet1ToMyVnet2 --vnet-name MyVnet1 --set useRemoteGateways=true

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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
--allow-forwarded-traffic

Allows forwarded traffic from the local VNet to the remote VNet.

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

Allows gateway link to be used in the remote VNet.

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

Allows access from the local VNet to the remote VNet.

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

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--enable-only-ipv6

Whether only Ipv6 address space is peered for subnet peering.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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

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
--local-subnet-names

List of local subnet names that are subnet peered with remote virtual network. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--name -n

The name of the VNet 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-complete-vnets

Whether complete virtual network address space is peered.

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

List of remote subnet names from remote virtual network that are subnet peered. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--remote-vnet

Name or ID of the remote VNet.

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

Parameter indicates the intention to sync the peering with the current address space on the remote vNet after it's updated.

Property Value
Accepted values: true
--use-remote-gateways

Allows VNet to use the remote VNet's gateway. Remote VNet gateway must have --allow-gateway-transit enabled for remote peering. Only 1 peering can have this flag enabled. Cannot be set if the VNet already has a gateway.

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

The virtual network (VNet) name.

Property Value
Parameter group: Resource Id Arguments

az network vnet peering wait

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

az network vnet peering wait [--acquire-policy-token]
 [--change-reference]
 [--created]
 [--custom]
 [--deleted]
 [--exists]
 [--ids]
 [--interval]
 [--name]
 [--resource-group]
 [--subscription]
 [--timeout]
 [--updated]
 [--vnet-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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--created

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

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--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

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

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--name -n

The name of the VNet 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
--vnet-name

The virtual network (VNet) name.

Property Value
Parameter group: Resource Id Arguments

Feedback

Was this page helpful?