az network route-filter

  • Preview
  • Reference

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage route filters.

Commands

Name Description Type Status
az network route-filter create

Create a route filter.

 Core Preview
az network route-filter delete

Delete a route filter.

 Core Preview
az network route-filter list

List route filters.

 Core Preview
az network route-filter rule

Manage rules in a route filter.

 Core Preview
az network route-filter rule create

Create a rule in a route filter.

 Core Preview
az network route-filter rule delete

Delete a rule from a route filter.

 Core Preview
az network route-filter rule list

List rules in a route filter.

 Core Preview
az network route-filter rule list-service-communities

Gets all the available BGP service communities.

 Core Preview
az network route-filter rule show

Get the details of a rule in a route filter.

 Core Preview
az network route-filter rule update

Update a rule in a route filter.

 Core Preview
az network route-filter rule wait

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

 Core Preview
az network route-filter show

Get the details of a route filter.

 Core Preview
az network route-filter update

Update a route filter.

 Core Preview
az network route-filter wait

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

 Core Preview

az network route-filter create

Edit
Preview

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

Create a route filter.

az network route-filter create --name
                               --resource-group
                               [--location]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--tags]

Examples

Create a route filter.

az network route-filter create -g MyResourceGroup -n MyRouteFilter

Create a route filter. (autogenerated)

az network route-filter create --location westus2 --name MyRouteFilter --resource-group MyResourceGroup

Required Parameters

--name -n

Name of the route filter.

--resource-group -g

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

Optional Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>. When not specified, the location of the resource group will be used.

--no-wait

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

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

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. Support shorthand-syntax, json-file and yaml-file. 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.

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 route-filter delete

Edit
Preview

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

Delete a route filter.

az network route-filter delete [--ids]
                               [--name]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--resource-group]
                               [--subscription]

Examples

Delete a route filter.

az network route-filter delete -g MyResourceGroup -n MyRouteFilter

Optional Parameters

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

--name -n

Name of the route filter.

--no-wait

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

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

--subscription

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

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 route-filter list

Edit
Preview

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

List route filters.

az network route-filter list [--resource-group]

Examples

List route filters in a resource group.

az network route-filter list -g MyResourceGroup

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.

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 route-filter show

Edit
Preview

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

Get the details of a route filter.

az network route-filter show [--expand]
                             [--ids]
                             [--name]
                             [--resource-group]
                             [--subscription]

Examples

Get the details of a route filter.

az network route-filter show -g MyResourceGroup -n MyRouteFilter

Get the details of a route filter. (autogenerated)

az network route-filter show --expand peerings --name MyRouteFilter --resource-group MyResourceGroup

Optional Parameters

--expand

Expands referenced express route bgp peering resources.

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

--name -n

Name of the route filter.

--resource-group -g

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

--subscription

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

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 route-filter update

Edit
Preview

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

Update a route filter.

az network route-filter update [--add]
                               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                               [--ids]
                               [--location]
                               [--name]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--remove]
                               [--resource-group]
                               [--set]
                               [--subscription]
                               [--tags]

Examples

Update the tags on a route filter.

az network route-filter update -g MyResourceGroup -n MyRouteFilter --set tags.CostCenter=MyBusinessGroup

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

--location -l

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

--name -n

Name of the route filter.

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

--resource-group -g

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

--set

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

--subscription

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. Support shorthand-syntax, json-file and yaml-file. 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.

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 route-filter wait

Edit
Preview

Command group 'az network route-filter' 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 route-filter wait [--created]
                             [--custom]
                             [--deleted]
                             [--exists]
                             [--expand]
                             [--ids]
                             [--interval]
                             [--name]
                             [--resource-group]
                             [--subscription]
                             [--timeout]
                             [--updated]

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

Expands referenced express route bgp peering resources.

--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
--name -n

Name of the route filter.

--resource-group -g

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

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