az network vhub

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 command. Learn more about extensions.

Manage virtual hubs.

Commands

az network vhub bgpconnection	Manage virtual hub bgpconnections.
az network vhub bgpconnection create	Create a virtual hub bgpconnection.
az network vhub bgpconnection delete	Delete a virtual hub bgpconnection.
az network vhub bgpconnection list	List virtual hub bgpconnections.
az network vhub bgpconnection show	Get the details of a virtual hub bgpconnection.
az network vhub bgpconnection update	Update settings of a virtual hub bgpconnection.
az network vhub bgpconnection wait	Place the CLI in a waiting state until a condition of virtual hub bgpconnection is met.
az network vhub connection	Manage virtual hub VNet connections.
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 create	Create a virtual hub.
az network vhub delete	Delete a virtual hub.
az network vhub get-effective-routes	Get the effective routes configured for the Virtual Hub resource or the specified resource.
az network vhub list	List virtual hubs.
az network vhub route	Manage entries in the virtual hub route table.
az network vhub route add	Add a route to the virtual hub route table.
az network vhub route list	List routes in the virtual hub route table.
az network vhub route remove	Remove a route from the virtual hub route table.
az network vhub route reset	Reset virtual hub route when the route state is failed.
az network vhub route-table	Manage route table in the virtual hub.
az network vhub route-table create	Create a route table in the virtual hub.
az network vhub route-table delete	Delete a route table in the virtual hub.
az network vhub route-table list	List all route tables in the virtual hub.
az network vhub route-table route	Manage routes of route table in the virtual hub.
az network vhub route-table route add	Add a route into route table of the virtual hub.
az network vhub route-table route list	List routes in the virtual hub route table.
az network vhub route-table route remove	Remove a route from route table of the virtual hub.
az network vhub route-table show	Show a route table in the virtual hub.
az network vhub route-table update	Update a route table in the virtual hub.
az network vhub route-table wait	Place the CLI in a waiting state until a condition of the vhub route-table is met.
az network vhub show	Get the details of a virtual hub.
az network vhub update	Update settings of a virtual hub.

az network vhub create

Create a virtual hub.

az network vhub create --address-prefix
                       --name
                       --resource-group
                       --vwan
                       [--location]
                       [--no-wait]
                       [--sku {Basic, Standard}]
                       [--tags]

Required Parameters

--address-prefix

CIDR address prefix for the virtual hub.

--name -n

Name of the virtual hub.

--resource-group -g

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

--vwan

Name or ID of the virtual WAN.

Optional Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

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

--sku

The sku of the VirtualHub.

accepted values: Basic, Standard

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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 delete

Delete a virtual hub.

az network vhub delete --name
                       --resource-group

Required Parameters

--name -n

Name of the virtual hub.

--resource-group -g

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

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 get-effective-routes

Get the effective routes configured for the Virtual Hub resource or the specified resource.

az network vhub get-effective-routes --name
                                     --resource-group
                                     [--no-wait]
                                     [--resource-id]
                                     [--resource-type]

Examples

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

Required Parameters

--name -n

Name of the virtual hub.

--resource-group -g

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

Optional Parameters

--no-wait

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

--resource-id

The resource whose effective routes are being requested.

--resource-type

The type of the specified resource like RouteTable, ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection and P2SConnection.

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 list

List virtual hubs.

az network vhub list [--resource-group]

Optional Parameters

--resource-group -g

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

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 show

Get the details of a virtual hub.

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

Required Parameters

--name -n

Name of the virtual hub.

--resource-group -g

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

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 update

Update settings of a virtual hub.

az network vhub update --name
                       --resource-group
                       [--add]
                       [--address-prefix]
                       [--force-string]
                       [--no-wait]
                       [--remove]
                       [--set]
                       [--sku {Basic, Standard}]
                       [--tags]
                       [--vwan]

Required Parameters

--name -n

Name of the virtual hub.

--resource-group -g

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

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

--address-prefix

CIDR address prefix for the virtual hub.

--force-string

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

--no-wait

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

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

--sku

The sku of the VirtualHub.

accepted values: Basic, Standard

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--vwan

Name or ID of the virtual WAN.

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.