az network vhub
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 command. Learn more about extensions.
Manage virtual hubs.
Name | Description | Type | Status |
---|---|---|---|
az network vhub bgpconnection |
Manage virtual hub bgpconnections. |
Extension | GA |
az network vhub bgpconnection create |
Create a virtual hub bgpconnection. |
Extension | GA |
az network vhub bgpconnection delete |
Delete a virtual hub bgpconnection. |
Extension | GA |
az network vhub bgpconnection list |
List virtual hub bgpconnections. |
Extension | GA |
az network vhub bgpconnection show |
Get the details of a virtual hub bgpconnection. |
Extension | GA |
az network vhub bgpconnection update |
Update settings of a virtual hub bgpconnection. |
Extension | GA |
az network vhub bgpconnection wait |
Place the CLI in a waiting state until a condition of virtual hub bgpconnection is met. |
Extension | GA |
az network vhub connection |
Manage virtual hub VNet connections. |
Extension | GA |
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 create |
Create a virtual hub. |
Extension | GA |
az network vhub delete |
Delete a virtual hub. |
Extension | GA |
az network vhub get-effective-routes |
Get the effective routes configured for the Virtual Hub resource or the specified resource. |
Extension | GA |
az network vhub list |
List virtual hubs. |
Extension | GA |
az network vhub route |
Manage entries in the virtual hub route table. |
Extension | Deprecated |
az network vhub route-map |
Manage route map. |
Extension | GA |
az network vhub route-map create |
Create a route map. |
Extension | GA |
az network vhub route-map delete |
Delete a route map. |
Extension | GA |
az network vhub route-map get-inbound-routes |
Get the inbound routes configured for the Virtual Hub on a particular connection. |
Extension | GA |
az network vhub route-map get-outbound-routes |
Get the outbound routes configured for the Virtual Hub on a particular connection. |
Extension | GA |
az network vhub route-map list |
List routem maps by resource group. |
Extension | GA |
az network vhub route-map rule |
Manage route map rule. |
Extension | GA |
az network vhub route-map rule add |
Add route map rule. |
Extension | GA |
az network vhub route-map rule delete |
Delete route map rule. |
Extension | GA |
az network vhub route-map rule list |
List route map rules. |
Extension | GA |
az network vhub route-map rule show |
Show route map rule. |
Extension | GA |
az network vhub route-map rule wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az network vhub route-map show |
Show the details of a route map. |
Extension | GA |
az network vhub route-map update |
Update a route map. |
Extension | GA |
az network vhub route-map wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az network vhub route-table |
Manage route table in the virtual hub. |
Extension | GA |
az network vhub route-table create |
Create a route table in the virtual hub. |
Extension | GA |
az network vhub route-table delete |
Delete a route table in the virtual hub. |
Extension | GA |
az network vhub route-table list |
List all route tables in the virtual hub. |
Extension | GA |
az network vhub route-table route |
Manage routes of route table in the virtual hub. |
Extension | GA |
az network vhub route-table route add |
Add a route into route table of the virtual hub. |
Extension | GA |
az network vhub route-table route list |
List routes in the virtual hub route table. |
Extension | GA |
az network vhub route-table route remove |
Remove a route from route table of the virtual hub. |
Extension | GA |
az network vhub route-table show |
Show a route table in the virtual hub. |
Extension | GA |
az network vhub route-table update |
Update a route table in the virtual hub. |
Extension | GA |
az network vhub route-table wait |
Place the CLI in a waiting state until a condition of the vhub route-table is met. |
Extension | GA |
az network vhub route add |
Add a route to the virtual hub route table. |
Extension | Deprecated |
az network vhub route list |
List routes in the virtual hub route table. |
Extension | Deprecated |
az network vhub route remove |
Remove a route from the virtual hub route table. |
Extension | Deprecated |
az network vhub route reset |
Reset virtual hub route when the route state is failed. |
Extension | Deprecated |
az network vhub routing-intent |
Manage routing intent in the virtual hub. |
Extension | Preview |
az network vhub routing-intent create |
Create a routing intent in the virtual hub. |
Extension | Preview |
az network vhub routing-intent delete |
Delete a routing intent in the virtual hub. |
Extension | Preview |
az network vhub routing-intent list |
Retrieve the details of all routing intent resources of the virtual hub. |
Extension | Preview |
az network vhub routing-intent show |
Retrieve the details of a routing intent. |
Extension | Preview |
az network vhub routing-intent update |
Update a routing intent in the virtual hub. |
Extension | Preview |
az network vhub routing-intent wait |
Place the CLI in a waiting state until a condition is met. |
Extension | Preview |
az network vhub show |
Get the details of a virtual hub. |
Extension | GA |
az network vhub update |
Update settings of a virtual hub. |
Extension | GA |
az network vhub wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
Create a virtual hub.
az network vhub create --name
--resource-group
[--address-prefix]
[--allow-b2b-traffic {0, 1, f, false, n, no, t, true, y, yes}]
[--asn]
[--auto-scale-config]
[--hub-routing-preference {ASPath, ExpressRoute, VpnGateway}]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--sku]
[--tags]
[--vwan]
Create a virtual hub.
az network vhub create -g MyRG -n MyVHub --vwan MyVWan --address-prefix 10.0.0.0/24 -l SouthCentralUS --sku Standard
Name of the virtual hub.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
CIDR address prefix for the virtual hub.
Flag to control branch-to-branch traffic for VirtualRouter hub.
VirtualRouter ASN.
The VirtualHub Router autoscale configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The hub routing preference gateway types.
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
. When not specified, the location of the resource group will be used.
Do not wait for the long-running operation to finish.
The sku of the VirtualHub. Allowed values: Basic, Standard.
Space-separated tags: key[=value] [key[=value] ...]. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name or ID of the virtual WAN.
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.
Delete a virtual hub.
az network vhub delete [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]
Delete a virtual hub.
az network vhub delete -n MyVHub -g MyRG
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 virtual hub.
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
.
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.
Get the effective routes configured for the Virtual Hub resource or the specified resource.
az network vhub get-effective-routes [--ids]
[--name]
[--no-wait]
[--resource-group]
[--resource-id]
[--resource-type]
[--subscription]
Get the effective routes configured for route table in the virtual hub.
az network vhub get-effective-routes --resource-type RouteTable --resource-id /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/MyRouteTable -g MyRG -n MyHub
Get the effective routes configured for P2S connection in the virtual hub.
az network vhub get-effective-routes --resource-type P2SConnection --resource-id /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/p2sVpnGateways/MyGateway/p2sConnectionConfigurations/MyConnection -g MyRG -n MyHub
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 virtual hub.
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>
.
The resource whose effective routes are being requested.
The type of the specified resource like RouteTable, ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection and P2SConnection.
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.
List virtual hubs.
az network vhub list [--resource-group]
List virtual hubs.
az network vhub list -g MyRG
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.
Get the details of a virtual hub.
az network vhub show [--ids]
[--name]
[--resource-group]
[--subscription]
Get the details of a virtual hub.
az network vhub show -n MyVHub -g MyRG
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 virtual hub.
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.
Update settings of a virtual hub.
az network vhub update [--add]
[--address-prefix]
[--allow-b2b-traffic {0, 1, f, false, n, no, t, true, y, yes}]
[--asn]
[--auto-scale-config]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--hub-routing-preference {ASPath, ExpressRoute, VpnGateway}]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--remove]
[--resource-group]
[--set]
[--sku]
[--subscription]
[--tags]
[--vwan]
Update settings of a virtual hub.
az network vhub update -g MyRG -n MyVHub --sku Basic --hub-routing-preference VpnGateway
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>
.
CIDR address prefix for the virtual hub.
Flag to control branch-to-branch traffic for VirtualRouter hub.
VirtualRouter ASN.
The VirtualHub Router autoscale configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
The hub routing preference gateway types.
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 virtual hub.
Do not wait for the long-running operation to finish.
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>
.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
The sku of the VirtualHub.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Space-separated tags: key[=value] [key[=value] ...]. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name or ID of the virtual WAN.
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.
Place the CLI in a waiting state until a condition is met.
az network vhub wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
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 virtual hub.
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'.
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.
Azure CLI feedback
Azure CLI is an open source project. Select a link to provide feedback: