az network vhub connection

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Note

This reference is part of the virtual-wan extension for the Azure CLI (version 2.0.67 or higher). The extension will automatically install the first time you run an az network vhub connection command. Learn more about extensions.

Manage virtual hub VNet connections.

Commands

az network vhub connection create	Create a virtual hub VNet connection.
az network vhub connection delete	Delete a virtual hub VNet connection.
az network vhub connection list	List virtual hub VNet connections.
az network vhub connection show	Get the details of a virtual hub VNet connection.
az network vhub connection update	Update settings of a virtual hub connection.
az network vhub connection wait	Place the CLI in a waiting state until a condition of virtual hub VNet connection is met.

az network vhub connection create

Create a virtual hub VNet connection.

az network vhub connection create --name
                                  --remote-vnet
                                  --resource-group
                                  --vhub-name
                                  [--address-prefixes]
                                  [--associated]
                                  [--internet-security {false, true}]
                                  [--labels]
                                  [--next-hop]
                                  [--no-wait]
                                  [--propagated]
                                  [--remote-vnet-transit {false, true}]
                                  [--route-name]
                                  [--use-hub-vnet-gateways {false, true}]

Examples

Create a virtual hub VNet connection without routing configuration.

az network vhub connection create -n MyConnection --vhub-name MyHub -g MyRG --remote-vnet MyVNet

Create a virtual hub VNet connection with routing configuration.

az network vhub connection create -n MyConnection --vhub-name MyHub -g MyRG --remote-vnet MyVNet --associated-route-table /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/RouteTable1 --propagated-route-tables /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/RouteTable1 /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/RouteTable2 --labels label1 label2 --route-name route1 --next-hop 70.0.0.2 --address-prefixes 10.80.0.0/16 10.90.0.0/16

Required Parameters

--name -n

Name of the connection.

--remote-vnet

Name of ID of the remote VNet to connect to.

--resource-group -g

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

--vhub-name

Name of the virtual hub.

Optional Parameters

--address-prefixes

Space-separated list of all address prefixes.

--associated --associated-route-table

The resource id of route table associated with this routing configuration.

--internet-security

Enable internet security and default is enabled.

accepted values: false, true

default value: 1

--labels

Space-separated list of labels for propagated route tables.

--next-hop

The ip address of the next hop.

--no-wait

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

--propagated --propagated-route-tables

Space-separated list of resource id of propagated route tables.

--remote-vnet-transit

Enable hub to remote VNet transit.

accepted values: false, true

--route-name

The name of the Static Route that is unique within a Vnet Route.

--use-hub-vnet-gateways

Allow remote VNet to use hub's VNet gateways.

accepted values: false, true

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

az network vhub connection delete

Delete a virtual hub VNet connection.

az network vhub connection delete --name
                                  --resource-group
                                  --vhub-name
                                  [--no-wait]
                                  [--yes]

Examples

Delete a virtual hub VNet connection.

az network vhub connection delete -n MyConnection --vhub-name MyHub -g MyRG

Required Parameters

--name -n

Name of the connection.

--resource-group -g

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

--vhub-name

Name of the virtual hub.

Optional Parameters

--no-wait

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

--yes -y

Do not prompt for confirmation.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

az network vhub connection list

List virtual hub VNet connections.

az network vhub connection list --resource-group
                                --vhub-name

Examples

List VNet connections in a given virtual hub.

az network vhub connection list --vhub-name MyHub -g MyRG

Required Parameters

--resource-group -g

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

--vhub-name

Name of the virtual hub.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

az network vhub connection show

Get the details of a virtual hub VNet connection.

az network vhub connection show --name
                                --resource-group
                                --vhub-name

Examples

Get the details of a virtual hub VNet connection.

az network vhub connection show -n MyConnection --vhub-name MyHub -g MyRG

Required Parameters

--name -n

Name of the connection.

--resource-group -g

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

--vhub-name

Name of the virtual hub.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

az network vhub connection update

Update settings of a virtual hub connection.

az network vhub connection update --name
                                  --resource-group
                                  --vhub-name
                                  [--add]
                                  [--associated]
                                  [--force-string]
                                  [--labels]
                                  [--no-wait]
                                  [--propagated]
                                  [--remove]
                                  [--set]

Examples

Add labels of a virtual hub connection.

az network vhub connection update -n MyConnection --vhub-name MyHub -g MyRG --labels Newlabel1 Newlabel2

Add labels for propagatedRouteTables of a virtual hub connection.

az network vhub connection update -n MyConnection --vhub-name MyHub -g MyRG --add routingConfiguration.propagatedRouteTables.labels Newlabel1 Newlabel2

Reset labels of a virtual hub connection.

az network vhub connection update -n MyConnection --vhub-name MyHub -g MyRG --set routingConfiguration.propagatedRouteTables.labels[0]=Newlabel

Required Parameters

--name -n

Name of the connection.

--resource-group -g

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

--vhub-name

Name of the virtual hub.

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

--associated --associated-route-table

The resource id of route table associated with this routing configuration.

--force-string

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

--labels

Space-separated list of labels for propagated route tables.

--no-wait

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

--propagated --propagated-route-tables

Space-separated list of resource id of propagated route tables.

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

az network vhub connection wait

Place the CLI in a waiting state until a condition of virtual hub VNet connection is met.

az network vhub connection wait --name
                                --resource-group
                                --vhub-name
                                [--created]
                                [--custom]
                                [--deleted]
                                [--exists]
                                [--interval]
                                [--timeout]
                                [--updated]

Required Parameters

--name -n

Name of the connection.

--resource-group -g

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

--vhub-name

Name of the virtual hub.

Optional Parameters

--created

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

--custom

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

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--interval

Polling interval in seconds.

default value: 30

--timeout

Maximum wait in seconds.

default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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