az network vhub routing-intent
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 routing-intent command. Learn more about extensions.
This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Manage routing intent in the virtual hub.
Commands
Name | Description | Type | Status |
---|---|---|---|
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 routing-intent create
Command group 'az network vhub routing-intent' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
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 of the routing intent.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the virtual hub.
Optional Parameters
Do not wait for the long-running operation to finish.
List of routing policies. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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 routing-intent delete
Command group 'az network vhub routing-intent' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Delete a routing intent in the virtual hub.
az network vhub routing-intent delete [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--vhub]
[--yes]
Examples
Delete a routing intent in the virtual hub.
az network vhub routing-intent delete -n MyRoutingIntent -g MyResourceGroup --vhub MyVirtualHub --yes
Optional 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 routing intent.
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 routing-intent list
Command group 'az network vhub routing-intent' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
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
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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 routing-intent show
Command group 'az network vhub routing-intent' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Retrieve the details of a routing intent.
az network vhub routing-intent show [--ids]
[--name]
[--resource-group]
[--subscription]
[--vhub]
Examples
Retrieve the details of a routing intent.
az network vhub routing-intent show -n MyRoutingIntent -g MyResourceGroup --vhub MyVirtualHub
Optional 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 routing intent.
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 routing-intent update
Command group 'az network vhub routing-intent' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Update a routing intent in the virtual hub.
az network vhub routing-intent update [--add]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--remove]
[--resource-group]
[--routing-policies]
[--set]
[--subscription]
[--vhub]
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}]"
Optional 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>.
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.
Name of the routing intent.
Do not wait for the long-running operation to finish.
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>
.
List of routing policies. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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 routing-intent wait
Command group 'az network vhub routing-intent' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Place the CLI in a waiting state until a condition is met.
az network vhub routing-intent wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
[--vhub]
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 routing intent.
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.
Azure CLI