az cdn endpoint rule action

Command group 'cdn endpoint rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage delivery rule actions for an endpoint.

Commands

Name	Description	Type	Status
az cdn endpoint rule action add	Add an action to a delivery rule.	Core	Preview
az cdn endpoint rule action remove	Remove an action from a delivery rule.	Core	Preview
az cdn endpoint rule action show	Show delivery rules asscociate with the endpoint.	Core	Preview

az cdn endpoint rule action add

Preview

Command group 'cdn endpoint rule action' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Add an action to a delivery rule.

az cdn endpoint rule action add --action-name {CacheExpiration, CacheKeyQueryString, ModifyRequestHeader, ModifyResponseHeader, OriginGroupOverride, UrlRedirect, UrlRewrite}
                                --rule-name
                                [--cache-behavior {BypassCache, Override, SetIfMissing}]
                                [--cache-duration]
                                [--custom-fragment]
                                [--custom-hostname]
                                [--custom-path]
                                [--custom-querystring]
                                [--destination]
                                [--header-action {Append, Delete, Overwrite}]
                                [--header-name]
                                [--header-value]
                                [--ids]
                                [--name]
                                [--origin-group]
                                [--preserve-unmatched-path {false, true}]
                                [--profile-name]
                                [--query-parameters]
                                [--query-string-behavior {Exclude, ExcludeAll, Include, IncludeAll}]
                                [--redirect-protocol {Http, Https, MatchRequest}]
                                [--redirect-type {Found, Moved, PermanentRedirect, TemporaryRedirect}]
                                [--resource-group]
                                [--source-pattern]
                                [--subscription]

Examples

Add a redirect action.

az cdn endpoint rule action add -g group -n endpoint --profile-name profile --rule-name name --action-name "UrlRedirect" --redirect-protocol HTTPS --redirect-type Moved

Add a cache expiration action

az cdn endpoint rule action add -g group -n endpoint --profile-name profile --rule-name name --action-name "CacheExpiration" --cache-behavior BypassCache

Required Parameters

--action-name

The name of the action for the delivery rule: https://learn.microsoft.com/en-us/azure/cdn/cdn-standard-rules-engine-actions.

Property	Value
Parameter group:	Action Arguments
Accepted values:	CacheExpiration, CacheKeyQueryString, ModifyRequestHeader, ModifyResponseHeader, OriginGroupOverride, UrlRedirect, UrlRewrite

--rule-name

Name of the rule.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cache-behavior

Caching behavior for the requests.

Property	Value
Parameter group:	Action Arguments
Accepted values:	BypassCache, Override, SetIfMissing

--cache-duration

The duration for which the content needs to be cached. Allowed format is hh:mm:ss.xxxxxx.

Property	Value
Parameter group:	Action Arguments

--custom-fragment

Fragment to add to the redirect URL.

Property	Value
Parameter group:	Action Arguments

--custom-hostname

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

Property	Value
Parameter group:	Action Arguments

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

Property	Value
Parameter group:	Action Arguments

--custom-querystring

The set of query strings to be placed in the redirect URL. leave empty to preserve the incoming query string.

Property	Value
Parameter group:	Action Arguments

--destination

The destination path to be used in the rewrite.

Property	Value
Parameter group:	Action Arguments

--header-action

Header action for the requests.

Property	Value
Parameter group:	Action Arguments
Accepted values:	Append, Delete, Overwrite

--header-name

Name of the header to modify.

Property	Value
Parameter group:	Action Arguments

--header-value

Value of the header.

Property	Value
Parameter group:	Action Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--name -n

Name of the CDN endpoint.

Property	Value
Parameter group:	Resource Id Arguments

--origin-group

Name or ID of the OriginGroup that would override the default OriginGroup.

Property	Value
Parameter group:	Action Arguments

--preserve-unmatched-path

If True, the remaining path after the source pattern will be appended to the new destination path.

Property	Value
Parameter group:	Action Arguments
Accepted values:	false, true

--profile-name

Name of the CDN profile which is unique within the resource group.

Property	Value
Parameter group:	Resource Id Arguments

--query-parameters

Query parameters to include or exclude (comma separated).

Property	Value
Parameter group:	Action Arguments

--query-string-behavior

Query string behavior for the requests.

Property	Value
Parameter group:	Action Arguments
Accepted values:	Exclude, ExcludeAll, Include, IncludeAll

--redirect-protocol

Protocol to use for the redirect.

Property	Value
Parameter group:	Action Arguments
Accepted values:	Http, Https, MatchRequest

--redirect-type

The redirect type the rule will use when redirecting traffic.

Property	Value
Parameter group:	Action Arguments
Accepted values:	Found, Moved, PermanentRedirect, TemporaryRedirect

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--source-pattern

A request URI pattern that identifies the type of requests that may be rewritten.

Property	Value
Parameter group:	Action Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az cdn endpoint rule action remove

Preview

Command group 'cdn endpoint rule action' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Remove an action from a delivery rule.

az cdn endpoint rule action remove --index
                                   --rule-name
                                   [--ids]
                                   [--name]
                                   [--profile-name]
                                   [--resource-group]
                                   [--subscription]

Examples

Remove the first action.

az cdn endpoint rule action remove -g group -n endpoint --profile-name profile --rule-name name --index 0

Required Parameters

--index

The index of the condition/action.

--rule-name

Name of the rule.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Resource Id Arguments

--name -n

Name of the CDN endpoint.

Property	Value
Parameter group:	Resource Id Arguments

--profile-name

Name of the CDN profile which is unique within the resource group.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az cdn endpoint rule action show

Preview

Command group 'cdn endpoint rule action' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show delivery rules asscociate with the endpoint.

az cdn endpoint rule action show [--ids]
                                 [--name]
                                 [--profile-name]
                                 [--resource-group]
                                 [--subscription]

Examples

show delivery rules asscociate with the endpoint.

az cdn endpoint rule action show -g group --profile-name profile-name -n endpoint

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Resource Id Arguments

--name -n

Name of the CDN endpoint.

Property	Value
Parameter group:	Resource Id Arguments

--profile-name

Name of the CDN profile which is unique within the resource group.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False