az network front-door routing-rule
Note
This reference is part of the front-door extension for the Azure CLI (version 2.67.0 or higher). The extension will automatically install the first time you run an az network front-door routing-rule command. Learn more about extensions.
Manage Front Door routing rules.
Commands
Name | Description | Type | Status |
---|---|---|---|
az network front-door routing-rule create |
Create a Front Door routing rule. |
Extension | GA |
az network front-door routing-rule delete |
Delete a Front Door routing rule. |
Extension | GA |
az network front-door routing-rule list |
List Front Door routing rules. |
Extension | GA |
az network front-door routing-rule show |
Get the details of a Front Door routing rule. |
Extension | GA |
az network front-door routing-rule update |
Update a Front Door routing rule. |
Extension | GA |
az network front-door routing-rule create
Create a Front Door routing rule.
Create a Front Door routing rule to either forward the requests to a backend or redirect the users to a different URL.
Example 1: az network front-door routing-rule create -f frontdoor1 -g rg1 --frontend-endpoints DefaultFrontendEndpoint --route-type Forward --backend-pool DefaultBackendPool -n forwardRoutingrule1 --patterns /forward1
Example 2: az network front-door routing-rule create -f frontdoor1 -g rg1 --frontend-endpoints DefaultFrontendEndpoint --route-type Redirect --custom-host redirecthost.com -n redirectRouteRule1 --patterns /redirect1 --custom-query-string querystring.
az network front-door routing-rule create --front-door-name
--frontend-endpoints
--name
--resource-group
--route-type {Forward, Redirect}
[--accepted-protocols]
[--backend-pool]
[--cache-duration]
[--caching {Disabled, Enabled}]
[--custom-forwarding-path]
[--custom-fragment]
[--custom-host]
[--custom-path]
[--custom-query-string]
[--disabled {false, true}]
[--dynamic-compression {Disabled, Enabled}]
[--forwarding-protocol {HttpOnly, HttpsOnly, MatchRequest}]
[--patterns]
[--query-parameter-strip-directive {StripAll, StripAllExcept, StripNone, StripOnly}]
[--query-parameters]
[--redirect-protocol {HttpOnly, HttpsOnly, MatchRequest}]
[--redirect-type {Found, Moved, PermanentRedirect, TemporaryRedirect}]
[--rules-engine]
Required Parameters
Name of the Front Door.
Space-separated list of frontend endpoint names or IDs.
Name of the routing rule.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Route type to define how Front Door should handle requests for this route i.e. forward them to a backend or redirect the users to a different URL.
Property | Value |
---|---|
Parameter group: | Routing Rule Arguments |
Accepted values: | Forward, Redirect |
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Space-separated list of protocols to accept. Default: Http.
Name or ID of a backend pool. It's required to create a Forward routing rule.
Property | Value |
---|---|
Parameter group: | Forward Routing Rule Arguments |
The duration for which the content needs to be cached. Allowed format is ISO 8601 duration.
Property | Value |
---|---|
Parameter group: | Forward Routing Rule Arguments |
Whether to enable caching for this route.
Property | Value |
---|---|
Parameter group: | Forward Routing Rule Arguments |
Accepted values: | Disabled, Enabled |
Custom path used to rewrite resource paths matched by this rule. Leave empty to use incoming path.
Property | Value |
---|---|
Parameter group: | Forward Routing Rule Arguments |
Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #.
Property | Value |
---|---|
Parameter group: | Redirect Routing Rule Arguments |
Host to redirect. Leave empty to use use the incoming host as the destination host.
Property | Value |
---|---|
Parameter group: | Redirect Routing Rule Arguments |
The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.
Property | Value |
---|---|
Parameter group: | Redirect Routing Rule Arguments |
The set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in <key>=<value>
format. The first ? and & will be added automatically so do not include them in the front, but do separate multiple query strings with &.
Property | Value |
---|---|
Parameter group: | Redirect Routing Rule Arguments |
Create in a disabled state.
Property | Value |
---|---|
Accepted values: | false, true |
Use dynamic compression for cached content.
Property | Value |
---|---|
Parameter group: | Forward Routing Rule Arguments |
Accepted values: | Disabled, Enabled |
Protocol to use for forwarding traffic.
Property | Value |
---|---|
Parameter group: | Forward Routing Rule Arguments |
Accepted values: | HttpOnly, HttpsOnly, MatchRequest |
Space-separated list of patterns to match. Default: '/*'.
Treatment of URL query terms when forming the cache key.
Property | Value |
---|---|
Parameter group: | Forward Routing Rule Arguments |
Accepted values: | StripAll, StripAllExcept, StripNone, StripOnly |
Query parameters to include or exclude (comma separated) when using query-parameter-strip-directive type StripAllExcept or StripOnly respectively.
Property | Value |
---|---|
Parameter group: | Forward Routing Rule Arguments |
The protocol of the destination to where the traffic is redirected.
Property | Value |
---|---|
Parameter group: | Redirect Routing Rule Arguments |
Default value: | MatchRequest |
Accepted values: | HttpOnly, HttpsOnly, MatchRequest |
The redirect type the rule will use when redirecting traffic.
Property | Value |
---|---|
Parameter group: | Redirect Routing Rule Arguments |
Default value: | Moved |
Accepted values: | Found, Moved, PermanentRedirect, TemporaryRedirect |
Name or ID of a Rules Engine configuration. To unlink property, "--remove rulesEngine".
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
az network front-door routing-rule delete
Delete a Front Door routing rule.
az network front-door routing-rule delete --front-door-name
--name
--resource-group
Required Parameters
Name of the Front Door.
Name of the routing rule.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
az network front-door routing-rule list
List Front Door routing rules.
az network front-door routing-rule list --front-door-name
--resource-group
Required Parameters
Name of the Front Door.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
az network front-door routing-rule show
Get the details of a Front Door routing rule.
az network front-door routing-rule show --front-door-name
--name
--resource-group
Required Parameters
Name of the Front Door.
Name of the routing rule.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
az network front-door routing-rule update
Update a Front Door routing rule.
az network front-door routing-rule update --front-door-name
--name
--resource-group
[--accepted-protocols]
[--add]
[--backend-pool]
[--cache-duration]
[--caching {Disabled, Enabled}]
[--custom-forwarding-path]
[--custom-fragment]
[--custom-host]
[--custom-path]
[--custom-query-string]
[--dynamic-compression {Disabled, Enabled}]
[--enabled {Disabled, Enabled}]
[--force-string]
[--forwarding-protocol {HttpOnly, HttpsOnly, MatchRequest}]
[--frontend-endpoints]
[--patterns]
[--query-parameter-strip-directive {StripAll, StripAllExcept, StripNone, StripOnly}]
[--query-parameters]
[--redirect-protocol {HttpOnly, HttpsOnly, MatchRequest}]
[--redirect-type {Found, Moved, PermanentRedirect, TemporaryRedirect}]
[--remove]
[--rules-engine]
[--set]
Required Parameters
Name of the Front Door.
Name of the routing rule.
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.
Space-separated list of protocols to accept. Default: Http.
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 |
Default value: | [] |
Name or ID of a backend pool. It's required to create a Forward routing rule.
Property | Value |
---|---|
Parameter group: | Forward Routing Rule Arguments |
The duration for which the content needs to be cached. Allowed format is ISO 8601 duration.
Property | Value |
---|---|
Parameter group: | Forward Routing Rule Arguments |
Whether to enable caching for this route.
Property | Value |
---|---|
Parameter group: | Forward Routing Rule Arguments |
Accepted values: | Disabled, Enabled |
Custom path used to rewrite resource paths matched by this rule. Leave empty to use incoming path.
Property | Value |
---|---|
Parameter group: | Forward Routing Rule Arguments |
Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #.
Property | Value |
---|---|
Parameter group: | Redirect Routing Rule Arguments |
Host to redirect. Leave empty to use use the incoming host as the destination host.
Property | Value |
---|---|
Parameter group: | Redirect Routing Rule Arguments |
The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.
Property | Value |
---|---|
Parameter group: | Redirect Routing Rule Arguments |
The set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in <key>=<value>
format. The first ? and & will be added automatically so do not include them in the front, but do separate multiple query strings with &.
Property | Value |
---|---|
Parameter group: | Redirect Routing Rule Arguments |
Use dynamic compression for cached content.
Property | Value |
---|---|
Parameter group: | Forward Routing Rule Arguments |
Accepted values: | Disabled, Enabled |
Enabled status.
Property | Value |
---|---|
Parameter group: | Probe Setting Arguments |
Accepted values: | Disabled, Enabled |
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Default value: | False |
Protocol to use for forwarding traffic.
Property | Value |
---|---|
Parameter group: | Forward Routing Rule Arguments |
Accepted values: | HttpOnly, HttpsOnly, MatchRequest |
Space-separated list of frontend endpoint names or IDs.
Space-separated list of patterns to match. Default: '/*'.
Treatment of URL query terms when forming the cache key.
Property | Value |
---|---|
Parameter group: | Forward Routing Rule Arguments |
Accepted values: | StripAll, StripAllExcept, StripNone, StripOnly |
Query parameters to include or exclude (comma separated) when using query-parameter-strip-directive type StripAllExcept or StripOnly respectively.
Property | Value |
---|---|
Parameter group: | Forward Routing Rule Arguments |
The protocol of the destination to where the traffic is redirected.
Property | Value |
---|---|
Parameter group: | Redirect Routing Rule Arguments |
Accepted values: | HttpOnly, HttpsOnly, MatchRequest |
The redirect type the rule will use when redirecting traffic.
Property | Value |
---|---|
Parameter group: | Redirect Routing Rule Arguments |
Accepted values: | Found, Moved, PermanentRedirect, TemporaryRedirect |
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Default value: | [] |
Name or ID of a Rules Engine configuration. To unlink property, "--remove rulesEngine".
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Default value: | [] |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |