az network front-door rules-engine rule action

Manage Rules Engine actions for Front Door.

Commands

az network front-door rules-engine rule action add

Add an action to a Rules Engine rule.

az network front-door rules-engine rule action list

Show all actions that apply for a Rules Engine rule.

az network front-door rules-engine rule action remove

Remove an action from a Rules Engine rule.

az network front-door rules-engine rule action add

Add an action to a Rules Engine rule.

az network front-door rules-engine rule action add --action-type {ForwardRouteOverride, RedirectRouteOverride, RequestHeader, ResponseHeader}
                                                   --front-door-name
                                                   --name
                                                   --resource-group
                                                   --rules-engine-name
                                                   [--backend-pool]
                                                   [--cache-duration]
                                                   [--caching {Disabled, Enabled}]
                                                   [--custom-forwarding-path]
                                                   [--custom-fragment]
                                                   [--custom-host]
                                                   [--custom-path]
                                                   [--custom-query-string]
                                                   [--dynamic-compression {Disabled, Enabled}]
                                                   [--forwarding-protocol {HttpOnly, HttpsOnly, MatchRequest}]
                                                   [--header-action {Append, Delete, Overwrite}]
                                                   [--header-name]
                                                   [--header-value]
                                                   [--query-parameter-strip-directive {StripAll, StripAllExcept, StripNone, StripOnly}]
                                                   [--query-parameters]
                                                   [--redirect-protocol {HttpOnly, HttpsOnly, MatchRequest}]
                                                   [--redirect-type {Found, Moved, PermanentRedirect, TemporaryRedirect}]

Required Parameters

--action-type

Action type to apply for a rule.

accepted values: ForwardRouteOverride, RedirectRouteOverride, RequestHeader, ResponseHeader
--front-door-name -f

Name of the Front Door.

--name -n

Name of the rule.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--rules-engine-name -r

Name of the Rules Engine.

Optional Parameters

--backend-pool

Name or ID of a backend pool.

--cache-duration

The duration for which the content needs to be cached. Allowed format is ISO 8601 duration.

--caching

Whether to enable caching for this route.

accepted values: Disabled, Enabled
--custom-forwarding-path

Custom path used to rewrite resource paths matched by this rule. Leave empty to use incoming path.

--custom-fragment

Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #.

--custom-host

Host to redirect. Leave empty to use use the incoming host as the destination host.

--custom-path

The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.

--custom-query-string

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 = format. The first ? and & will be added automatically so do not include them in the front, but do separate multiple query strings with &.

--dynamic-compression

Use dynamic compression for cached content.

accepted values: Disabled, Enabled
--forwarding-protocol

Protocol to use for forwarding traffic.

accepted values: HttpOnly, HttpsOnly, MatchRequest
--header-action

Header action type for the requests.

accepted values: Append, Delete, Overwrite
--header-name

Name of the header to modify.

--header-value

Value of the header.

--query-parameter-strip-directive

Treatment of URL query terms when forming the cache key.

accepted values: StripAll, StripAllExcept, StripNone, StripOnly
--query-parameters

Query parameters to include or exclude (comma separated) when using query-parameter-strip-directive type StripAllExcept or StripOnly respectively.

--redirect-protocol

The protocol of the destination to where the traffic is redirected.

accepted values: HttpOnly, HttpsOnly, MatchRequest
default value: MatchRequest
--redirect-type

The redirect type the rule will use when redirecting traffic.

accepted values: Found, Moved, PermanentRedirect, TemporaryRedirect
default value: Moved

az network front-door rules-engine rule action list

Show all actions that apply for a Rules Engine rule.

az network front-door rules-engine rule action list --front-door-name
                                                    --name
                                                    --resource-group
                                                    --rules-engine-name

Required Parameters

--front-door-name -f

Name of the Front Door.

--name -n

Name of the rule.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--rules-engine-name -r

Name of the Rules Engine.

az network front-door rules-engine rule action remove

Remove an action from a Rules Engine rule.

az network front-door rules-engine rule action remove --action-type {ForwardRouteOverride, RedirectRouteOverride, RequestHeader, ResponseHeader}
                                                      --front-door-name
                                                      --name
                                                      --resource-group
                                                      --rules-engine-name
                                                      [--index]

Required Parameters

--action-type

Action type to apply for a rule.

accepted values: ForwardRouteOverride, RedirectRouteOverride, RequestHeader, ResponseHeader
--front-door-name -f

Name of the Front Door.

--name -n

Name of the rule.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--rules-engine-name -r

Name of the Rules Engine.

Optional Parameters

--index

0-based index of the request or response header action to remove. Index parameter is not required for "ForwardRouteOverride" or "RedirectRouteOverride" action remove.