az network front-door rules-engine 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 rules-engine rule command. Learn more about extensions.
Manage Rules Engine rules.
Commands
Name | Description | Type | Status |
---|---|---|---|
az network front-door rules-engine rule action |
Manage Rules Engine actions for Front Door. |
Extension | GA |
az network front-door rules-engine rule action add |
Add an action to a Rules Engine rule. |
Extension | GA |
az network front-door rules-engine rule action list |
Show all actions that apply for a Rules Engine rule. |
Extension | GA |
az network front-door rules-engine rule action remove |
Remove an action from a Rules Engine rule. |
Extension | GA |
az network front-door rules-engine rule condition |
Manage Rules Engine match conditions for Front Door. |
Extension | GA |
az network front-door rules-engine rule condition add |
Add a match condition to a Rules Engine rule. |
Extension | GA |
az network front-door rules-engine rule condition list |
Show all match conditions associated with a Rules Engine rule. |
Extension | GA |
az network front-door rules-engine rule condition remove |
Remove a match condition from a Rules Engine rule. |
Extension | GA |
az network front-door rules-engine rule create |
Create a Rules Engine rule for a Front Door. |
Extension | GA |
az network front-door rules-engine rule delete |
Delete a Rules Engine rule. |
Extension | GA |
az network front-door rules-engine rule list |
List rules of a Rules Engine configuration. |
Extension | GA |
az network front-door rules-engine rule show |
Get the details of a Rules Engine rule. |
Extension | GA |
az network front-door rules-engine rule update |
Update Rules Engine configuration of a rule. |
Extension | GA |
az network front-door rules-engine rule create
Create a Rules Engine rule for a Front Door.
This command allows creating Rules Engine configuration with Header action type. To add additional actions like Route overrides, use the az network front-door rules-engine rule action add
command.
az network front-door rules-engine rule create --action-type {RequestHeader, ResponseHeader}
--front-door-name
--name
--priority
--resource-group
--rules-engine-name
[--header-action {Append, Delete, Overwrite}]
[--header-name]
[--header-value]
[--match-processing-behavior {Continue, Stop}]
[--match-values]
[--match-variable {IsMobile, PostArgs, QueryString, RemoteAddr, RequestBody, RequestFilename, RequestFilenameExtension, RequestHeader, RequestMethod, RequestPath, RequestScheme, RequestUri}]
[--negate-condition {false, true}]
[--operator {Any, BeginsWith, Contains, EndsWith, Equal, GeoMatch, GreaterThan, GreaterThanOrEqual, IPMatch, LessThan, LessThanOrEqual}]
[--selector]
[--transforms {Lowercase, RemoveNulls, Trim, Uppercase, UrlDecode, UrlEncode}]
Required Parameters
Action type to apply for a rule.
Property | Value |
---|---|
Parameter group: | Action Arguments |
Accepted values: | RequestHeader, ResponseHeader |
Name of the Front Door.
Name of the rule.
The priority number must start from 0 and consecutive. Rule with greater priority value will be applied later.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the Rules Engine.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Header action type for the requests.
Property | Value |
---|---|
Parameter group: | Action Arguments |
Accepted values: | Append, Delete, Overwrite |
Name of the header to modify.
Property | Value |
---|---|
Parameter group: | Action Arguments |
Value of the header.
Property | Value |
---|---|
Parameter group: | Action Arguments |
Whether to stop processing rules after conditions in a rule is satisfied.
Property | Value |
---|---|
Accepted values: | Continue, Stop |
Space-separated list of values to match against.
Property | Value |
---|---|
Parameter group: | Match Condition Arguments |
Name of the match condition.
Property | Value |
---|---|
Parameter group: | Match Condition Arguments |
Accepted values: | IsMobile, PostArgs, QueryString, RemoteAddr, RequestBody, RequestFilename, RequestFilenameExtension, RequestHeader, RequestMethod, RequestPath, RequestScheme, RequestUri |
Applies "Not" to the operator.
Property | Value |
---|---|
Parameter group: | Match Condition Arguments |
Accepted values: | false, true |
Operator of the match condition.
Property | Value |
---|---|
Parameter group: | Match Condition Arguments |
Accepted values: | Any, BeginsWith, Contains, EndsWith, Equal, GeoMatch, GreaterThan, GreaterThanOrEqual, IPMatch, LessThan, LessThanOrEqual |
Optional selector for the match condition variable.
Property | Value |
---|---|
Parameter group: | Match Condition Arguments |
Space-separated list of transforms to apply.
Property | Value |
---|---|
Parameter group: | Match Condition Arguments |
Accepted values: | Lowercase, RemoveNulls, Trim, Uppercase, UrlDecode, UrlEncode |
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 rules-engine rule delete
Delete a Rules Engine rule.
az network front-door rules-engine rule delete --front-door-name
--name
--resource-group
--rules-engine-name
Required Parameters
Name of the Front Door.
Name of the rule.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the Rules Engine.
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 rules-engine rule list
List rules of a Rules Engine configuration.
az network front-door rules-engine rule list --front-door-name
--name
--resource-group
Required Parameters
Name of the Front Door.
Name of the Rules Engine.
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 rules-engine rule show
Get the details of a Rules Engine rule.
az network front-door rules-engine rule show --front-door-name
--name
--resource-group
--rules-engine-name
Required Parameters
Name of the Front Door.
Name of the rule.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the Rules Engine.
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 rules-engine rule update
Update Rules Engine configuration of a rule.
az network front-door rules-engine rule update --front-door-name
--name
--resource-group
--rules-engine-name
[--match-processing-behavior {Continue, Stop}]
[--priority]
Required Parameters
Name of the Front Door.
Name of the rule.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the Rules Engine.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Whether to stop processing rules after conditions in a rule is satisfied.
Property | Value |
---|---|
Accepted values: | Continue, Stop |
The priority number must start from 0 and consecutive. Rule with greater priority value will be applied later.
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 |