az network route-filter rule

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Manage rules in a route filter.

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 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 rule create

Create a rule in a route filter.

az network route-filter rule create --access {Allow, Deny}
                                    --communities
                                    --filter-name
                                    --name
                                    --resource-group
                                    [--location]

Examples

Create a rule in a route filter to allow Dynamics 365.

az network route-filter rule create -g MyResourceGroup --filter-name MyRouteFilter \
    -n MyRouteFilterRule --communities 12076:5040 --access Allow

Required Parameters

--access

The access type of the rule.

accepted values: Allow, Deny

--communities

Space-separated list of border gateway protocol (BGP) community values to filter on.

value from: az network route-filter rule list-service-communities

--filter-name

Name of the route filter.

--name -n

Name of the route filter rule.

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

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.

--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 rule delete

Delete a rule from a route filter.

az network route-filter rule delete [--filter-name]
                                    [--ids]
                                    [--name]
                                    [--resource-group]

Examples

Delete a rule from a route filter.

az network route-filter rule delete -g MyResourceGroup --filter-name MyRouteFilter -n MyRouteFilterRule

Optional Parameters

--filter-name

Name of the route filter.

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

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

--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 rule list

List rules in a route filter.

az network route-filter rule list --filter-name
                                  --resource-group

Examples

List rules in a route filter.

az network route-filter rule list -g MyResourceGroup --filter-name MyRouteFilter

Required Parameters

--filter-name

Name of the route filter.

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

--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 rule list-service-communities

Gets all the available BGP service communities.

az network route-filter rule list-service-communities

Examples

Gets all the available BGP service communities.

az network route-filter rule list-service-communities -o table

Get the community value for Exchange.

az network route-filter rule list-service-communities \
    --query '[].bgpCommunities[?communityName==`Exchange`].[communityValue][][]' -o tsv

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.

--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 rule show

Get the details of a rule in a route filter.

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

Examples

Get the details of a rule in a route filter.

az network route-filter rule show -g MyResourceGroup --filter-name MyRouteFilter -n MyRouteFilterRule

Optional Parameters

--filter-name

Name of the route filter.

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

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

--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 rule update

Update a rule in a route filter.

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

Examples

Update a rule in a route filter to add Exchange to rule list.

az network route-filter rule update -g MyResourceGroup --filter-name MyRouteFilter \
    -n MyRouteFilterRule --add communities='12076:5010'

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

--filter-name

Name of the route filter.

--force-string

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

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

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

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.

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