az network vhub route-map rule

  • Reference

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

Manage route map rule.

Commands

Name Description Type Status
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 rule add

Add route map rule.

az network vhub route-map rule add --resource-group
                                   --route-map-name
                                   --vhub-name
                                   [--actions]
                                   [--match-criteria]
                                   [--name]
                                   [--next-step {Continue, Terminate, Unknown}]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--rule-index]

Examples

Add rule to route map

az network vhub route-map rule add --name rule-name -g rg --route-map-name routemap-name --vhub-name vhub-name --match-criteria "[{matchCondition:Contains,routePrefix:[10.0.0.1/8]}]" --actions "[{type:Add,parameters:[{asPath:[22335]}]}]" --next-step Continue

Required Parameters

--resource-group -g

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

--route-map-name

The name of the RouteMap.

--vhub-name

The name of the VirtualHub containing the RouteMap.

Optional Parameters

--actions

List of actions which will be applied on a match. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--match-criteria

List of matching criterion which will be applied to traffic. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--name

The unique name for the rule.

--next-step

Next step after rule is evaluated. Current supported behaviors are 'Continue'(to next rule) and 'Terminate'.

accepted values: Continue, Terminate, Unknown
--no-wait

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

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

The index of the route map rule.

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.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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 route-map rule delete

Delete route map rule.

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

Examples

Delete rule

az network vhub route-map rule delete -g rg --route-map-name routemap-name --vhub-name vhub-name --rule-index 1

Required Parameters

--resource-group -g

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

--route-map-name

The name of the RouteMap.

--rule-index

The index of the route map rule.

--vhub-name

The name of the VirtualHub containing the RouteMap.

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.

default value: False
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.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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 route-map rule list

List route map rules.

az network vhub route-map rule list --resource-group
                                    --route-map-name
                                    --vhub-name

Examples

List route map rules

az network vhub route-map rule list -g rg --route-map-name routemap-name --vhub-name vhub-name

Required Parameters

--resource-group -g

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

--route-map-name

The name of the RouteMap.

--vhub-name

The name of the VirtualHub containing the RouteMap.

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.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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 route-map rule show

Show route map rule.

az network vhub route-map rule show --resource-group
                                    --route-map-name
                                    --rule-index
                                    --vhub-name

Examples

Show route map rule

az network vhub route-map rule show -g rg --route-map-name routemap-name --vhub-name vhub-name --rule-index 0

Required Parameters

--resource-group -g

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

--route-map-name

The name of the RouteMap.

--rule-index

The index of the route map rule.

--vhub-name

The name of the VirtualHub containing the RouteMap.

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.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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 route-map rule wait

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

az network vhub route-map rule wait [--created]
                                    [--custom]
                                    [--deleted]
                                    [--exists]
                                    [--ids]
                                    [--interval]
                                    [--resource-group]
                                    [--route-map-name]
                                    [--subscription]
                                    [--timeout]
                                    [--updated]
                                    [--vhub-name]

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

default value: False
--exists

Wait until the resource exists.

default value: False
--ids

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.

--interval

Polling interval in seconds.

default value: 30
--resource-group -g

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

--route-map-name

The name of the RouteMap.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

default value: False
--vhub-name

The name of the VirtualHub containing the RouteMap.

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.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.