az network route-filter

Manage route filters.

To learn more about route filters with Microsoft peering with ExpressRoute, visit https://docs.microsoft.com/azure/expressroute/how-to-routefilter-cli.

Commands

az network route-filter create

Create a route filter.

az network route-filter delete

Delete a route filter.

az network route-filter list

List route filters.

az network route-filter rule

Manage rules in a route filter.

az network route-filter rule create

Create a rule in a route filter.

az network route-filter rule delete

Delete a rule from a route filter.

az network route-filter rule list

List rules in a route filter.

az network route-filter rule list-service-communities

Gets all the available BGP service communities.

az network route-filter rule show

Get the details of a rule in a route filter.

az network route-filter rule update

Update a rule in a route filter.

az network route-filter show

Get the details of a route filter.

az network route-filter update

Update a route filter.

az network route-filter create

Create a route filter.

az network route-filter create --name
                               --resource-group
                               [--location]
                               [--subscription]
                               [--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>.

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

az network route-filter delete

Delete a route filter.

az network route-filter delete --name
                               --resource-group
                               [--subscription]

Examples

Delete a route filter.

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

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

--subscription

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

az network route-filter list

List route filters.

az network route-filter list [--query-examples]
                             [--resource-group]
                             [--subscription]

Examples

List route filters in a resource group.

az network route-filter list -g MyResourceGroup

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

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

az network route-filter show

Get the details of a route filter.

az network route-filter show --name
                             --resource-group
                             [--expand {peerings}]
                             [--query-examples]
                             [--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

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

--expand

Expands referenced express route bgp peering resources.

accepted values: peerings
--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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

az network route-filter update

Update a route filter.

This command can only be used to update the tags for a route filter. Name and resource group are immutable and cannot be updated.

az network route-filter update --name
                               --resource-group
                               [--add]
                               [--force-string]
                               [--remove]
                               [--set]
                               [--subscription]

Examples

Update the tags on a route filter.

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

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

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

--remove

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

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