az network route-filter rule
Command group 'az network route-filter' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Manage rules in a route filter.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| 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 rule create
Command group 'az network route-filter rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Create a rule in a route filter.
az network route-filter rule create --filter-name
--name
--resource-group
[--access {Allow, Deny}]
[--communities]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]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 AllowRequired Parameters
Name of the route filter.
Name of the route filter rule.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
The access type of the rule. Allowed values: Allow, Deny.
Space-separated list of border gateway protocol (BGP) community values to filter on. Values from: az network route-filter rule list-service-communities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.
Do not wait for the long-running operation to finish.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network route-filter rule delete
Command group 'az network route-filter rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Delete a rule from a route filter.
az network route-filter rule delete [--filter-name]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]Examples
Delete a rule from a route filter.
az network route-filter rule delete -g MyResourceGroup --filter-name MyRouteFilter -n MyRouteFilterRuleOptional Parameters
Name of the route filter.
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 of the route filter rule.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network route-filter rule list
Command group 'az network route-filter rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
List rules in a route filter.
az network route-filter rule list --filter-name
--resource-group
[--max-items]
[--next-token]Examples
List rules in a route filter.
az network route-filter rule list -g MyResourceGroup --filter-name MyRouteFilterRequired Parameters
Name of the route filter.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network route-filter rule list-service-communities
Command group 'az network route-filter rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Gets all the available BGP service communities.
az network route-filter rule list-service-communities [--max-items]
[--next-token]Examples
Gets all the available BGP service communities.
az network route-filter rule list-service-communities -o tableGet the community value for Exchange.
az network route-filter rule list-service-communities --query '[].bgpCommunities[?communityName==`Exchange`].[communityValue][][]' -o tsvOptional Parameters
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network route-filter rule show
Command group 'az network route-filter rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Get the details of a rule in a route filter.
az network route-filter rule show [--filter-name]
[--ids]
[--name]
[--resource-group]
[--subscription]Examples
Get the details of a rule in a route filter.
az network route-filter rule show -g MyResourceGroup --filter-name MyRouteFilter -n MyRouteFilterRuleOptional Parameters
Name of the route filter.
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 of the route filter rule.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network route-filter rule update
Command group 'az network route-filter rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Update a rule in a route filter.
az network route-filter rule update [--add]
[--filter-name]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--remove]
[--resource-group]
[--set]
[--subscription]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 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>.
Name of the route filter.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
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 of the route filter rule.
Do not wait for the long-running operation to finish.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network route-filter rule wait
Command group 'az network route-filter rule' 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 rule wait [--created]
[--custom]
[--deleted]
[--exists]
[--filter-name]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
Name of the route filter.
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.
Polling interval in seconds.
Name of the route filter rule.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for