Microsoft.Cdn profiles/ruleSets/rules 2020-09-01

Article
01/30/2024

Bicep resource definition

The profiles/ruleSets/rules resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Cdn/profiles/ruleSets/rules resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Cdn/profiles/ruleSets/rules@2020-09-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    actions: [
      {
        name: 'string'
        // For remaining properties, see DeliveryRuleActionAutoGenerated objects
      }
    ]
    conditions: [
      {
        name: 'string'
        // For remaining properties, see DeliveryRuleCondition objects
      }
    ]
    matchProcessingBehavior: 'string'
    order: int
  }
}

DeliveryRuleActionAutoGenerated objects

Set the name property to specify the type of object.

For CacheExpiration, use:

  name: 'CacheExpiration'
  parameters: {
    '@odata.type': '#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters'
    cacheBehavior: 'string'
    cacheDuration: 'string'
    cacheType: 'All'
  }

For CacheKeyQueryString, use:

  name: 'CacheKeyQueryString'
  parameters: {
    '@odata.type': '#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheKeyQueryStringBehaviorActionParameters'
    queryParameters: 'string'
    queryStringBehavior: 'string'
  }

For ModifyRequestHeader, use:

  name: 'ModifyRequestHeader'
  parameters: {
    '@odata.type': '#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters'
    headerAction: 'string'
    headerName: 'string'
    value: 'string'
  }

For ModifyResponseHeader, use:

  name: 'ModifyResponseHeader'
  parameters: {
    '@odata.type': '#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters'
    headerAction: 'string'
    headerName: 'string'
    value: 'string'
  }

For OriginGroupOverride, use:

  name: 'OriginGroupOverride'
  parameters: {
    '@odata.type': '#Microsoft.Azure.Cdn.Models.DeliveryRuleOriginGroupOverrideActionParameters'
    originGroup: {
      id: 'string'
    }
  }

For UrlRedirect, use:

  name: 'UrlRedirect'
  parameters: {
    '@odata.type': '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRedirectActionParameters'
    customFragment: 'string'
    customHostname: 'string'
    customPath: 'string'
    customQueryString: 'string'
    destinationProtocol: 'string'
    redirectType: 'string'
  }

For UrlRewrite, use:

  name: 'UrlRewrite'
  parameters: {
    '@odata.type': '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRewriteActionParameters'
    destination: 'string'
    preserveUnmatchedPath: bool
    sourcePattern: 'string'
  }

For UrlSigning, use:

  name: 'UrlSigning'
  parameters: {
    '@odata.type': '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlSigningActionParameters'
    algorithm: 'SHA256'
    parameterNameOverride: [
      {
        paramIndicator: 'string'
        paramName: 'string'
      }
    ]
  }

DeliveryRuleCondition objects

Set the name property to specify the type of object.

For Cookies, use:

  name: 'Cookies'
  parameters: {
    '@odata.type': '#Microsoft.Azure.Cdn.Models.DeliveryRuleCookiesConditionParameters'
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    selector: 'string'
    transforms: [
      'string'
    ]
  }

For HttpVersion, use:

  name: 'HttpVersion'
  parameters: {
    '@odata.type': '#Microsoft.Azure.Cdn.Models.DeliveryRuleHttpVersionConditionParameters'
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'Equal'
  }

For IsDevice, use:

  name: 'IsDevice'
  parameters: {
    '@odata.type': '#Microsoft.Azure.Cdn.Models.DeliveryRuleIsDeviceConditionParameters'
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'Equal'
    transforms: [
      'string'
    ]
  }

For PostArgs, use:

  name: 'PostArgs'
  parameters: {
    '@odata.type': '#Microsoft.Azure.Cdn.Models.DeliveryRulePostArgsConditionParameters'
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    selector: 'string'
    transforms: [
      'string'
    ]
  }

For QueryString, use:

  name: 'QueryString'
  parameters: {
    '@odata.type': '#Microsoft.Azure.Cdn.Models.DeliveryRuleQueryStringConditionParameters'
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
  }

For RemoteAddress, use:

  name: 'RemoteAddress'
  parameters: {
    '@odata.type': '#Microsoft.Azure.Cdn.Models.DeliveryRuleRemoteAddressConditionParameters'
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
  }

For RequestBody, use:

  name: 'RequestBody'
  parameters: {
    '@odata.type': '#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestBodyConditionParameters'
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
  }

For RequestHeader, use:

  name: 'RequestHeader'
  parameters: {
    '@odata.type': '#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestHeaderConditionParameters'
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    selector: 'string'
    transforms: [
      'string'
    ]
  }

For RequestMethod, use:

  name: 'RequestMethod'
  parameters: {
    '@odata.type': '#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestMethodConditionParameters'
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'Equal'
  }

For RequestScheme, use:

  name: 'RequestScheme'
  parameters: {
    '@odata.type': '#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestSchemeConditionParameters'
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'Equal'
  }

For RequestUri, use:

  name: 'RequestUri'
  parameters: {
    '@odata.type': '#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestUriConditionParameters'
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
  }

For UrlFileExtension, use:

  name: 'UrlFileExtension'
  parameters: {
    '@odata.type': '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlFileExtensionMatchConditionParameters'
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
  }

For UrlFileName, use:

  name: 'UrlFileName'
  parameters: {
    '@odata.type': '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlFilenameConditionParameters'
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
  }

For UrlPath, use:

  name: 'UrlPath'
  parameters: {
    '@odata.type': '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlPathMatchConditionParameters'
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
  }

Property values

profiles/ruleSets/rules

Name	Description	Value
name	The resource name See how to set names and types for child resources in Bicep.	string (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: ruleSets
properties	The JSON object that contains the properties of the Rules to create.	RuleProperties

RuleProperties

Name	Description	Value
actions	A list of actions that are executed when all the conditions of a rule are satisfied.	DeliveryRuleActionAutoGenerated[]
conditions	A list of conditions that must be matched for the actions to be executed	DeliveryRuleCondition[]
matchProcessingBehavior	If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue.	'Continue' 'Stop'
order	The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied.	int

DeliveryRuleActionAutoGenerated

Name	Description	Value
name	Set the object type	CacheExpiration CacheKeyQueryString ModifyRequestHeader ModifyResponseHeader OriginGroupOverride UrlRedirect UrlRewrite UrlSigning (required)

DeliveryRuleCacheExpirationAction

Name	Description	Value
name	The name of the action for the delivery rule.	'CacheExpiration' (required)
parameters	Defines the parameters for the action.	CacheExpirationActionParameters (required)

CacheExpirationActionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters' (required)
cacheBehavior	Caching behavior for the requests	'BypassCache' 'Override' 'SetIfMissing' (required)
cacheDuration	The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss	string
cacheType	The level at which the content needs to be cached.	'All' (required)

DeliveryRuleCacheKeyQueryStringAction

Name	Description	Value
name	The name of the action for the delivery rule.	'CacheKeyQueryString' (required)
parameters	Defines the parameters for the action.	CacheKeyQueryStringActionParameters (required)

CacheKeyQueryStringActionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' (required)
queryParameters	query parameters to include or exclude (comma separated).	string
queryStringBehavior	Caching behavior for the requests	'Exclude' 'ExcludeAll' 'Include' 'IncludeAll' (required)

DeliveryRuleRequestHeaderAction

Name	Description	Value
name	The name of the action for the delivery rule.	'ModifyRequestHeader' (required)
parameters	Defines the parameters for the action.	HeaderActionParameters (required)

HeaderActionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters' (required)
headerAction	Action to perform	'Append' 'Delete' 'Overwrite' (required)
headerName	Name of the header to modify	string (required)
value	Value for the specified action	string

DeliveryRuleResponseHeaderAction

Name	Description	Value
name	The name of the action for the delivery rule.	'ModifyResponseHeader' (required)
parameters	Defines the parameters for the action.	HeaderActionParameters (required)

OriginGroupOverrideAction

Name	Description	Value
name	The name of the action for the delivery rule.	'OriginGroupOverride' (required)
parameters	Defines the parameters for the action.	OriginGroupOverrideActionParameters (required)

OriginGroupOverrideActionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleOriginGroupOverrideActionParameters' (required)
originGroup	defines the OriginGroup that would override the DefaultOriginGroup.	ResourceReference (required)

ResourceReference

Name	Description	Value
id	Resource ID.	string

UrlRedirectAction

Name	Description	Value
name	The name of the action for the delivery rule.	'UrlRedirect' (required)
parameters	Defines the parameters for the action.	UrlRedirectActionParameters (required)

UrlRedirectActionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRedirectActionParameters' (required)
customFragment	Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #.	string
customHostname	Host to redirect. Leave empty to use the incoming host as the destination host.	string
customPath	The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.	string
customQueryString	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. ? and & will be added automatically so do not include them.	string
destinationProtocol	Protocol to use for the redirect. The default value is MatchRequest	'Http' 'Https' 'MatchRequest'
redirectType	The redirect type the rule will use when redirecting traffic.	'Found' 'Moved' 'PermanentRedirect' 'TemporaryRedirect' (required)

UrlRewriteAction

Name	Description	Value
name	The name of the action for the delivery rule.	'UrlRewrite' (required)
parameters	Defines the parameters for the action.	UrlRewriteActionParameters (required)

UrlRewriteActionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRewriteActionParameters' (required)
destination	Define the relative URL to which the above requests will be rewritten by.	string (required)
preserveUnmatchedPath	Whether to preserve unmatched path. Default value is true.	bool
sourcePattern	define a request URI pattern that identifies the type of requests that may be rewritten. If value is blank, all strings are matched.	string (required)

UrlSigningAction

Name	Description	Value
name	The name of the action for the delivery rule.	'UrlSigning' (required)
parameters	Defines the parameters for the action.	UrlSigningActionParameters (required)

UrlSigningActionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlSigningActionParameters' (required)
algorithm	Algorithm to use for URL signing	'SHA256'
parameterNameOverride	Defines which query string parameters in the url to be considered for expires, key id etc.	UrlSigningParamIdentifier[]

UrlSigningParamIdentifier

Name	Description	Value
paramIndicator	Indicates the purpose of the parameter	'Expires' 'KeyId' 'Signature' (required)
paramName	Parameter name	string (required)

DeliveryRuleCondition

Name	Description	Value
name	Set the object type	Cookies HttpVersion IsDevice PostArgs QueryString RemoteAddress RequestBody RequestHeader RequestMethod RequestScheme RequestUri UrlFileExtension UrlFileName UrlPath (required)

DeliveryRuleCookiesCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	'Cookies' (required)
parameters	Defines the parameters for the condition.	CookiesMatchConditionParameters (required)

CookiesMatchConditionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleCookiesConditionParameters' (required)
matchValues	The match value for the condition of the delivery rule	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	'Any' 'BeginsWith' 'Contains' 'EndsWith' 'Equal' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' 'RegEx' (required)
selector	Name of Cookies to be matched	string
transforms	List of transforms	String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode'

DeliveryRuleHttpVersionCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	'HttpVersion' (required)
parameters	Defines the parameters for the condition.	HttpVersionMatchConditionParameters (required)

HttpVersionMatchConditionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleHttpVersionConditionParameters' (required)
matchValues	The match value for the condition of the delivery rule	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	'Equal' (required)

DeliveryRuleIsDeviceCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	'IsDevice' (required)
parameters	Defines the parameters for the condition.	IsDeviceMatchConditionParameters (required)

IsDeviceMatchConditionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleIsDeviceConditionParameters' (required)
matchValues	The match value for the condition of the delivery rule	String array containing any of: 'Desktop' 'Mobile'
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	'Equal' (required)
transforms	List of transforms	String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode'

DeliveryRulePostArgsCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	'PostArgs' (required)
parameters	Defines the parameters for the condition.	PostArgsMatchConditionParameters (required)

PostArgsMatchConditionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRulePostArgsConditionParameters' (required)
matchValues	The match value for the condition of the delivery rule	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	'Any' 'BeginsWith' 'Contains' 'EndsWith' 'Equal' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' 'RegEx' (required)
selector	Name of PostArg to be matched	string
transforms	List of transforms	String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode'

DeliveryRuleQueryStringCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	'QueryString' (required)
parameters	Defines the parameters for the condition.	QueryStringMatchConditionParameters (required)

QueryStringMatchConditionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleQueryStringConditionParameters' (required)
matchValues	The match value for the condition of the delivery rule	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	'Any' 'BeginsWith' 'Contains' 'EndsWith' 'Equal' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' 'RegEx' (required)
transforms	List of transforms	String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode'

DeliveryRuleRemoteAddressCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	'RemoteAddress' (required)
parameters	Defines the parameters for the condition.	RemoteAddressMatchConditionParameters (required)

RemoteAddressMatchConditionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleRemoteAddressConditionParameters' (required)
matchValues	Match values to match against. The operator will apply to each value in here with OR semantics. If any of them match the variable with the given operator this match condition is considered a match.	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	'Any' 'GeoMatch' 'IPMatch' (required)
transforms	List of transforms	String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode'

DeliveryRuleRequestBodyCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	'RequestBody' (required)
parameters	Defines the parameters for the condition.	RequestBodyMatchConditionParameters (required)

RequestBodyMatchConditionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestBodyConditionParameters' (required)
matchValues	The match value for the condition of the delivery rule	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	'Any' 'BeginsWith' 'Contains' 'EndsWith' 'Equal' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' 'RegEx' (required)
transforms	List of transforms	String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode'

DeliveryRuleRequestHeaderCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	'RequestHeader' (required)
parameters	Defines the parameters for the condition.	RequestHeaderMatchConditionParameters (required)

RequestHeaderMatchConditionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestHeaderConditionParameters' (required)
matchValues	The match value for the condition of the delivery rule	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	'Any' 'BeginsWith' 'Contains' 'EndsWith' 'Equal' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' 'RegEx' (required)
selector	Name of Header to be matched	string
transforms	List of transforms	String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode'

DeliveryRuleRequestMethodCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	'RequestMethod' (required)
parameters	Defines the parameters for the condition.	RequestMethodMatchConditionParameters (required)

RequestMethodMatchConditionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestMethodConditionParameters' (required)
matchValues	The match value for the condition of the delivery rule	String array containing any of: 'DELETE' 'GET' 'HEAD' 'OPTIONS' 'POST' 'PUT' 'TRACE'
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	'Equal' (required)

DeliveryRuleRequestSchemeCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	'RequestScheme' (required)
parameters	Defines the parameters for the condition.	RequestSchemeMatchConditionParameters (required)

RequestSchemeMatchConditionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestSchemeConditionParameters' (required)
matchValues	The match value for the condition of the delivery rule	String array containing any of: 'HTTP' 'HTTPS'
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	'Equal' (required)

DeliveryRuleRequestUriCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	'RequestUri' (required)
parameters	Defines the parameters for the condition.	RequestUriMatchConditionParameters (required)

RequestUriMatchConditionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestUriConditionParameters' (required)
matchValues	The match value for the condition of the delivery rule	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	'Any' 'BeginsWith' 'Contains' 'EndsWith' 'Equal' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' 'RegEx' (required)
transforms	List of transforms	String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode'

DeliveryRuleUrlFileExtensionCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	'UrlFileExtension' (required)
parameters	Defines the parameters for the condition.	UrlFileExtensionMatchConditionParameters (required)

UrlFileExtensionMatchConditionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlFileExtensionMatchConditionParameters' (required)
matchValues	The match value for the condition of the delivery rule	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	'Any' 'BeginsWith' 'Contains' 'EndsWith' 'Equal' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' 'RegEx' (required)
transforms	List of transforms	String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode'

DeliveryRuleUrlFileNameCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	'UrlFileName' (required)
parameters	Defines the parameters for the condition.	UrlFileNameMatchConditionParameters (required)

UrlFileNameMatchConditionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlFilenameConditionParameters' (required)
matchValues	The match value for the condition of the delivery rule	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	'Any' 'BeginsWith' 'Contains' 'EndsWith' 'Equal' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' 'RegEx' (required)
transforms	List of transforms	String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode'

DeliveryRuleUrlPathCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	'UrlPath' (required)
parameters	Defines the parameters for the condition.	UrlPathMatchConditionParameters (required)

UrlPathMatchConditionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlPathMatchConditionParameters' (required)
matchValues	The match value for the condition of the delivery rule	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	'Any' 'BeginsWith' 'Contains' 'EndsWith' 'Equal' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' 'RegEx' 'Wildcard' (required)
transforms	List of transforms	String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode'

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Front Door Standard/Premium with rule set	This template creates a Front Door Standard/Premium including a rule set.

ARM template resource definition

The profiles/ruleSets/rules resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Cdn/profiles/ruleSets/rules resource, add the following JSON to your template.

{
  "type": "Microsoft.Cdn/profiles/ruleSets/rules",
  "apiVersion": "2020-09-01",
  "name": "string",
  "properties": {
    "actions": [
      {
        "name": "string"
        // For remaining properties, see DeliveryRuleActionAutoGenerated objects
      }
    ],
    "conditions": [
      {
        "name": "string"
        // For remaining properties, see DeliveryRuleCondition objects
      }
    ],
    "matchProcessingBehavior": "string",
    "order": "int"
  }
}

DeliveryRuleActionAutoGenerated objects

Set the name property to specify the type of object.

For CacheExpiration, use:

  "name": "CacheExpiration",
  "parameters": {
    "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters",
    "cacheBehavior": "string",
    "cacheDuration": "string",
    "cacheType": "All"
  }

For CacheKeyQueryString, use:

  "name": "CacheKeyQueryString",
  "parameters": {
    "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheKeyQueryStringBehaviorActionParameters",
    "queryParameters": "string",
    "queryStringBehavior": "string"
  }

For ModifyRequestHeader, use:

  "name": "ModifyRequestHeader",
  "parameters": {
    "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters",
    "headerAction": "string",
    "headerName": "string",
    "value": "string"
  }

For ModifyResponseHeader, use:

  "name": "ModifyResponseHeader",
  "parameters": {
    "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters",
    "headerAction": "string",
    "headerName": "string",
    "value": "string"
  }

For OriginGroupOverride, use:

  "name": "OriginGroupOverride",
  "parameters": {
    "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleOriginGroupOverrideActionParameters",
    "originGroup": {
      "id": "string"
    }
  }

For UrlRedirect, use:

  "name": "UrlRedirect",
  "parameters": {
    "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRedirectActionParameters",
    "customFragment": "string",
    "customHostname": "string",
    "customPath": "string",
    "customQueryString": "string",
    "destinationProtocol": "string",
    "redirectType": "string"
  }

For UrlRewrite, use:

  "name": "UrlRewrite",
  "parameters": {
    "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRewriteActionParameters",
    "destination": "string",
    "preserveUnmatchedPath": "bool",
    "sourcePattern": "string"
  }

For UrlSigning, use:

  "name": "UrlSigning",
  "parameters": {
    "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlSigningActionParameters",
    "algorithm": "SHA256",
    "parameterNameOverride": [
      {
        "paramIndicator": "string",
        "paramName": "string"
      }
    ]
  }

DeliveryRuleCondition objects

Set the name property to specify the type of object.

For Cookies, use:

  "name": "Cookies",
  "parameters": {
    "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleCookiesConditionParameters",
    "matchValues": [ "string" ],
    "negateCondition": "bool",
    "operator": "string",
    "selector": "string",
    "transforms": [ "string" ]
  }

For HttpVersion, use:

  "name": "HttpVersion",
  "parameters": {
    "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleHttpVersionConditionParameters",
    "matchValues": [ "string" ],
    "negateCondition": "bool",
    "operator": "Equal"
  }

For IsDevice, use:

  "name": "IsDevice",
  "parameters": {
    "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleIsDeviceConditionParameters",
    "matchValues": [ "string" ],
    "negateCondition": "bool",
    "operator": "Equal",
    "transforms": [ "string" ]
  }

For PostArgs, use:

  "name": "PostArgs",
  "parameters": {
    "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRulePostArgsConditionParameters",
    "matchValues": [ "string" ],
    "negateCondition": "bool",
    "operator": "string",
    "selector": "string",
    "transforms": [ "string" ]
  }

For QueryString, use:

  "name": "QueryString",
  "parameters": {
    "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleQueryStringConditionParameters",
    "matchValues": [ "string" ],
    "negateCondition": "bool",
    "operator": "string",
    "transforms": [ "string" ]
  }

For RemoteAddress, use:

  "name": "RemoteAddress",
  "parameters": {
    "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleRemoteAddressConditionParameters",
    "matchValues": [ "string" ],
    "negateCondition": "bool",
    "operator": "string",
    "transforms": [ "string" ]
  }

For RequestBody, use:

  "name": "RequestBody",
  "parameters": {
    "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestBodyConditionParameters",
    "matchValues": [ "string" ],
    "negateCondition": "bool",
    "operator": "string",
    "transforms": [ "string" ]
  }

For RequestHeader, use:

  "name": "RequestHeader",
  "parameters": {
    "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestHeaderConditionParameters",
    "matchValues": [ "string" ],
    "negateCondition": "bool",
    "operator": "string",
    "selector": "string",
    "transforms": [ "string" ]
  }

For RequestMethod, use:

  "name": "RequestMethod",
  "parameters": {
    "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestMethodConditionParameters",
    "matchValues": [ "string" ],
    "negateCondition": "bool",
    "operator": "Equal"
  }

For RequestScheme, use:

  "name": "RequestScheme",
  "parameters": {
    "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestSchemeConditionParameters",
    "matchValues": [ "string" ],
    "negateCondition": "bool",
    "operator": "Equal"
  }

For RequestUri, use:

  "name": "RequestUri",
  "parameters": {
    "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestUriConditionParameters",
    "matchValues": [ "string" ],
    "negateCondition": "bool",
    "operator": "string",
    "transforms": [ "string" ]
  }

For UrlFileExtension, use:

  "name": "UrlFileExtension",
  "parameters": {
    "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlFileExtensionMatchConditionParameters",
    "matchValues": [ "string" ],
    "negateCondition": "bool",
    "operator": "string",
    "transforms": [ "string" ]
  }

For UrlFileName, use:

  "name": "UrlFileName",
  "parameters": {
    "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlFilenameConditionParameters",
    "matchValues": [ "string" ],
    "negateCondition": "bool",
    "operator": "string",
    "transforms": [ "string" ]
  }

For UrlPath, use:

  "name": "UrlPath",
  "parameters": {
    "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlPathMatchConditionParameters",
    "matchValues": [ "string" ],
    "negateCondition": "bool",
    "operator": "string",
    "transforms": [ "string" ]
  }

Property values

profiles/ruleSets/rules

Name	Description	Value
type	The resource type	'Microsoft.Cdn/profiles/ruleSets/rules'
apiVersion	The resource api version	'2020-09-01'
name	The resource name See how to set names and types for child resources in JSON ARM templates.	string (required)
properties	The JSON object that contains the properties of the Rules to create.	RuleProperties

RuleProperties

Name	Description	Value
actions	A list of actions that are executed when all the conditions of a rule are satisfied.	DeliveryRuleActionAutoGenerated[]
conditions	A list of conditions that must be matched for the actions to be executed	DeliveryRuleCondition[]
matchProcessingBehavior	If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue.	'Continue' 'Stop'
order	The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied.	int

DeliveryRuleActionAutoGenerated

Name	Description	Value
name	Set the object type	CacheExpiration CacheKeyQueryString ModifyRequestHeader ModifyResponseHeader OriginGroupOverride UrlRedirect UrlRewrite UrlSigning (required)

DeliveryRuleCacheExpirationAction

Name	Description	Value
name	The name of the action for the delivery rule.	'CacheExpiration' (required)
parameters	Defines the parameters for the action.	CacheExpirationActionParameters (required)

CacheExpirationActionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters' (required)
cacheBehavior	Caching behavior for the requests	'BypassCache' 'Override' 'SetIfMissing' (required)
cacheDuration	The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss	string
cacheType	The level at which the content needs to be cached.	'All' (required)

DeliveryRuleCacheKeyQueryStringAction

Name	Description	Value
name	The name of the action for the delivery rule.	'CacheKeyQueryString' (required)
parameters	Defines the parameters for the action.	CacheKeyQueryStringActionParameters (required)

CacheKeyQueryStringActionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' (required)
queryParameters	query parameters to include or exclude (comma separated).	string
queryStringBehavior	Caching behavior for the requests	'Exclude' 'ExcludeAll' 'Include' 'IncludeAll' (required)

DeliveryRuleRequestHeaderAction

Name	Description	Value
name	The name of the action for the delivery rule.	'ModifyRequestHeader' (required)
parameters	Defines the parameters for the action.	HeaderActionParameters (required)

HeaderActionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters' (required)
headerAction	Action to perform	'Append' 'Delete' 'Overwrite' (required)
headerName	Name of the header to modify	string (required)
value	Value for the specified action	string

DeliveryRuleResponseHeaderAction

Name	Description	Value
name	The name of the action for the delivery rule.	'ModifyResponseHeader' (required)
parameters	Defines the parameters for the action.	HeaderActionParameters (required)

OriginGroupOverrideAction

Name	Description	Value
name	The name of the action for the delivery rule.	'OriginGroupOverride' (required)
parameters	Defines the parameters for the action.	OriginGroupOverrideActionParameters (required)

OriginGroupOverrideActionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleOriginGroupOverrideActionParameters' (required)
originGroup	defines the OriginGroup that would override the DefaultOriginGroup.	ResourceReference (required)

ResourceReference

Name	Description	Value
id	Resource ID.	string

UrlRedirectAction

Name	Description	Value
name	The name of the action for the delivery rule.	'UrlRedirect' (required)
parameters	Defines the parameters for the action.	UrlRedirectActionParameters (required)

UrlRedirectActionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRedirectActionParameters' (required)
customFragment	Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #.	string
customHostname	Host to redirect. Leave empty to use the incoming host as the destination host.	string
customPath	The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.	string
customQueryString	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. ? and & will be added automatically so do not include them.	string
destinationProtocol	Protocol to use for the redirect. The default value is MatchRequest	'Http' 'Https' 'MatchRequest'
redirectType	The redirect type the rule will use when redirecting traffic.	'Found' 'Moved' 'PermanentRedirect' 'TemporaryRedirect' (required)

UrlRewriteAction

Name	Description	Value
name	The name of the action for the delivery rule.	'UrlRewrite' (required)
parameters	Defines the parameters for the action.	UrlRewriteActionParameters (required)

UrlRewriteActionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRewriteActionParameters' (required)
destination	Define the relative URL to which the above requests will be rewritten by.	string (required)
preserveUnmatchedPath	Whether to preserve unmatched path. Default value is true.	bool
sourcePattern	define a request URI pattern that identifies the type of requests that may be rewritten. If value is blank, all strings are matched.	string (required)

UrlSigningAction

Name	Description	Value
name	The name of the action for the delivery rule.	'UrlSigning' (required)
parameters	Defines the parameters for the action.	UrlSigningActionParameters (required)

UrlSigningActionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlSigningActionParameters' (required)
algorithm	Algorithm to use for URL signing	'SHA256'
parameterNameOverride	Defines which query string parameters in the url to be considered for expires, key id etc.	UrlSigningParamIdentifier[]

UrlSigningParamIdentifier

Name	Description	Value
paramIndicator	Indicates the purpose of the parameter	'Expires' 'KeyId' 'Signature' (required)
paramName	Parameter name	string (required)

DeliveryRuleCondition

Name	Description	Value
name	Set the object type	Cookies HttpVersion IsDevice PostArgs QueryString RemoteAddress RequestBody RequestHeader RequestMethod RequestScheme RequestUri UrlFileExtension UrlFileName UrlPath (required)

DeliveryRuleCookiesCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	'Cookies' (required)
parameters	Defines the parameters for the condition.	CookiesMatchConditionParameters (required)

CookiesMatchConditionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleCookiesConditionParameters' (required)
matchValues	The match value for the condition of the delivery rule	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	'Any' 'BeginsWith' 'Contains' 'EndsWith' 'Equal' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' 'RegEx' (required)
selector	Name of Cookies to be matched	string
transforms	List of transforms	String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode'

DeliveryRuleHttpVersionCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	'HttpVersion' (required)
parameters	Defines the parameters for the condition.	HttpVersionMatchConditionParameters (required)

HttpVersionMatchConditionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleHttpVersionConditionParameters' (required)
matchValues	The match value for the condition of the delivery rule	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	'Equal' (required)

DeliveryRuleIsDeviceCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	'IsDevice' (required)
parameters	Defines the parameters for the condition.	IsDeviceMatchConditionParameters (required)

IsDeviceMatchConditionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleIsDeviceConditionParameters' (required)
matchValues	The match value for the condition of the delivery rule	String array containing any of: 'Desktop' 'Mobile'
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	'Equal' (required)
transforms	List of transforms	String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode'

DeliveryRulePostArgsCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	'PostArgs' (required)
parameters	Defines the parameters for the condition.	PostArgsMatchConditionParameters (required)

PostArgsMatchConditionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRulePostArgsConditionParameters' (required)
matchValues	The match value for the condition of the delivery rule	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	'Any' 'BeginsWith' 'Contains' 'EndsWith' 'Equal' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' 'RegEx' (required)
selector	Name of PostArg to be matched	string
transforms	List of transforms	String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode'

DeliveryRuleQueryStringCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	'QueryString' (required)
parameters	Defines the parameters for the condition.	QueryStringMatchConditionParameters (required)

QueryStringMatchConditionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleQueryStringConditionParameters' (required)
matchValues	The match value for the condition of the delivery rule	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	'Any' 'BeginsWith' 'Contains' 'EndsWith' 'Equal' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' 'RegEx' (required)
transforms	List of transforms	String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode'

DeliveryRuleRemoteAddressCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	'RemoteAddress' (required)
parameters	Defines the parameters for the condition.	RemoteAddressMatchConditionParameters (required)

RemoteAddressMatchConditionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleRemoteAddressConditionParameters' (required)
matchValues	Match values to match against. The operator will apply to each value in here with OR semantics. If any of them match the variable with the given operator this match condition is considered a match.	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	'Any' 'GeoMatch' 'IPMatch' (required)
transforms	List of transforms	String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode'

DeliveryRuleRequestBodyCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	'RequestBody' (required)
parameters	Defines the parameters for the condition.	RequestBodyMatchConditionParameters (required)

RequestBodyMatchConditionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestBodyConditionParameters' (required)
matchValues	The match value for the condition of the delivery rule	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	'Any' 'BeginsWith' 'Contains' 'EndsWith' 'Equal' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' 'RegEx' (required)
transforms	List of transforms	String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode'

DeliveryRuleRequestHeaderCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	'RequestHeader' (required)
parameters	Defines the parameters for the condition.	RequestHeaderMatchConditionParameters (required)

RequestHeaderMatchConditionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestHeaderConditionParameters' (required)
matchValues	The match value for the condition of the delivery rule	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	'Any' 'BeginsWith' 'Contains' 'EndsWith' 'Equal' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' 'RegEx' (required)
selector	Name of Header to be matched	string
transforms	List of transforms	String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode'

DeliveryRuleRequestMethodCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	'RequestMethod' (required)
parameters	Defines the parameters for the condition.	RequestMethodMatchConditionParameters (required)

RequestMethodMatchConditionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestMethodConditionParameters' (required)
matchValues	The match value for the condition of the delivery rule	String array containing any of: 'DELETE' 'GET' 'HEAD' 'OPTIONS' 'POST' 'PUT' 'TRACE'
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	'Equal' (required)

DeliveryRuleRequestSchemeCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	'RequestScheme' (required)
parameters	Defines the parameters for the condition.	RequestSchemeMatchConditionParameters (required)

RequestSchemeMatchConditionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestSchemeConditionParameters' (required)
matchValues	The match value for the condition of the delivery rule	String array containing any of: 'HTTP' 'HTTPS'
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	'Equal' (required)

DeliveryRuleRequestUriCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	'RequestUri' (required)
parameters	Defines the parameters for the condition.	RequestUriMatchConditionParameters (required)

RequestUriMatchConditionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestUriConditionParameters' (required)
matchValues	The match value for the condition of the delivery rule	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	'Any' 'BeginsWith' 'Contains' 'EndsWith' 'Equal' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' 'RegEx' (required)
transforms	List of transforms	String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode'

DeliveryRuleUrlFileExtensionCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	'UrlFileExtension' (required)
parameters	Defines the parameters for the condition.	UrlFileExtensionMatchConditionParameters (required)

UrlFileExtensionMatchConditionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlFileExtensionMatchConditionParameters' (required)
matchValues	The match value for the condition of the delivery rule	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	'Any' 'BeginsWith' 'Contains' 'EndsWith' 'Equal' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' 'RegEx' (required)
transforms	List of transforms	String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode'

DeliveryRuleUrlFileNameCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	'UrlFileName' (required)
parameters	Defines the parameters for the condition.	UrlFileNameMatchConditionParameters (required)

UrlFileNameMatchConditionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlFilenameConditionParameters' (required)
matchValues	The match value for the condition of the delivery rule	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	'Any' 'BeginsWith' 'Contains' 'EndsWith' 'Equal' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' 'RegEx' (required)
transforms	List of transforms	String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode'

DeliveryRuleUrlPathCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	'UrlPath' (required)
parameters	Defines the parameters for the condition.	UrlPathMatchConditionParameters (required)

UrlPathMatchConditionParameters

Name	Description	Value
@odata.type		'#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlPathMatchConditionParameters' (required)
matchValues	The match value for the condition of the delivery rule	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	'Any' 'BeginsWith' 'Contains' 'EndsWith' 'Equal' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' 'RegEx' 'Wildcard' (required)
transforms	List of transforms	String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode'

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Front Door Standard/Premium with rule set	This template creates a Front Door Standard/Premium including a rule set.

Terraform (AzAPI provider) resource definition

The profiles/ruleSets/rules resource type can be deployed with operations that target:

Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Cdn/profiles/ruleSets/rules resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Cdn/profiles/ruleSets/rules@2020-09-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      actions = [
        {
          name = "string"
          // For remaining properties, see DeliveryRuleActionAutoGenerated objects
        }
      ]
      conditions = [
        {
          name = "string"
          // For remaining properties, see DeliveryRuleCondition objects
        }
      ]
      matchProcessingBehavior = "string"
      order = int
    }
  })
}

DeliveryRuleActionAutoGenerated objects

Set the name property to specify the type of object.

For CacheExpiration, use:

  name = "CacheExpiration"
  parameters = {
    @odata.type = "#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters"
    cacheBehavior = "string"
    cacheDuration = "string"
    cacheType = "All"
  }

For CacheKeyQueryString, use:

  name = "CacheKeyQueryString"
  parameters = {
    @odata.type = "#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheKeyQueryStringBehaviorActionParameters"
    queryParameters = "string"
    queryStringBehavior = "string"
  }

For ModifyRequestHeader, use:

  name = "ModifyRequestHeader"
  parameters = {
    @odata.type = "#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters"
    headerAction = "string"
    headerName = "string"
    value = "string"
  }

For ModifyResponseHeader, use:

  name = "ModifyResponseHeader"
  parameters = {
    @odata.type = "#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters"
    headerAction = "string"
    headerName = "string"
    value = "string"
  }

For OriginGroupOverride, use:

  name = "OriginGroupOverride"
  parameters = {
    @odata.type = "#Microsoft.Azure.Cdn.Models.DeliveryRuleOriginGroupOverrideActionParameters"
    originGroup = {
      id = "string"
    }
  }

For UrlRedirect, use:

  name = "UrlRedirect"
  parameters = {
    @odata.type = "#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRedirectActionParameters"
    customFragment = "string"
    customHostname = "string"
    customPath = "string"
    customQueryString = "string"
    destinationProtocol = "string"
    redirectType = "string"
  }

For UrlRewrite, use:

  name = "UrlRewrite"
  parameters = {
    @odata.type = "#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRewriteActionParameters"
    destination = "string"
    preserveUnmatchedPath = bool
    sourcePattern = "string"
  }

For UrlSigning, use:

  name = "UrlSigning"
  parameters = {
    @odata.type = "#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlSigningActionParameters"
    algorithm = "SHA256"
    parameterNameOverride = [
      {
        paramIndicator = "string"
        paramName = "string"
      }
    ]
  }

DeliveryRuleCondition objects

Set the name property to specify the type of object.

For Cookies, use:

  name = "Cookies"
  parameters = {
    @odata.type = "#Microsoft.Azure.Cdn.Models.DeliveryRuleCookiesConditionParameters"
    matchValues = [
      "string"
    ]
    negateCondition = bool
    operator = "string"
    selector = "string"
    transforms = [
      "string"
    ]
  }

For HttpVersion, use:

  name = "HttpVersion"
  parameters = {
    @odata.type = "#Microsoft.Azure.Cdn.Models.DeliveryRuleHttpVersionConditionParameters"
    matchValues = [
      "string"
    ]
    negateCondition = bool
    operator = "Equal"
  }

For IsDevice, use:

  name = "IsDevice"
  parameters = {
    @odata.type = "#Microsoft.Azure.Cdn.Models.DeliveryRuleIsDeviceConditionParameters"
    matchValues = [
      "string"
    ]
    negateCondition = bool
    operator = "Equal"
    transforms = [
      "string"
    ]
  }

For PostArgs, use:

  name = "PostArgs"
  parameters = {
    @odata.type = "#Microsoft.Azure.Cdn.Models.DeliveryRulePostArgsConditionParameters"
    matchValues = [
      "string"
    ]
    negateCondition = bool
    operator = "string"
    selector = "string"
    transforms = [
      "string"
    ]
  }

For QueryString, use:

  name = "QueryString"
  parameters = {
    @odata.type = "#Microsoft.Azure.Cdn.Models.DeliveryRuleQueryStringConditionParameters"
    matchValues = [
      "string"
    ]
    negateCondition = bool
    operator = "string"
    transforms = [
      "string"
    ]
  }

For RemoteAddress, use:

  name = "RemoteAddress"
  parameters = {
    @odata.type = "#Microsoft.Azure.Cdn.Models.DeliveryRuleRemoteAddressConditionParameters"
    matchValues = [
      "string"
    ]
    negateCondition = bool
    operator = "string"
    transforms = [
      "string"
    ]
  }

For RequestBody, use:

  name = "RequestBody"
  parameters = {
    @odata.type = "#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestBodyConditionParameters"
    matchValues = [
      "string"
    ]
    negateCondition = bool
    operator = "string"
    transforms = [
      "string"
    ]
  }

For RequestHeader, use:

  name = "RequestHeader"
  parameters = {
    @odata.type = "#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestHeaderConditionParameters"
    matchValues = [
      "string"
    ]
    negateCondition = bool
    operator = "string"
    selector = "string"
    transforms = [
      "string"
    ]
  }

For RequestMethod, use:

  name = "RequestMethod"
  parameters = {
    @odata.type = "#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestMethodConditionParameters"
    matchValues = [
      "string"
    ]
    negateCondition = bool
    operator = "Equal"
  }

For RequestScheme, use:

  name = "RequestScheme"
  parameters = {
    @odata.type = "#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestSchemeConditionParameters"
    matchValues = [
      "string"
    ]
    negateCondition = bool
    operator = "Equal"
  }

For RequestUri, use:

  name = "RequestUri"
  parameters = {
    @odata.type = "#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestUriConditionParameters"
    matchValues = [
      "string"
    ]
    negateCondition = bool
    operator = "string"
    transforms = [
      "string"
    ]
  }

For UrlFileExtension, use:

  name = "UrlFileExtension"
  parameters = {
    @odata.type = "#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlFileExtensionMatchConditionParameters"
    matchValues = [
      "string"
    ]
    negateCondition = bool
    operator = "string"
    transforms = [
      "string"
    ]
  }

For UrlFileName, use:

  name = "UrlFileName"
  parameters = {
    @odata.type = "#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlFilenameConditionParameters"
    matchValues = [
      "string"
    ]
    negateCondition = bool
    operator = "string"
    transforms = [
      "string"
    ]
  }

For UrlPath, use:

  name = "UrlPath"
  parameters = {
    @odata.type = "#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlPathMatchConditionParameters"
    matchValues = [
      "string"
    ]
    negateCondition = bool
    operator = "string"
    transforms = [
      "string"
    ]
  }

Property values

profiles/ruleSets/rules

Name	Description	Value
type	The resource type	"Microsoft.Cdn/profiles/ruleSets/rules@2020-09-01"
name	The resource name	string (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: ruleSets
properties	The JSON object that contains the properties of the Rules to create.	RuleProperties

RuleProperties

Name	Description	Value
actions	A list of actions that are executed when all the conditions of a rule are satisfied.	DeliveryRuleActionAutoGenerated[]
conditions	A list of conditions that must be matched for the actions to be executed	DeliveryRuleCondition[]
matchProcessingBehavior	If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue.	"Continue" "Stop"
order	The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied.	int

DeliveryRuleActionAutoGenerated

Name	Description	Value
name	Set the object type	CacheExpiration CacheKeyQueryString ModifyRequestHeader ModifyResponseHeader OriginGroupOverride UrlRedirect UrlRewrite UrlSigning (required)

DeliveryRuleCacheExpirationAction

Name	Description	Value
name	The name of the action for the delivery rule.	"CacheExpiration" (required)
parameters	Defines the parameters for the action.	CacheExpirationActionParameters (required)

CacheExpirationActionParameters

Name	Description	Value
@odata.type		"#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters" (required)
cacheBehavior	Caching behavior for the requests	"BypassCache" "Override" "SetIfMissing" (required)
cacheDuration	The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss	string
cacheType	The level at which the content needs to be cached.	"All" (required)

DeliveryRuleCacheKeyQueryStringAction

Name	Description	Value
name	The name of the action for the delivery rule.	"CacheKeyQueryString" (required)
parameters	Defines the parameters for the action.	CacheKeyQueryStringActionParameters (required)

CacheKeyQueryStringActionParameters

Name	Description	Value
@odata.type		"#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheKeyQueryStringBehaviorActionParameters" (required)
queryParameters	query parameters to include or exclude (comma separated).	string
queryStringBehavior	Caching behavior for the requests	"Exclude" "ExcludeAll" "Include" "IncludeAll" (required)

DeliveryRuleRequestHeaderAction

Name	Description	Value
name	The name of the action for the delivery rule.	"ModifyRequestHeader" (required)
parameters	Defines the parameters for the action.	HeaderActionParameters (required)

HeaderActionParameters

Name	Description	Value
@odata.type		"#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters" (required)
headerAction	Action to perform	"Append" "Delete" "Overwrite" (required)
headerName	Name of the header to modify	string (required)
value	Value for the specified action	string

DeliveryRuleResponseHeaderAction

Name	Description	Value
name	The name of the action for the delivery rule.	"ModifyResponseHeader" (required)
parameters	Defines the parameters for the action.	HeaderActionParameters (required)

OriginGroupOverrideAction

Name	Description	Value
name	The name of the action for the delivery rule.	"OriginGroupOverride" (required)
parameters	Defines the parameters for the action.	OriginGroupOverrideActionParameters (required)

OriginGroupOverrideActionParameters

Name	Description	Value
@odata.type		"#Microsoft.Azure.Cdn.Models.DeliveryRuleOriginGroupOverrideActionParameters" (required)
originGroup	defines the OriginGroup that would override the DefaultOriginGroup.	ResourceReference (required)

ResourceReference

Name	Description	Value
id	Resource ID.	string

UrlRedirectAction

Name	Description	Value
name	The name of the action for the delivery rule.	"UrlRedirect" (required)
parameters	Defines the parameters for the action.	UrlRedirectActionParameters (required)

UrlRedirectActionParameters

Name	Description	Value
@odata.type		"#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRedirectActionParameters" (required)
customFragment	Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #.	string
customHostname	Host to redirect. Leave empty to use the incoming host as the destination host.	string
customPath	The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.	string
customQueryString	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. ? and & will be added automatically so do not include them.	string
destinationProtocol	Protocol to use for the redirect. The default value is MatchRequest	"Http" "Https" "MatchRequest"
redirectType	The redirect type the rule will use when redirecting traffic.	"Found" "Moved" "PermanentRedirect" "TemporaryRedirect" (required)

UrlRewriteAction

Name	Description	Value
name	The name of the action for the delivery rule.	"UrlRewrite" (required)
parameters	Defines the parameters for the action.	UrlRewriteActionParameters (required)

UrlRewriteActionParameters

Name	Description	Value
@odata.type		"#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRewriteActionParameters" (required)
destination	Define the relative URL to which the above requests will be rewritten by.	string (required)
preserveUnmatchedPath	Whether to preserve unmatched path. Default value is true.	bool
sourcePattern	define a request URI pattern that identifies the type of requests that may be rewritten. If value is blank, all strings are matched.	string (required)

UrlSigningAction

Name	Description	Value
name	The name of the action for the delivery rule.	"UrlSigning" (required)
parameters	Defines the parameters for the action.	UrlSigningActionParameters (required)

UrlSigningActionParameters

Name	Description	Value
@odata.type		"#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlSigningActionParameters" (required)
algorithm	Algorithm to use for URL signing	"SHA256"
parameterNameOverride	Defines which query string parameters in the url to be considered for expires, key id etc.	UrlSigningParamIdentifier[]

UrlSigningParamIdentifier

Name	Description	Value
paramIndicator	Indicates the purpose of the parameter	"Expires" "KeyId" "Signature" (required)
paramName	Parameter name	string (required)

DeliveryRuleCondition

Name	Description	Value
name	Set the object type	Cookies HttpVersion IsDevice PostArgs QueryString RemoteAddress RequestBody RequestHeader RequestMethod RequestScheme RequestUri UrlFileExtension UrlFileName UrlPath (required)

DeliveryRuleCookiesCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	"Cookies" (required)
parameters	Defines the parameters for the condition.	CookiesMatchConditionParameters (required)

CookiesMatchConditionParameters

Name	Description	Value
@odata.type		"#Microsoft.Azure.Cdn.Models.DeliveryRuleCookiesConditionParameters" (required)
matchValues	The match value for the condition of the delivery rule	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	"Any" "BeginsWith" "Contains" "EndsWith" "Equal" "GreaterThan" "GreaterThanOrEqual" "LessThan" "LessThanOrEqual" "RegEx" (required)
selector	Name of Cookies to be matched	string
transforms	List of transforms	String array containing any of: "Lowercase" "RemoveNulls" "Trim" "Uppercase" "UrlDecode" "UrlEncode"

DeliveryRuleHttpVersionCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	"HttpVersion" (required)
parameters	Defines the parameters for the condition.	HttpVersionMatchConditionParameters (required)

HttpVersionMatchConditionParameters

Name	Description	Value
@odata.type		"#Microsoft.Azure.Cdn.Models.DeliveryRuleHttpVersionConditionParameters" (required)
matchValues	The match value for the condition of the delivery rule	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	"Equal" (required)

DeliveryRuleIsDeviceCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	"IsDevice" (required)
parameters	Defines the parameters for the condition.	IsDeviceMatchConditionParameters (required)

IsDeviceMatchConditionParameters

Name	Description	Value
@odata.type		"#Microsoft.Azure.Cdn.Models.DeliveryRuleIsDeviceConditionParameters" (required)
matchValues	The match value for the condition of the delivery rule	String array containing any of: "Desktop" "Mobile"
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	"Equal" (required)
transforms	List of transforms	String array containing any of: "Lowercase" "RemoveNulls" "Trim" "Uppercase" "UrlDecode" "UrlEncode"

DeliveryRulePostArgsCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	"PostArgs" (required)
parameters	Defines the parameters for the condition.	PostArgsMatchConditionParameters (required)

PostArgsMatchConditionParameters

Name	Description	Value
@odata.type		"#Microsoft.Azure.Cdn.Models.DeliveryRulePostArgsConditionParameters" (required)
matchValues	The match value for the condition of the delivery rule	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	"Any" "BeginsWith" "Contains" "EndsWith" "Equal" "GreaterThan" "GreaterThanOrEqual" "LessThan" "LessThanOrEqual" "RegEx" (required)
selector	Name of PostArg to be matched	string
transforms	List of transforms	String array containing any of: "Lowercase" "RemoveNulls" "Trim" "Uppercase" "UrlDecode" "UrlEncode"

DeliveryRuleQueryStringCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	"QueryString" (required)
parameters	Defines the parameters for the condition.	QueryStringMatchConditionParameters (required)

QueryStringMatchConditionParameters

Name	Description	Value
@odata.type		"#Microsoft.Azure.Cdn.Models.DeliveryRuleQueryStringConditionParameters" (required)
matchValues	The match value for the condition of the delivery rule	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	"Any" "BeginsWith" "Contains" "EndsWith" "Equal" "GreaterThan" "GreaterThanOrEqual" "LessThan" "LessThanOrEqual" "RegEx" (required)
transforms	List of transforms	String array containing any of: "Lowercase" "RemoveNulls" "Trim" "Uppercase" "UrlDecode" "UrlEncode"

DeliveryRuleRemoteAddressCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	"RemoteAddress" (required)
parameters	Defines the parameters for the condition.	RemoteAddressMatchConditionParameters (required)

RemoteAddressMatchConditionParameters

Name	Description	Value
@odata.type		"#Microsoft.Azure.Cdn.Models.DeliveryRuleRemoteAddressConditionParameters" (required)
matchValues	Match values to match against. The operator will apply to each value in here with OR semantics. If any of them match the variable with the given operator this match condition is considered a match.	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	"Any" "GeoMatch" "IPMatch" (required)
transforms	List of transforms	String array containing any of: "Lowercase" "RemoveNulls" "Trim" "Uppercase" "UrlDecode" "UrlEncode"

DeliveryRuleRequestBodyCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	"RequestBody" (required)
parameters	Defines the parameters for the condition.	RequestBodyMatchConditionParameters (required)

RequestBodyMatchConditionParameters

Name	Description	Value
@odata.type		"#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestBodyConditionParameters" (required)
matchValues	The match value for the condition of the delivery rule	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	"Any" "BeginsWith" "Contains" "EndsWith" "Equal" "GreaterThan" "GreaterThanOrEqual" "LessThan" "LessThanOrEqual" "RegEx" (required)
transforms	List of transforms	String array containing any of: "Lowercase" "RemoveNulls" "Trim" "Uppercase" "UrlDecode" "UrlEncode"

DeliveryRuleRequestHeaderCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	"RequestHeader" (required)
parameters	Defines the parameters for the condition.	RequestHeaderMatchConditionParameters (required)

RequestHeaderMatchConditionParameters

Name	Description	Value
@odata.type		"#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestHeaderConditionParameters" (required)
matchValues	The match value for the condition of the delivery rule	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	"Any" "BeginsWith" "Contains" "EndsWith" "Equal" "GreaterThan" "GreaterThanOrEqual" "LessThan" "LessThanOrEqual" "RegEx" (required)
selector	Name of Header to be matched	string
transforms	List of transforms	String array containing any of: "Lowercase" "RemoveNulls" "Trim" "Uppercase" "UrlDecode" "UrlEncode"

DeliveryRuleRequestMethodCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	"RequestMethod" (required)
parameters	Defines the parameters for the condition.	RequestMethodMatchConditionParameters (required)

RequestMethodMatchConditionParameters

Name	Description	Value
@odata.type		"#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestMethodConditionParameters" (required)
matchValues	The match value for the condition of the delivery rule	String array containing any of: "DELETE" "GET" "HEAD" "OPTIONS" "POST" "PUT" "TRACE"
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	"Equal" (required)

DeliveryRuleRequestSchemeCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	"RequestScheme" (required)
parameters	Defines the parameters for the condition.	RequestSchemeMatchConditionParameters (required)

RequestSchemeMatchConditionParameters

Name	Description	Value
@odata.type		"#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestSchemeConditionParameters" (required)
matchValues	The match value for the condition of the delivery rule	String array containing any of: "HTTP" "HTTPS"
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	"Equal" (required)

DeliveryRuleRequestUriCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	"RequestUri" (required)
parameters	Defines the parameters for the condition.	RequestUriMatchConditionParameters (required)

RequestUriMatchConditionParameters

Name	Description	Value
@odata.type		"#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestUriConditionParameters" (required)
matchValues	The match value for the condition of the delivery rule	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	"Any" "BeginsWith" "Contains" "EndsWith" "Equal" "GreaterThan" "GreaterThanOrEqual" "LessThan" "LessThanOrEqual" "RegEx" (required)
transforms	List of transforms	String array containing any of: "Lowercase" "RemoveNulls" "Trim" "Uppercase" "UrlDecode" "UrlEncode"

DeliveryRuleUrlFileExtensionCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	"UrlFileExtension" (required)
parameters	Defines the parameters for the condition.	UrlFileExtensionMatchConditionParameters (required)

UrlFileExtensionMatchConditionParameters

Name	Description	Value
@odata.type		"#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlFileExtensionMatchConditionParameters" (required)
matchValues	The match value for the condition of the delivery rule	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	"Any" "BeginsWith" "Contains" "EndsWith" "Equal" "GreaterThan" "GreaterThanOrEqual" "LessThan" "LessThanOrEqual" "RegEx" (required)
transforms	List of transforms	String array containing any of: "Lowercase" "RemoveNulls" "Trim" "Uppercase" "UrlDecode" "UrlEncode"

DeliveryRuleUrlFileNameCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	"UrlFileName" (required)
parameters	Defines the parameters for the condition.	UrlFileNameMatchConditionParameters (required)

UrlFileNameMatchConditionParameters

Name	Description	Value
@odata.type		"#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlFilenameConditionParameters" (required)
matchValues	The match value for the condition of the delivery rule	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	"Any" "BeginsWith" "Contains" "EndsWith" "Equal" "GreaterThan" "GreaterThanOrEqual" "LessThan" "LessThanOrEqual" "RegEx" (required)
transforms	List of transforms	String array containing any of: "Lowercase" "RemoveNulls" "Trim" "Uppercase" "UrlDecode" "UrlEncode"

DeliveryRuleUrlPathCondition

Name	Description	Value
name	The name of the condition for the delivery rule.	"UrlPath" (required)
parameters	Defines the parameters for the condition.	UrlPathMatchConditionParameters (required)

UrlPathMatchConditionParameters

Name	Description	Value
@odata.type		"#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlPathMatchConditionParameters" (required)
matchValues	The match value for the condition of the delivery rule	string[]
negateCondition	Describes if this is negate condition or not	bool
operator	Describes operator to be matched	"Any" "BeginsWith" "Contains" "EndsWith" "Equal" "GreaterThan" "GreaterThanOrEqual" "LessThan" "LessThanOrEqual" "RegEx" "Wildcard" (required)
transforms	List of transforms	String array containing any of: "Lowercase" "RemoveNulls" "Trim" "Uppercase" "UrlDecode" "UrlEncode"

Share via

Microsoft.Cdn profiles/ruleSets/rules 2020-09-01

Bicep resource definition

Resource format

DeliveryRuleActionAutoGenerated objects

DeliveryRuleCondition objects

Property values

profiles/ruleSets/rules

RuleProperties

DeliveryRuleActionAutoGenerated

DeliveryRuleCacheExpirationAction

CacheExpirationActionParameters

DeliveryRuleCacheKeyQueryStringAction

CacheKeyQueryStringActionParameters

DeliveryRuleRequestHeaderAction

HeaderActionParameters

DeliveryRuleResponseHeaderAction

OriginGroupOverrideAction

OriginGroupOverrideActionParameters

ResourceReference

UrlRedirectAction

UrlRedirectActionParameters

UrlRewriteAction

UrlRewriteActionParameters

UrlSigningAction

UrlSigningActionParameters

UrlSigningParamIdentifier

DeliveryRuleCondition

DeliveryRuleCookiesCondition

CookiesMatchConditionParameters

DeliveryRuleHttpVersionCondition

HttpVersionMatchConditionParameters

DeliveryRuleIsDeviceCondition

IsDeviceMatchConditionParameters

DeliveryRulePostArgsCondition

PostArgsMatchConditionParameters

DeliveryRuleQueryStringCondition

QueryStringMatchConditionParameters

DeliveryRuleRemoteAddressCondition

RemoteAddressMatchConditionParameters

DeliveryRuleRequestBodyCondition

RequestBodyMatchConditionParameters

DeliveryRuleRequestHeaderCondition

RequestHeaderMatchConditionParameters

DeliveryRuleRequestMethodCondition

RequestMethodMatchConditionParameters

DeliveryRuleRequestSchemeCondition

RequestSchemeMatchConditionParameters

DeliveryRuleRequestUriCondition

RequestUriMatchConditionParameters

DeliveryRuleUrlFileExtensionCondition

UrlFileExtensionMatchConditionParameters

DeliveryRuleUrlFileNameCondition

UrlFileNameMatchConditionParameters

DeliveryRuleUrlPathCondition

UrlPathMatchConditionParameters

Quickstart templates

ARM template resource definition

Resource format

DeliveryRuleActionAutoGenerated objects

DeliveryRuleCondition objects

Property values

profiles/ruleSets/rules

RuleProperties

DeliveryRuleActionAutoGenerated

DeliveryRuleCacheExpirationAction

CacheExpirationActionParameters

DeliveryRuleCacheKeyQueryStringAction

CacheKeyQueryStringActionParameters

DeliveryRuleRequestHeaderAction

HeaderActionParameters

DeliveryRuleResponseHeaderAction

OriginGroupOverrideAction

OriginGroupOverrideActionParameters

ResourceReference

UrlRedirectAction

UrlRedirectActionParameters

UrlRewriteAction

UrlRewriteActionParameters

UrlSigningAction