az network vhub routing-intent

Note

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

Manage routing intent in the virtual hub.

Commands

az network vhub routing-intent create	Create a routing intent in the virtual hub.
az network vhub routing-intent delete	Delete a routing intent in the virtual hub.
az network vhub routing-intent list	Retrieve the details of all routing intent resources of the virtual hub.
az network vhub routing-intent show	Retrieve the details of a routing intent.
az network vhub routing-intent update	Update a routing intent in the virtual hub.
az network vhub routing-intent wait	Place the CLI in a waiting state until a condition is met.

az network vhub routing-intent create

Create a routing intent in the virtual hub.

az network vhub routing-intent create --name
                                      --resource-group
                                      --vhub
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--routing-policies]

Examples

Create a routing intent with two routing policies.

az network vhub routing-intent create -n MyRoutingIntent -g MyResourceGroup --vhub MyVirtualHub --routing-policies "[{name:InternetTraffic,destinations:[Internet],next-hop:MyFirewallId},{name:PrivateTrafficPolicy,destinations:[PrivateTraffic],next-hop:MyFirewallId}]"

Required Parameters

--name --routing-intent-name -n

Name of the routing intent.

--resource-group -g

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

--vhub

Name of the virtual hub.

Optional Parameters

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes

--routing-policies

List of routing policies. Shorthand syntax supported. Try ?? to show more.

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 routing-intent delete

Delete a routing intent in the virtual hub.

az network vhub routing-intent delete --name
                                      --resource-group
                                      --vhub
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--yes]

Examples

Delete a routing intent in the virtual hub.

az network vhub routing-intent delete -n MyRoutingIntent -g MyResourceGroup --vhub MyVirtualHub --yes

Required Parameters

--name --routing-intent-name -n

Name of the routing intent.

--resource-group -g

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

--vhub

Name of the virtual hub.

Optional Parameters

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes

--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 routing-intent list

Retrieve the details of all routing intent resources of the virtual hub.

az network vhub routing-intent list --resource-group
                                    --vhub

Examples

Retrieve the details of all routing intent resources of the virtual hub.

az network vhub routing-intent list -g MyResourceGroup --vhub MyVirtualHub

Required Parameters

--resource-group -g

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

--vhub

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 routing-intent show

Retrieve the details of a routing intent.

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

Examples

Retrieve the details of a routing intent.

az network vhub routing-intent show -n MyRoutingIntent -g MyResourceGroup --vhub MyVirtualHub

Required Parameters

--name --routing-intent-name -n

Name of the routing intent.

--resource-group -g

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

--vhub

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 routing-intent update

Update a routing intent in the virtual hub.

az network vhub routing-intent update --name
                                      --resource-group
                                      --vhub
                                      [--add]
                                      [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--remove]
                                      [--routing-policies]
                                      [--set]

Examples

Update a routing intent in the virtual hub.

az network vhub routing-intent create -n MyRoutingIntent -g MyResourceGroup --vhub MyVirtualHub --routing-policies "[{name:InternetTraffic,destinations:[Internet],next-hop:MyFirewallId}]"

Required Parameters

--name --routing-intent-name -n

Name of the routing intent.

--resource-group -g

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

--vhub

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

--force-string

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes

--remove

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

--routing-policies

List of routing policies. Shorthand syntax supported. Try ?? to show more.

--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 routing-intent wait

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

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

Required Parameters

--name --routing-intent-name -n

Name of the routing intent.

--resource-group -g

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

--vhub

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.