az network manager routing-config rule-collection

Note

This reference is part of the virtual-network-manager extension for the Azure CLI (version 2.61.0 or higher). The extension will automatically install the first time you run an az network manager routing-config rule-collection command. Learn more about extensions.

Command group 'az network manager routing-config' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage network-manager routing-config rule-collection.

Commands

Name	Description	Type	Status
az network manager routing-config rule-collection create	Create a routing rule collection.	Extension	Preview
az network manager routing-config rule-collection delete	Delete an routing rule collection.	Extension	Preview
az network manager routing-config rule-collection list	List all the rule collections in a routing configuration, in a paginated format.	Extension	Preview
az network manager routing-config rule-collection rule	Manage network-manager routing-config rule-collection rule.	Extension	Preview
az network manager routing-config rule-collection rule create	Create an routing rule.	Extension	Preview
az network manager routing-config rule-collection rule delete	Delete a routing rule.	Extension	Preview
az network manager routing-config rule-collection rule list	List all network manager routing configuration routing rules.	Extension	Preview
az network manager routing-config rule-collection rule show	Get a network manager routing configuration routing rule.	Extension	Preview
az network manager routing-config rule-collection rule update	Update an routing rule.	Extension	Preview
az network manager routing-config rule-collection rule wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview
az network manager routing-config rule-collection show	Get a network manager routing configuration rule collection.	Extension	Preview
az network manager routing-config rule-collection update	Update a routing rule collection.	Extension	Preview
az network manager routing-config rule-collection wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview

az network manager routing-config rule-collection create

Preview

Command group 'az network manager routing-config rule-collection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a routing rule collection.

az network manager routing-config rule-collection create --collection-name --name
                                                         --config-name
                                                         --manager-name
                                                         --resource-group
                                                         [--applies-to]
                                                         [--description]
                                                         [--disable-bgp-route {False, True}]

Examples

Create a routing rule collection.

az network manager routing-config rule-collection create --config-name TestNetworkManagerConfig --manager-name TestNetworkManager --name TestNetworkManagerCollection --resource-group "rg1" --local-route-setting NotSpecified --applies-to [{"network_group_id":{manager_id}}] --disable-bgp-route-propagation true

Required Parameters

--collection-name --name -n

The name of the network manager routing Configuration rule collection.

--config-name

The name of the network manager Routing Configuration.

--manager-name

The name of the network manager.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--applies-to

Groups for configuration Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--description

A description of the routing rule collection.

Property	Value
Parameter group:	Properties Arguments

--disable-bgp-route

Determines whether BGP route propagation is enabled. Defaults to true.

Property	Value
Parameter group:	Properties Arguments
Default value:	true
Accepted values:	False, True

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az network manager routing-config rule-collection delete

Preview

Command group 'az network manager routing-config rule-collection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete an routing rule collection.

az network manager routing-config rule-collection delete [--collection-name --name]
                                                         [--config-name]
                                                         [--force {0, 1, f, false, n, no, t, true, y, yes}]
                                                         [--ids]
                                                         [--manager-name]
                                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                         [--resource-group]
                                                         [--subscription]
                                                         [--yes]

Examples

Delete an routing rule collection.

az network manager routing-config rule-collection delete --config-name TestNetworkManagerConfig --manager-name TestNetworkManager --name TestNetworkManagerCollection --resource-group "rg1 -y

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--collection-name --name -n

The name of the network manager routing Configuration rule collection.

Property	Value
Parameter group:	Resource Id Arguments

--config-name

The name of the network manager Routing Configuration.

Property	Value
Parameter group:	Resource Id Arguments

--force

Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

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

Property	Value
Parameter group:	Resource Id Arguments

--manager-name

The name of the network manager.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az network manager routing-config rule-collection list

Preview

Command group 'az network manager routing-config rule-collection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all the rule collections in a routing configuration, in a paginated format.

az network manager routing-config rule-collection list --config-name
                                                       --manager-name
                                                       --resource-group
                                                       [--max-items]
                                                       [--next-token]
                                                       [--skip-token]
                                                       [--top]

Examples

List all the rule collections.

az network manager routing-config rule-collection list --config-name TestNetworkManagerConfig --manager-name TestNetworkManager --resource-group "rg1"

Required Parameters

--config-name

The name of the network manager Routing Configuration.

--manager-name

The name of the network manager.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination Arguments

--skip-token

SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.

--top

An optional query parameter which specifies the maximum number of records to be returned by the server.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az network manager routing-config rule-collection show

Preview

Command group 'az network manager routing-config rule-collection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a network manager routing configuration rule collection.

az network manager routing-config rule-collection show [--collection-name --name]
                                                       [--config-name]
                                                       [--ids]
                                                       [--manager-name]
                                                       [--resource-group]
                                                       [--subscription]

Examples

Get a network manager routing configuration rule collection.

az network manager routing-config rule-collection show --config-name TestNetworkManagerConfig --manager-name TestNetworkManager --name TestNetworkManagerCollection --resource-group "rg1

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--collection-name --name -n

The name of the network manager routing Configuration rule collection.

Property	Value
Parameter group:	Resource Id Arguments

--config-name

The name of the network manager Routing Configuration.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--manager-name

The name of the network manager.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az network manager routing-config rule-collection update

Preview

Command group 'az network manager routing-config rule-collection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a routing rule collection.

az network manager routing-config rule-collection update [--add]
                                                         [--applies-to]
                                                         [--collection-name --name]
                                                         [--config-name]
                                                         [--description]
                                                         [--disable-bgp-route {False, True}]
                                                         [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                         [--ids]
                                                         [--manager-name]
                                                         [--remove]
                                                         [--resource-group]
                                                         [--set]
                                                         [--subscription]

Examples

Update a routing rule collection.

az network manager routing-config rule-collection update --config-name TestNetworkManagerConfig --manager-name TestNetworkManager --name TestNetworkManagerCollection --resource-group "rg1" --description "test"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Generic Update Arguments

--applies-to

Groups for configuration Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--collection-name --name -n

The name of the network manager routing Configuration rule collection.

Property	Value
Parameter group:	Resource Id Arguments

--config-name

The name of the network manager Routing Configuration.

Property	Value
Parameter group:	Resource Id Arguments

--description

A description of the routing rule collection.

Property	Value
Parameter group:	Properties Arguments

--disable-bgp-route

Determines whether BGP route propagation is enabled. Defaults to true.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	False, True

--force-string

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

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

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

Property	Value
Parameter group:	Resource Id Arguments

--manager-name

The name of the network manager.

Property	Value
Parameter group:	Resource Id Arguments

--remove

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

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az network manager routing-config rule-collection wait

Preview

Command group 'az network manager routing-config rule-collection' 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 manager routing-config rule-collection wait [--collection-name --name]
                                                       [--config-name]
                                                       [--created]
                                                       [--custom]
                                                       [--deleted]
                                                       [--exists]
                                                       [--ids]
                                                       [--interval]
                                                       [--manager-name]
                                                       [--resource-group]
                                                       [--subscription]
                                                       [--timeout]
                                                       [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--collection-name --name -n

The name of the network manager routing Configuration rule collection.

Property	Value
Parameter group:	Resource Id Arguments

--config-name

The name of the network manager Routing Configuration.

Property	Value
Parameter group:	Resource Id Arguments

--created

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

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

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

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
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.

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--manager-name

The name of the network manager.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False