az network vhub connection
Note
This reference is part of the virtual-wan extension for the Azure CLI (version 2.55.0 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
| Name | Description | Type | Status |
|---|---|---|---|
| az network vhub connection create |
Create a virtual hub VNet connection. |
Extension | GA |
| az network vhub connection delete |
Delete a virtual hub VNet connection. |
Extension | GA |
| az network vhub connection list |
List virtual hub VNet connections. |
Extension | GA |
| az network vhub connection show |
Get the details of a virtual hub VNet connection. |
Extension | GA |
| az network vhub connection update |
Update settings of a virtual hub connection. |
Extension | GA |
| az network vhub connection wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
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]
[--associated-inbound-routemap]
[--associated-outbound-routemap]
[--internet-security {0, 1, f, false, n, no, t, true, y, yes}]
[--labels]
[--next-hop]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--propagated]
[--remote-vnet-transit {0, 1, f, false, n, no, t, true, y, yes}]
[--route-name]
[--use-hub-vnet-gateways {0, 1, f, false, n, no, t, true, y, yes}]Examples
Create a virtual hub VNet connection without routing configuration.
az network vhub connection create -n MyConnection --vhub-name MyHub -g MyRG --remote-vnet MyVNetCreate 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/16Required Parameters
Name of the connection.
Name of ID of the remote VNet to connect to.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name of the virtual hub.
Optional Parameters
Space-separated list of all address prefixes. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Resource ID of route table associated with this routing configuration.
Resource URI of inbound routemap for this connection's routing configuration.
Resource URI of outbound routemap for this connection's routing configuration.
Enable internet security and default is enabled.
Space-separated list of labels for propagated route tables. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
IP address of the next hop.
Do not wait for the long-running operation to finish.
Space-separated list of resource ID of propagated route tables. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Deprecated: Enable hub to remote VNet transit.
Name of the static route that is unique within a VNet route.
Deprecated: Allow remote VNet to use hub's VNet gateways.
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 vhub connection delete
Delete a virtual hub VNet connection.
az network vhub connection delete [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--vhub-name]
[--yes]Examples
Delete a virtual hub VNet connection.
az network vhub connection delete -n MyConnection --vhub-name MyHub -g MyRGOptional Parameters
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.
Name of the connection.
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.
Name of the virtual hub.
Do not prompt for confirmation.
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 vhub connection list
List virtual hub VNet connections.
az network vhub connection list --resource-group
--vhub-name
[--max-items]
[--next-token]Examples
List VNet connections in a given virtual hub.
az network vhub connection list --vhub-name MyHub -g MyRGRequired Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name of the virtual hub.
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 vhub connection show
Get the details of a virtual hub VNet connection.
az network vhub connection show [--ids]
[--name]
[--resource-group]
[--subscription]
[--vhub-name]Examples
Get the details of a virtual hub VNet connection.
az network vhub connection show -n MyConnection --vhub-name MyHub -g MyRGOptional Parameters
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.
Name of the connection.
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.
Name of the virtual hub.
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 vhub connection update
Update settings of a virtual hub connection.
az network vhub connection update [--add]
[--associated]
[--associated-inbound-routemap]
[--associated-outbound-routemap]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--labels]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--propagated]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--vhub-name]Examples
Add labels for propagated route tables under routing configuration.
az network vhub connection update -n MyConnection --vhub-name MyHub -g MyRG --labels Newlabel1 Newlabel2Optional 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>.
Resource ID of route table associated with this routing configuration.
Resource URI of inbound routemap for this connection's routing configuration.
Resource URI of outbound routemap for this connection's routing configuration.
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.
Space-separated list of labels for propagated route tables. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name of the connection.
Do not wait for the long-running operation to finish.
Space-separated list of resource ID of propagated route tables. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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>.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Name of the virtual hub.
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 vhub connection wait
Place the CLI in a waiting state until a condition is met.
az network vhub connection wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
[--vhub-name]Optional Parameters
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.
Name of the connection.
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'.
Name of the virtual hub.
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