Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
- Latest
- 2025-09-01-preview
- 2025-07-01-preview
- 2025-06-01
- 2025-05-01-preview
- 2025-04-15
- 2025-01-01-preview
- 2024-09-01
- 2024-06-01-preview
- 2024-05-01-preview
- 2024-02-01
- 2023-07-01-preview
- 2023-05-01
- 2022-11-01-preview
- 2022-05-01-preview
- 2021-06-01
- 2020-09-01
- 2020-04-15
- 2019-12-31
- 2019-06-15
- 2019-06-15-preview
- 2019-04-15
- 2017-10-12
- 2017-04-02
- 2016-10-02
- 2016-04-02
- 2015-06-01
Bicep resource definition
The profiles/endpoints resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Cdn/profiles/endpoints resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Cdn/profiles/endpoints@2025-09-01-preview' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
contentTypesToCompress: [
'string'
]
defaultOriginGroup: {
id: 'string'
}
deliveryPolicy: {
description: 'string'
rules: [
{
actions: [
{
name: 'string'
// For remaining properties, see DeliveryRuleAction objects
}
]
conditions: [
{
name: 'string'
// For remaining properties, see DeliveryRuleCondition objects
}
]
name: 'string'
order: int
}
]
}
geoFilters: [
{
action: 'string'
countryCodes: [
'string'
]
relativePath: 'string'
}
]
isCompressionEnabled: bool
isHttpAllowed: bool
isHttpsAllowed: bool
optimizationType: 'string'
originGroups: [
{
name: 'string'
properties: {
healthProbeSettings: {
probeIntervalInSeconds: int
probePath: 'string'
probeProtocol: 'string'
probeRequestType: 'string'
}
origins: [
{
id: 'string'
}
]
responseBasedOriginErrorDetectionSettings: {
httpErrorRanges: [
{
begin: int
end: int
}
]
responseBasedDetectedErrorTypes: 'string'
responseBasedFailoverThresholdPercentage: int
}
trafficRestorationTimeToHealedOrNewEndpointsInMinutes: int
}
}
]
originHostHeader: 'string'
originPath: 'string'
origins: [
{
name: 'string'
properties: {
enabled: bool
hostName: 'string'
httpPort: int
httpsPort: int
originHostHeader: 'string'
priority: int
privateLinkAlias: 'string'
privateLinkApprovalMessage: 'string'
privateLinkLocation: 'string'
privateLinkResourceId: 'string'
weight: int
}
}
]
probePath: 'string'
queryStringCachingBehavior: 'string'
urlSigningKeys: [
{
keyId: 'string'
keySourceParameters: {
resourceGroupName: 'string'
secretName: 'string'
secretVersion: 'string'
subscriptionId: 'string'
typeName: 'string'
vaultName: 'string'
}
}
]
webApplicationFirewallPolicyLink: {
id: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
DeliveryRuleAction objects
Set the name property to specify the type of object.
For AfdUrlSigning, use:
{
name: 'AfdUrlSigning'
parameters: {
algorithm: 'string'
keyGroupReference: {
id: 'string'
}
parameterNameOverride: [
{
paramIndicator: 'string'
paramName: 'string'
}
]
typeName: 'string'
}
}
For CacheExpiration, use:
{
name: 'CacheExpiration'
parameters: {
cacheBehavior: 'string'
cacheDuration: 'string'
cacheType: 'string'
typeName: 'string'
}
}
For CacheKeyQueryString, use:
{
name: 'CacheKeyQueryString'
parameters: {
queryParameters: 'string'
queryStringBehavior: 'string'
typeName: 'string'
}
}
For EdgeAction, use:
{
name: 'EdgeAction'
parameters: {
edgeActionReference: {
id: 'string'
}
invocationPoint: 'string'
typeName: 'string'
}
}
For ModifyRequestHeader, use:
{
name: 'ModifyRequestHeader'
parameters: {
headerAction: 'string'
headerName: 'string'
typeName: 'string'
value: 'string'
}
}
For ModifyResponseHeader, use:
{
name: 'ModifyResponseHeader'
parameters: {
headerAction: 'string'
headerName: 'string'
typeName: 'string'
value: 'string'
}
}
For OriginGroupOverride, use:
{
name: 'OriginGroupOverride'
parameters: {
originGroup: {
id: 'string'
}
typeName: 'string'
}
}
For RouteConfigurationOverride, use:
{
name: 'RouteConfigurationOverride'
parameters: {
cacheConfiguration: {
cacheBehavior: 'string'
cacheDuration: 'string'
isCompressionEnabled: 'string'
queryParameters: 'string'
queryStringCachingBehavior: 'string'
}
originGroupOverride: {
forwardingProtocol: 'string'
originGroup: {
id: 'string'
}
}
typeName: 'string'
}
}
For UrlRedirect, use:
{
name: 'UrlRedirect'
parameters: {
customFragment: 'string'
customHostname: 'string'
customPath: 'string'
customQueryString: 'string'
destinationProtocol: 'string'
redirectType: 'string'
typeName: 'string'
}
}
For UrlRewrite, use:
{
name: 'UrlRewrite'
parameters: {
destination: 'string'
preserveUnmatchedPath: bool
sourcePattern: 'string'
typeName: 'string'
}
}
For UrlSigning, use:
{
name: 'UrlSigning'
parameters: {
algorithm: 'string'
parameterNameOverride: [
{
paramIndicator: 'string'
paramName: 'string'
}
]
typeName: 'string'
}
}
DeliveryRuleCondition objects
Set the name property to specify the type of object.
For ClientPort, use:
{
name: 'ClientPort'
parameters: {
matchValues: [
'string'
]
negateCondition: bool
operator: 'string'
transforms: [
'string'
]
typeName: 'string'
}
}
For Cookies, use:
{
name: 'Cookies'
parameters: {
matchValues: [
'string'
]
negateCondition: bool
operator: 'string'
selector: 'string'
transforms: [
'string'
]
typeName: 'string'
}
}
For HostName, use:
{
name: 'HostName'
parameters: {
matchValues: [
'string'
]
negateCondition: bool
operator: 'string'
transforms: [
'string'
]
typeName: 'string'
}
}
For HttpVersion, use:
{
name: 'HttpVersion'
parameters: {
matchValues: [
'string'
]
negateCondition: bool
operator: 'string'
transforms: [
'string'
]
typeName: 'string'
}
}
For IsDevice, use:
{
name: 'IsDevice'
parameters: {
matchValues: [
'string'
]
negateCondition: bool
operator: 'string'
transforms: [
'string'
]
typeName: 'string'
}
}
For PostArgs, use:
{
name: 'PostArgs'
parameters: {
matchValues: [
'string'
]
negateCondition: bool
operator: 'string'
selector: 'string'
transforms: [
'string'
]
typeName: 'string'
}
}
For QueryString, use:
{
name: 'QueryString'
parameters: {
matchValues: [
'string'
]
negateCondition: bool
operator: 'string'
transforms: [
'string'
]
typeName: 'string'
}
}
For RemoteAddress, use:
{
name: 'RemoteAddress'
parameters: {
matchValues: [
'string'
]
negateCondition: bool
operator: 'string'
transforms: [
'string'
]
typeName: 'string'
}
}
For RequestBody, use:
{
name: 'RequestBody'
parameters: {
matchValues: [
'string'
]
negateCondition: bool
operator: 'string'
transforms: [
'string'
]
typeName: 'string'
}
}
For RequestHeader, use:
{
name: 'RequestHeader'
parameters: {
matchValues: [
'string'
]
negateCondition: bool
operator: 'string'
selector: 'string'
transforms: [
'string'
]
typeName: 'string'
}
}
For RequestMethod, use:
{
name: 'RequestMethod'
parameters: {
matchValues: [
'string'
]
negateCondition: bool
operator: 'string'
transforms: [
'string'
]
typeName: 'string'
}
}
For RequestScheme, use:
{
name: 'RequestScheme'
parameters: {
matchValues: [
'string'
]
negateCondition: bool
operator: 'string'
transforms: [
'string'
]
typeName: 'string'
}
}
For RequestUri, use:
{
name: 'RequestUri'
parameters: {
matchValues: [
'string'
]
negateCondition: bool
operator: 'string'
transforms: [
'string'
]
typeName: 'string'
}
}
For ServerPort, use:
{
name: 'ServerPort'
parameters: {
matchValues: [
'string'
]
negateCondition: bool
operator: 'string'
transforms: [
'string'
]
typeName: 'string'
}
}
For SocketAddr, use:
{
name: 'SocketAddr'
parameters: {
matchValues: [
'string'
]
negateCondition: bool
operator: 'string'
transforms: [
'string'
]
typeName: 'string'
}
}
For SslProtocol, use:
{
name: 'SslProtocol'
parameters: {
matchValues: [
'string'
]
negateCondition: bool
operator: 'string'
transforms: [
'string'
]
typeName: 'string'
}
}
For UrlFileExtension, use:
{
name: 'UrlFileExtension'
parameters: {
matchValues: [
'string'
]
negateCondition: bool
operator: 'string'
transforms: [
'string'
]
typeName: 'string'
}
}
For UrlFileName, use:
{
name: 'UrlFileName'
parameters: {
matchValues: [
'string'
]
negateCondition: bool
operator: 'string'
transforms: [
'string'
]
typeName: 'string'
}
}
For UrlPath, use:
{
name: 'UrlPath'
parameters: {
matchValues: [
'string'
]
negateCondition: bool
operator: 'string'
transforms: [
'string'
]
typeName: 'string'
}
}
Property Values
Microsoft.Cdn/profiles/endpoints
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | 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: profiles |
| properties | The JSON object that contains the properties required to create an endpoint. | EndpointProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
AfdUrlSigningAction
| Name | Description | Value |
|---|---|---|
| name | The name of the action for the delivery rule. | 'AfdUrlSigning' (required) |
| parameters | Defines the parameters for the action. | AfdUrlSigningActionParameters (required) |
AfdUrlSigningActionParameters
| Name | Description | Value |
|---|---|---|
| algorithm | Algorithm to use for URL signing | 'SHA256' |
| keyGroupReference | Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/keyGroups/{keyGroupName} | ResourceReference (required) |
| parameterNameOverride | Defines which query string parameters in the url to be considered for expires, key id etc. | UrlSigningParamIdentifier[] |
| typeName | 'DeliveryRuleAfdUrlSigningActionParameters' (required) |
CacheConfiguration
| Name | Description | Value |
|---|---|---|
| cacheBehavior | Caching behavior for the requests | 'HonorOrigin' 'OverrideAlways' 'OverrideIfOriginMissing' |
| cacheDuration | The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss | string |
| isCompressionEnabled | Indicates whether content compression is enabled. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB. | 'Disabled' 'Enabled' |
| queryParameters | query parameters to include or exclude (comma separated). | string |
| queryStringCachingBehavior | Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings. | 'IgnoreQueryString' 'IgnoreSpecifiedQueryStrings' 'IncludeSpecifiedQueryStrings' 'UseQueryString' |
CacheExpirationActionParameters
| Name | Description | Value |
|---|---|---|
| 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) |
| typeName | 'DeliveryRuleCacheExpirationActionParameters' 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' 'DeliveryRuleEdgeActionParameters' 'DeliveryRuleHeaderActionParameters' 'DeliveryRuleOriginGroupOverrideActionParameters' 'DeliveryRuleRouteConfigurationOverrideActionParameters' 'DeliveryRuleUrlRedirectActionParameters' 'DeliveryRuleUrlRewriteActionParameters' 'DeliveryRuleUrlSigningActionParameters' (required) |
CacheKeyQueryStringActionParameters
| Name | Description | Value |
|---|---|---|
| queryParameters | query parameters to include or exclude (comma separated). | string |
| queryStringBehavior | Caching behavior for the requests | 'Exclude' 'ExcludeAll' 'Include' 'IncludeAll' (required) |
| typeName | 'DeliveryRuleCacheExpirationActionParameters' 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' 'DeliveryRuleEdgeActionParameters' 'DeliveryRuleHeaderActionParameters' 'DeliveryRuleOriginGroupOverrideActionParameters' 'DeliveryRuleRouteConfigurationOverrideActionParameters' 'DeliveryRuleUrlRedirectActionParameters' 'DeliveryRuleUrlRewriteActionParameters' 'DeliveryRuleUrlSigningActionParameters' (required) |
ClientPortMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
CookiesMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
DeepCreatedOrigin
| Name | Description | Value |
|---|---|---|
| name | Origin name which must be unique within the endpoint. | string (required) |
| properties | Properties of the origin created on the CDN endpoint. | DeepCreatedOriginProperties |
DeepCreatedOriginGroup
| Name | Description | Value |
|---|---|---|
| name | Origin group name which must be unique within the endpoint. | string (required) |
| properties | Properties of the origin group created on the CDN endpoint. | DeepCreatedOriginGroupProperties |
DeepCreatedOriginGroupProperties
| Name | Description | Value |
|---|---|---|
| healthProbeSettings | Health probe settings to the origin that is used to determine the health of the origin. | HealthProbeParameters |
| origins | The source of the content being delivered via CDN within given origin group. | ResourceReference[] (required) |
| responseBasedOriginErrorDetectionSettings | The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported. | ResponseBasedOriginErrorDetectionParameters |
| trafficRestorationTimeToHealedOrNewEndpointsInMinutes | Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. | int Constraints: Max value = 50 |
DeepCreatedOriginProperties
| Name | Description | Value |
|---|---|---|
| enabled | Origin is enabled for load balancing or not. By default, origin is always enabled. | bool |
| hostName | The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. | string (required) |
| httpPort | The value of the HTTP port. Must be between 1 and 65535. | int Constraints: Min value = 1 Max value = 65535 |
| httpsPort | The value of the HTTPS port. Must be between 1 and 65535. | int Constraints: Min value = 1 Max value = 65535 |
| originHostHeader | The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. | string |
| priority | Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. | int Constraints: Min value = 1 Max value = 5 |
| privateLinkAlias | The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' | string |
| privateLinkApprovalMessage | A custom message to be included in the approval request to connect to the Private Link. | string |
| privateLinkLocation | The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated | string |
| privateLinkResourceId | The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' | string |
| weight | Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 | int Constraints: Min value = 1 Max value = 1000 |
DeliveryRule
| Name | Description | Value |
|---|---|---|
| actions | A list of actions that are executed when all the conditions of a rule are satisfied. | DeliveryRuleAction[] (required) |
| conditions | A list of conditions that must be matched for the actions to be executed | DeliveryRuleCondition[] |
| name | Name of the rule | string |
| 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 (required) |
DeliveryRuleAction
| Name | Description | Value |
|---|---|---|
| name | Set to 'AfdUrlSigning' for type AfdUrlSigningAction. Set to 'CacheExpiration' for type DeliveryRuleCacheExpirationAction. Set to 'CacheKeyQueryString' for type DeliveryRuleCacheKeyQueryStringAction. Set to 'EdgeAction' for type EdgeAction. Set to 'ModifyRequestHeader' for type DeliveryRuleRequestHeaderAction. Set to 'ModifyResponseHeader' for type DeliveryRuleResponseHeaderAction. Set to 'OriginGroupOverride' for type OriginGroupOverrideAction. Set to 'RouteConfigurationOverride' for type DeliveryRuleRouteConfigurationOverrideAction. Set to 'UrlRedirect' for type UrlRedirectAction. Set to 'UrlRewrite' for type UrlRewriteAction. Set to 'UrlSigning' for type UrlSigningAction. | 'AfdUrlSigning' 'CacheExpiration' 'CacheKeyQueryString' 'EdgeAction' 'ModifyRequestHeader' 'ModifyResponseHeader' 'OriginGroupOverride' 'RouteConfigurationOverride' '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) |
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) |
DeliveryRuleClientPortCondition
| Name | Description | Value |
|---|---|---|
| name | The name of the condition for the delivery rule. | 'ClientPort' (required) |
| parameters | Defines the parameters for the condition. | ClientPortMatchConditionParameters (required) |
DeliveryRuleCondition
| Name | Description | Value |
|---|---|---|
| name | Set to 'ClientPort' for type DeliveryRuleClientPortCondition. Set to 'Cookies' for type DeliveryRuleCookiesCondition. Set to 'HostName' for type DeliveryRuleHostNameCondition. Set to 'HttpVersion' for type DeliveryRuleHttpVersionCondition. Set to 'IsDevice' for type DeliveryRuleIsDeviceCondition. Set to 'PostArgs' for type DeliveryRulePostArgsCondition. Set to 'QueryString' for type DeliveryRuleQueryStringCondition. Set to 'RemoteAddress' for type DeliveryRuleRemoteAddressCondition. Set to 'RequestBody' for type DeliveryRuleRequestBodyCondition. Set to 'RequestHeader' for type DeliveryRuleRequestHeaderCondition. Set to 'RequestMethod' for type DeliveryRuleRequestMethodCondition. Set to 'RequestScheme' for type DeliveryRuleRequestSchemeCondition. Set to 'RequestUri' for type DeliveryRuleRequestUriCondition. Set to 'ServerPort' for type DeliveryRuleServerPortCondition. Set to 'SocketAddr' for type DeliveryRuleSocketAddrCondition. Set to 'SslProtocol' for type DeliveryRuleSslProtocolCondition. Set to 'UrlFileExtension' for type DeliveryRuleUrlFileExtensionCondition. Set to 'UrlFileName' for type DeliveryRuleUrlFileNameCondition. Set to 'UrlPath' for type DeliveryRuleUrlPathCondition. | 'ClientPort' 'Cookies' 'HostName' 'HttpVersion' 'IsDevice' 'PostArgs' 'QueryString' 'RemoteAddress' 'RequestBody' 'RequestHeader' 'RequestMethod' 'RequestScheme' 'RequestUri' 'ServerPort' 'SocketAddr' 'SslProtocol' '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) |
DeliveryRuleEdgeActionParameters
| Name | Description | Value |
|---|---|---|
| edgeActionReference | defines the edge action that will be invoked. | ResourceReference (required) |
| invocationPoint | Defines at which point in the request processing pipeline the edge action will be invoked. | 'ClientRequest' 'OriginRequest' (required) |
| typeName | 'DeliveryRuleCacheExpirationActionParameters' 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' 'DeliveryRuleEdgeActionParameters' 'DeliveryRuleHeaderActionParameters' 'DeliveryRuleOriginGroupOverrideActionParameters' 'DeliveryRuleRouteConfigurationOverrideActionParameters' 'DeliveryRuleUrlRedirectActionParameters' 'DeliveryRuleUrlRewriteActionParameters' 'DeliveryRuleUrlSigningActionParameters' (required) |
DeliveryRuleHostNameCondition
| Name | Description | Value |
|---|---|---|
| name | The name of the condition for the delivery rule. | 'HostName' (required) |
| parameters | Defines the parameters for the condition. | HostNameMatchConditionParameters (required) |
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) |
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) |
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) |
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) |
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) |
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) |
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) |
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) |
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) |
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) |
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) |
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) |
DeliveryRuleRouteConfigurationOverrideAction
| Name | Description | Value |
|---|---|---|
| name | The name of the action for the delivery rule. | 'RouteConfigurationOverride' (required) |
| parameters | Defines the parameters for the action. | RouteConfigurationOverrideActionParameters (required) |
DeliveryRuleServerPortCondition
| Name | Description | Value |
|---|---|---|
| name | The name of the condition for the delivery rule. | 'ServerPort' (required) |
| parameters | Defines the parameters for the condition. | ServerPortMatchConditionParameters (required) |
DeliveryRuleSocketAddrCondition
| Name | Description | Value |
|---|---|---|
| name | The name of the condition for the delivery rule. | 'SocketAddr' (required) |
| parameters | Defines the parameters for the condition. | SocketAddrMatchConditionParameters (required) |
DeliveryRuleSslProtocolCondition
| Name | Description | Value |
|---|---|---|
| name | The name of the condition for the delivery rule. | 'SslProtocol' (required) |
| parameters | Defines the parameters for the condition. | SslProtocolMatchConditionParameters (required) |
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) |
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) |
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) |
EdgeAction
| Name | Description | Value |
|---|---|---|
| name | The name of the action for the delivery rule. | 'EdgeAction' (required) |
| parameters | Defines the parameters for the action. | DeliveryRuleEdgeActionParameters (required) |
EndpointProperties
| Name | Description | Value |
|---|---|---|
| contentTypesToCompress | List of content types on which compression applies. The value should be a valid MIME type. | string[] |
| defaultOriginGroup | A reference to the origin group. | ResourceReference |
| deliveryPolicy | A policy that specifies the delivery rules to be used for an endpoint. | EndpointPropertiesUpdateParametersDeliveryPolicy |
| geoFilters | List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/ | GeoFilter[] |
| isCompressionEnabled | Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB. | bool |
| isHttpAllowed | Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. | bool |
| isHttpsAllowed | Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. | bool |
| optimizationType | Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. Download, Media services. With this information, CDN can apply scenario driven optimization. | 'DynamicSiteAcceleration' 'GeneralMediaStreaming' 'GeneralWebDelivery' 'LargeFileDownload' 'VideoOnDemandMediaStreaming' |
| originGroups | The origin groups comprising of origins that are used for load balancing the traffic based on availability. | DeepCreatedOriginGroup[] |
| originHostHeader | The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. | string |
| originPath | A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. | string |
| origins | The source of the content being delivered via CDN. | DeepCreatedOrigin[] (required) |
| probePath | Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin. | string |
| queryStringCachingBehavior | Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. | 'BypassCaching' 'IgnoreQueryString' 'NotSet' 'UseQueryString' |
| urlSigningKeys | List of keys used to validate the signed URL hashes. | UrlSigningKey[] |
| webApplicationFirewallPolicyLink | Defines the Web Application Firewall policy for the endpoint (if applicable) | EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink |
EndpointPropertiesUpdateParametersDeliveryPolicy
| Name | Description | Value |
|---|---|---|
| description | User-friendly description of the policy. | string |
| rules | A list of the delivery rules. | DeliveryRule[] (required) |
EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
GeoFilter
| Name | Description | Value |
|---|---|---|
| action | Action of the geo filter, i.e. allow or block access. | 'Allow' 'Block' (required) |
| countryCodes | Two letter country or region codes defining user country or region access in a geo filter, e.g. AU, MX, US. | string[] (required) |
| relativePath | Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.) | string (required) |
HeaderActionParameters
| Name | Description | Value |
|---|---|---|
| headerAction | Action to perform | 'Append' 'Delete' 'Overwrite' (required) |
| headerName | Name of the header to modify | string (required) |
| typeName | 'DeliveryRuleCacheExpirationActionParameters' 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' 'DeliveryRuleEdgeActionParameters' 'DeliveryRuleHeaderActionParameters' 'DeliveryRuleOriginGroupOverrideActionParameters' 'DeliveryRuleRouteConfigurationOverrideActionParameters' 'DeliveryRuleUrlRedirectActionParameters' 'DeliveryRuleUrlRewriteActionParameters' 'DeliveryRuleUrlSigningActionParameters' (required) |
|
| value | Value for the specified action | string |
HealthProbeParameters
| Name | Description | Value |
|---|---|---|
| probeIntervalInSeconds | The number of seconds between health probes.Default is 240sec. | int Constraints: Min value = 1 Max value = 255 |
| probePath | The path relative to the origin that is used to determine the health of the origin. | string |
| probeProtocol | Protocol to use for health probe. | 'Grpc' 'Http' 'Https' 'NotSet' |
| probeRequestType | The type of health probe request that is made. | 'GET' 'HEAD' 'NotSet' |
HostNameMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
HttpErrorRangeParameters
| Name | Description | Value |
|---|---|---|
| begin | The inclusive start of the http status code range. | int Constraints: Min value = 100 Max value = 999 |
| end | The inclusive end of the http status code range. | int Constraints: Min value = 100 Max value = 999 |
HttpVersionMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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) |
| transforms | List of transforms | String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
IsDeviceMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
KeyVaultSigningKeyParameters
| Name | Description | Value |
|---|---|---|
| resourceGroupName | Resource group of the user's Key Vault containing the secret | string (required) |
| secretName | The name of secret in Key Vault. | string (required) |
| secretVersion | The version(GUID) of secret in Key Vault. | string (required) |
| subscriptionId | Subscription Id of the user's Key Vault containing the secret | string (required) |
| typeName | 'KeyVaultSigningKeyParameters' (required) | |
| vaultName | The name of the user's Key Vault containing the secret | string (required) |
OriginGroupOverride
| Name | Description | Value |
|---|---|---|
| forwardingProtocol | Protocol this rule will use when forwarding traffic to backends. | 'HttpOnly' 'HttpsOnly' 'MatchRequest' |
| originGroup | defines the OriginGroup that would override the DefaultOriginGroup on route. | ResourceReference |
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 |
|---|---|---|
| originGroup | defines the OriginGroup that would override the DefaultOriginGroup. | ResourceReference (required) |
| typeName | 'DeliveryRuleCacheExpirationActionParameters' 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' 'DeliveryRuleEdgeActionParameters' 'DeliveryRuleHeaderActionParameters' 'DeliveryRuleOriginGroupOverrideActionParameters' 'DeliveryRuleRouteConfigurationOverrideActionParameters' 'DeliveryRuleUrlRedirectActionParameters' 'DeliveryRuleUrlRewriteActionParameters' 'DeliveryRuleUrlSigningActionParameters' (required) |
PostArgsMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
QueryStringMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
RemoteAddressMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
RequestBodyMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
RequestHeaderMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
RequestMethodMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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) |
| transforms | List of transforms | String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
RequestSchemeMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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) |
| transforms | List of transforms | String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
RequestUriMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
ResourceReference
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
ResponseBasedOriginErrorDetectionParameters
| Name | Description | Value |
|---|---|---|
| httpErrorRanges | The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. | HttpErrorRangeParameters[] |
| responseBasedDetectedErrorTypes | Type of response errors for real user requests for which origin will be deemed unhealthy | 'None' 'TcpAndHttpErrors' 'TcpErrorsOnly' |
| responseBasedFailoverThresholdPercentage | The percentage of failed requests in the sample where failover should trigger. | int Constraints: Min value = 0 Max value = 100 |
RouteConfigurationOverrideActionParameters
| Name | Description | Value |
|---|---|---|
| cacheConfiguration | The caching configuration associated with this rule. To disable caching, do not provide a cacheConfiguration object. | CacheConfiguration |
| originGroupOverride | A reference to the origin group override configuration. Leave empty to use the default origin group on route. | OriginGroupOverride |
| typeName | 'DeliveryRuleCacheExpirationActionParameters' 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' 'DeliveryRuleEdgeActionParameters' 'DeliveryRuleHeaderActionParameters' 'DeliveryRuleOriginGroupOverrideActionParameters' 'DeliveryRuleRouteConfigurationOverrideActionParameters' 'DeliveryRuleUrlRedirectActionParameters' 'DeliveryRuleUrlRewriteActionParameters' 'DeliveryRuleUrlSigningActionParameters' (required) |
ServerPortMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
SocketAddrMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' 'IPMatch' (required) |
| transforms | List of transforms | String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
SslProtocolMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| matchValues | The match value for the condition of the delivery rule | String array containing any of: 'TLSv1' 'TLSv1.1' 'TLSv1.2' |
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
UrlFileExtensionMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
UrlFileNameMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
UrlPathMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
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 |
|---|---|---|
| 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) |
| typeName | 'DeliveryRuleCacheExpirationActionParameters' 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' 'DeliveryRuleEdgeActionParameters' 'DeliveryRuleHeaderActionParameters' 'DeliveryRuleOriginGroupOverrideActionParameters' 'DeliveryRuleRouteConfigurationOverrideActionParameters' 'DeliveryRuleUrlRedirectActionParameters' 'DeliveryRuleUrlRewriteActionParameters' 'DeliveryRuleUrlSigningActionParameters' (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 |
|---|---|---|
| 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) |
| typeName | 'DeliveryRuleCacheExpirationActionParameters' 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' 'DeliveryRuleEdgeActionParameters' 'DeliveryRuleHeaderActionParameters' 'DeliveryRuleOriginGroupOverrideActionParameters' 'DeliveryRuleRouteConfigurationOverrideActionParameters' 'DeliveryRuleUrlRedirectActionParameters' 'DeliveryRuleUrlRewriteActionParameters' 'DeliveryRuleUrlSigningActionParameters' (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 |
|---|---|---|
| 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[] |
| typeName | 'DeliveryRuleCacheExpirationActionParameters' 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' 'DeliveryRuleEdgeActionParameters' 'DeliveryRuleHeaderActionParameters' 'DeliveryRuleOriginGroupOverrideActionParameters' 'DeliveryRuleRouteConfigurationOverrideActionParameters' 'DeliveryRuleUrlRedirectActionParameters' 'DeliveryRuleUrlRewriteActionParameters' 'DeliveryRuleUrlSigningActionParameters' (required) |
UrlSigningKey
| Name | Description | Value |
|---|---|---|
| keyId | Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash. | string (required) |
| keySourceParameters | Defines the parameters for using customer key vault for Url Signing Key. | KeyVaultSigningKeyParameters (required) |
UrlSigningParamIdentifier
| Name | Description | Value |
|---|---|---|
| paramIndicator | Indicates the purpose of the parameter | 'Expires' 'KeyId' 'Signature' (required) |
| paramName | Parameter name | string (required) |
Usage Examples
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying this resource type.
| Bicep File | Description |
|---|---|
| Create a CDN Endpoint with cache override through Rules | This template creates a CDN Profile and a CDN Endpoint with a user specified origin and all of our most commonly used settings on CDN. This template also configures rules engine with a path based rule and overrides cache expiration. |
| Create a CDN Endpoint with response header addition | This template creates a CDN Profile and a CDN Endpoint with a user specified origin and all of our most commonly used settings on CDN. This template also configures rules engine with Remote address based match and adds corresponding response headers. |
| Create a CDN Endpoint with rewrite and redirect rules | This template creates a CDN Profile and a CDN Endpoint with a user specified origin and all of our most commonly used settings on CDN. This template also configures rules engine device based path rewrite and request scheme based redirect. |
| Create a CDN Endpoint with UrlSigning action | This template creates a CDN Profile and a CDN Endpoint with a user specified origin and all of our most commonly used settings on CDN. This template also configures rules engine UrlSigning action for default and override parameters. |
| Create a CDN Profile and a CDN Endpoint with custom origin | This template creates a CDN Profile and a CDN Endpoint with a user specified origin and all of our most commonly used settings on CDN. |
| Create a CDN Profile and a CDN Endpoint with parameters | This template creates a CDN Profile and a CDN Endpoint with parameterized configuration settings |
| Create a CDN Profile, a CDN Endpoint and a Web App | This template creates a CDN Profile and a CDN Endpoint with a Web App as the origin |
| Create a CDN Profile, Endpoint and a Storage Account | This template creates a CDN Profile and a CDN Endpoint with origin as a Storage Account. Note that user needs to create a public container in the Storage Account in order for CDN Endpoint to serve content from the Storage Account. |
ARM template resource definition
The profiles/endpoints resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Cdn/profiles/endpoints resource, add the following JSON to your template.
{
"type": "Microsoft.Cdn/profiles/endpoints",
"apiVersion": "2025-09-01-preview",
"name": "string",
"location": "string",
"properties": {
"contentTypesToCompress": [ "string" ],
"defaultOriginGroup": {
"id": "string"
},
"deliveryPolicy": {
"description": "string",
"rules": [
{
"actions": [ {
"name": "string"
// For remaining properties, see DeliveryRuleAction objects
} ],
"conditions": [ {
"name": "string"
// For remaining properties, see DeliveryRuleCondition objects
} ],
"name": "string",
"order": "int"
}
]
},
"geoFilters": [
{
"action": "string",
"countryCodes": [ "string" ],
"relativePath": "string"
}
],
"isCompressionEnabled": "bool",
"isHttpAllowed": "bool",
"isHttpsAllowed": "bool",
"optimizationType": "string",
"originGroups": [
{
"name": "string",
"properties": {
"healthProbeSettings": {
"probeIntervalInSeconds": "int",
"probePath": "string",
"probeProtocol": "string",
"probeRequestType": "string"
},
"origins": [
{
"id": "string"
}
],
"responseBasedOriginErrorDetectionSettings": {
"httpErrorRanges": [
{
"begin": "int",
"end": "int"
}
],
"responseBasedDetectedErrorTypes": "string",
"responseBasedFailoverThresholdPercentage": "int"
},
"trafficRestorationTimeToHealedOrNewEndpointsInMinutes": "int"
}
}
],
"originHostHeader": "string",
"originPath": "string",
"origins": [
{
"name": "string",
"properties": {
"enabled": "bool",
"hostName": "string",
"httpPort": "int",
"httpsPort": "int",
"originHostHeader": "string",
"priority": "int",
"privateLinkAlias": "string",
"privateLinkApprovalMessage": "string",
"privateLinkLocation": "string",
"privateLinkResourceId": "string",
"weight": "int"
}
}
],
"probePath": "string",
"queryStringCachingBehavior": "string",
"urlSigningKeys": [
{
"keyId": "string",
"keySourceParameters": {
"resourceGroupName": "string",
"secretName": "string",
"secretVersion": "string",
"subscriptionId": "string",
"typeName": "string",
"vaultName": "string"
}
}
],
"webApplicationFirewallPolicyLink": {
"id": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
DeliveryRuleAction objects
Set the name property to specify the type of object.
For AfdUrlSigning, use:
{
"name": "AfdUrlSigning",
"parameters": {
"algorithm": "string",
"keyGroupReference": {
"id": "string"
},
"parameterNameOverride": [
{
"paramIndicator": "string",
"paramName": "string"
}
],
"typeName": "string"
}
}
For CacheExpiration, use:
{
"name": "CacheExpiration",
"parameters": {
"cacheBehavior": "string",
"cacheDuration": "string",
"cacheType": "string",
"typeName": "string"
}
}
For CacheKeyQueryString, use:
{
"name": "CacheKeyQueryString",
"parameters": {
"queryParameters": "string",
"queryStringBehavior": "string",
"typeName": "string"
}
}
For EdgeAction, use:
{
"name": "EdgeAction",
"parameters": {
"edgeActionReference": {
"id": "string"
},
"invocationPoint": "string",
"typeName": "string"
}
}
For ModifyRequestHeader, use:
{
"name": "ModifyRequestHeader",
"parameters": {
"headerAction": "string",
"headerName": "string",
"typeName": "string",
"value": "string"
}
}
For ModifyResponseHeader, use:
{
"name": "ModifyResponseHeader",
"parameters": {
"headerAction": "string",
"headerName": "string",
"typeName": "string",
"value": "string"
}
}
For OriginGroupOverride, use:
{
"name": "OriginGroupOverride",
"parameters": {
"originGroup": {
"id": "string"
},
"typeName": "string"
}
}
For RouteConfigurationOverride, use:
{
"name": "RouteConfigurationOverride",
"parameters": {
"cacheConfiguration": {
"cacheBehavior": "string",
"cacheDuration": "string",
"isCompressionEnabled": "string",
"queryParameters": "string",
"queryStringCachingBehavior": "string"
},
"originGroupOverride": {
"forwardingProtocol": "string",
"originGroup": {
"id": "string"
}
},
"typeName": "string"
}
}
For UrlRedirect, use:
{
"name": "UrlRedirect",
"parameters": {
"customFragment": "string",
"customHostname": "string",
"customPath": "string",
"customQueryString": "string",
"destinationProtocol": "string",
"redirectType": "string",
"typeName": "string"
}
}
For UrlRewrite, use:
{
"name": "UrlRewrite",
"parameters": {
"destination": "string",
"preserveUnmatchedPath": "bool",
"sourcePattern": "string",
"typeName": "string"
}
}
For UrlSigning, use:
{
"name": "UrlSigning",
"parameters": {
"algorithm": "string",
"parameterNameOverride": [
{
"paramIndicator": "string",
"paramName": "string"
}
],
"typeName": "string"
}
}
DeliveryRuleCondition objects
Set the name property to specify the type of object.
For ClientPort, use:
{
"name": "ClientPort",
"parameters": {
"matchValues": [ "string" ],
"negateCondition": "bool",
"operator": "string",
"transforms": [ "string" ],
"typeName": "string"
}
}
For Cookies, use:
{
"name": "Cookies",
"parameters": {
"matchValues": [ "string" ],
"negateCondition": "bool",
"operator": "string",
"selector": "string",
"transforms": [ "string" ],
"typeName": "string"
}
}
For HostName, use:
{
"name": "HostName",
"parameters": {
"matchValues": [ "string" ],
"negateCondition": "bool",
"operator": "string",
"transforms": [ "string" ],
"typeName": "string"
}
}
For HttpVersion, use:
{
"name": "HttpVersion",
"parameters": {
"matchValues": [ "string" ],
"negateCondition": "bool",
"operator": "string",
"transforms": [ "string" ],
"typeName": "string"
}
}
For IsDevice, use:
{
"name": "IsDevice",
"parameters": {
"matchValues": [ "string" ],
"negateCondition": "bool",
"operator": "string",
"transforms": [ "string" ],
"typeName": "string"
}
}
For PostArgs, use:
{
"name": "PostArgs",
"parameters": {
"matchValues": [ "string" ],
"negateCondition": "bool",
"operator": "string",
"selector": "string",
"transforms": [ "string" ],
"typeName": "string"
}
}
For QueryString, use:
{
"name": "QueryString",
"parameters": {
"matchValues": [ "string" ],
"negateCondition": "bool",
"operator": "string",
"transforms": [ "string" ],
"typeName": "string"
}
}
For RemoteAddress, use:
{
"name": "RemoteAddress",
"parameters": {
"matchValues": [ "string" ],
"negateCondition": "bool",
"operator": "string",
"transforms": [ "string" ],
"typeName": "string"
}
}
For RequestBody, use:
{
"name": "RequestBody",
"parameters": {
"matchValues": [ "string" ],
"negateCondition": "bool",
"operator": "string",
"transforms": [ "string" ],
"typeName": "string"
}
}
For RequestHeader, use:
{
"name": "RequestHeader",
"parameters": {
"matchValues": [ "string" ],
"negateCondition": "bool",
"operator": "string",
"selector": "string",
"transforms": [ "string" ],
"typeName": "string"
}
}
For RequestMethod, use:
{
"name": "RequestMethod",
"parameters": {
"matchValues": [ "string" ],
"negateCondition": "bool",
"operator": "string",
"transforms": [ "string" ],
"typeName": "string"
}
}
For RequestScheme, use:
{
"name": "RequestScheme",
"parameters": {
"matchValues": [ "string" ],
"negateCondition": "bool",
"operator": "string",
"transforms": [ "string" ],
"typeName": "string"
}
}
For RequestUri, use:
{
"name": "RequestUri",
"parameters": {
"matchValues": [ "string" ],
"negateCondition": "bool",
"operator": "string",
"transforms": [ "string" ],
"typeName": "string"
}
}
For ServerPort, use:
{
"name": "ServerPort",
"parameters": {
"matchValues": [ "string" ],
"negateCondition": "bool",
"operator": "string",
"transforms": [ "string" ],
"typeName": "string"
}
}
For SocketAddr, use:
{
"name": "SocketAddr",
"parameters": {
"matchValues": [ "string" ],
"negateCondition": "bool",
"operator": "string",
"transforms": [ "string" ],
"typeName": "string"
}
}
For SslProtocol, use:
{
"name": "SslProtocol",
"parameters": {
"matchValues": [ "string" ],
"negateCondition": "bool",
"operator": "string",
"transforms": [ "string" ],
"typeName": "string"
}
}
For UrlFileExtension, use:
{
"name": "UrlFileExtension",
"parameters": {
"matchValues": [ "string" ],
"negateCondition": "bool",
"operator": "string",
"transforms": [ "string" ],
"typeName": "string"
}
}
For UrlFileName, use:
{
"name": "UrlFileName",
"parameters": {
"matchValues": [ "string" ],
"negateCondition": "bool",
"operator": "string",
"transforms": [ "string" ],
"typeName": "string"
}
}
For UrlPath, use:
{
"name": "UrlPath",
"parameters": {
"matchValues": [ "string" ],
"negateCondition": "bool",
"operator": "string",
"transforms": [ "string" ],
"typeName": "string"
}
}
Property Values
Microsoft.Cdn/profiles/endpoints
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2025-09-01-preview' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| properties | The JSON object that contains the properties required to create an endpoint. | EndpointProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Cdn/profiles/endpoints' |
AfdUrlSigningAction
| Name | Description | Value |
|---|---|---|
| name | The name of the action for the delivery rule. | 'AfdUrlSigning' (required) |
| parameters | Defines the parameters for the action. | AfdUrlSigningActionParameters (required) |
AfdUrlSigningActionParameters
| Name | Description | Value |
|---|---|---|
| algorithm | Algorithm to use for URL signing | 'SHA256' |
| keyGroupReference | Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/keyGroups/{keyGroupName} | ResourceReference (required) |
| parameterNameOverride | Defines which query string parameters in the url to be considered for expires, key id etc. | UrlSigningParamIdentifier[] |
| typeName | 'DeliveryRuleAfdUrlSigningActionParameters' (required) |
CacheConfiguration
| Name | Description | Value |
|---|---|---|
| cacheBehavior | Caching behavior for the requests | 'HonorOrigin' 'OverrideAlways' 'OverrideIfOriginMissing' |
| cacheDuration | The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss | string |
| isCompressionEnabled | Indicates whether content compression is enabled. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB. | 'Disabled' 'Enabled' |
| queryParameters | query parameters to include or exclude (comma separated). | string |
| queryStringCachingBehavior | Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings. | 'IgnoreQueryString' 'IgnoreSpecifiedQueryStrings' 'IncludeSpecifiedQueryStrings' 'UseQueryString' |
CacheExpirationActionParameters
| Name | Description | Value |
|---|---|---|
| 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) |
| typeName | 'DeliveryRuleCacheExpirationActionParameters' 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' 'DeliveryRuleEdgeActionParameters' 'DeliveryRuleHeaderActionParameters' 'DeliveryRuleOriginGroupOverrideActionParameters' 'DeliveryRuleRouteConfigurationOverrideActionParameters' 'DeliveryRuleUrlRedirectActionParameters' 'DeliveryRuleUrlRewriteActionParameters' 'DeliveryRuleUrlSigningActionParameters' (required) |
CacheKeyQueryStringActionParameters
| Name | Description | Value |
|---|---|---|
| queryParameters | query parameters to include or exclude (comma separated). | string |
| queryStringBehavior | Caching behavior for the requests | 'Exclude' 'ExcludeAll' 'Include' 'IncludeAll' (required) |
| typeName | 'DeliveryRuleCacheExpirationActionParameters' 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' 'DeliveryRuleEdgeActionParameters' 'DeliveryRuleHeaderActionParameters' 'DeliveryRuleOriginGroupOverrideActionParameters' 'DeliveryRuleRouteConfigurationOverrideActionParameters' 'DeliveryRuleUrlRedirectActionParameters' 'DeliveryRuleUrlRewriteActionParameters' 'DeliveryRuleUrlSigningActionParameters' (required) |
ClientPortMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
CookiesMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
DeepCreatedOrigin
| Name | Description | Value |
|---|---|---|
| name | Origin name which must be unique within the endpoint. | string (required) |
| properties | Properties of the origin created on the CDN endpoint. | DeepCreatedOriginProperties |
DeepCreatedOriginGroup
| Name | Description | Value |
|---|---|---|
| name | Origin group name which must be unique within the endpoint. | string (required) |
| properties | Properties of the origin group created on the CDN endpoint. | DeepCreatedOriginGroupProperties |
DeepCreatedOriginGroupProperties
| Name | Description | Value |
|---|---|---|
| healthProbeSettings | Health probe settings to the origin that is used to determine the health of the origin. | HealthProbeParameters |
| origins | The source of the content being delivered via CDN within given origin group. | ResourceReference[] (required) |
| responseBasedOriginErrorDetectionSettings | The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported. | ResponseBasedOriginErrorDetectionParameters |
| trafficRestorationTimeToHealedOrNewEndpointsInMinutes | Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. | int Constraints: Max value = 50 |
DeepCreatedOriginProperties
| Name | Description | Value |
|---|---|---|
| enabled | Origin is enabled for load balancing or not. By default, origin is always enabled. | bool |
| hostName | The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. | string (required) |
| httpPort | The value of the HTTP port. Must be between 1 and 65535. | int Constraints: Min value = 1 Max value = 65535 |
| httpsPort | The value of the HTTPS port. Must be between 1 and 65535. | int Constraints: Min value = 1 Max value = 65535 |
| originHostHeader | The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. | string |
| priority | Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. | int Constraints: Min value = 1 Max value = 5 |
| privateLinkAlias | The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' | string |
| privateLinkApprovalMessage | A custom message to be included in the approval request to connect to the Private Link. | string |
| privateLinkLocation | The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated | string |
| privateLinkResourceId | The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' | string |
| weight | Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 | int Constraints: Min value = 1 Max value = 1000 |
DeliveryRule
| Name | Description | Value |
|---|---|---|
| actions | A list of actions that are executed when all the conditions of a rule are satisfied. | DeliveryRuleAction[] (required) |
| conditions | A list of conditions that must be matched for the actions to be executed | DeliveryRuleCondition[] |
| name | Name of the rule | string |
| 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 (required) |
DeliveryRuleAction
| Name | Description | Value |
|---|---|---|
| name | Set to 'AfdUrlSigning' for type AfdUrlSigningAction. Set to 'CacheExpiration' for type DeliveryRuleCacheExpirationAction. Set to 'CacheKeyQueryString' for type DeliveryRuleCacheKeyQueryStringAction. Set to 'EdgeAction' for type EdgeAction. Set to 'ModifyRequestHeader' for type DeliveryRuleRequestHeaderAction. Set to 'ModifyResponseHeader' for type DeliveryRuleResponseHeaderAction. Set to 'OriginGroupOverride' for type OriginGroupOverrideAction. Set to 'RouteConfigurationOverride' for type DeliveryRuleRouteConfigurationOverrideAction. Set to 'UrlRedirect' for type UrlRedirectAction. Set to 'UrlRewrite' for type UrlRewriteAction. Set to 'UrlSigning' for type UrlSigningAction. | 'AfdUrlSigning' 'CacheExpiration' 'CacheKeyQueryString' 'EdgeAction' 'ModifyRequestHeader' 'ModifyResponseHeader' 'OriginGroupOverride' 'RouteConfigurationOverride' '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) |
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) |
DeliveryRuleClientPortCondition
| Name | Description | Value |
|---|---|---|
| name | The name of the condition for the delivery rule. | 'ClientPort' (required) |
| parameters | Defines the parameters for the condition. | ClientPortMatchConditionParameters (required) |
DeliveryRuleCondition
| Name | Description | Value |
|---|---|---|
| name | Set to 'ClientPort' for type DeliveryRuleClientPortCondition. Set to 'Cookies' for type DeliveryRuleCookiesCondition. Set to 'HostName' for type DeliveryRuleHostNameCondition. Set to 'HttpVersion' for type DeliveryRuleHttpVersionCondition. Set to 'IsDevice' for type DeliveryRuleIsDeviceCondition. Set to 'PostArgs' for type DeliveryRulePostArgsCondition. Set to 'QueryString' for type DeliveryRuleQueryStringCondition. Set to 'RemoteAddress' for type DeliveryRuleRemoteAddressCondition. Set to 'RequestBody' for type DeliveryRuleRequestBodyCondition. Set to 'RequestHeader' for type DeliveryRuleRequestHeaderCondition. Set to 'RequestMethod' for type DeliveryRuleRequestMethodCondition. Set to 'RequestScheme' for type DeliveryRuleRequestSchemeCondition. Set to 'RequestUri' for type DeliveryRuleRequestUriCondition. Set to 'ServerPort' for type DeliveryRuleServerPortCondition. Set to 'SocketAddr' for type DeliveryRuleSocketAddrCondition. Set to 'SslProtocol' for type DeliveryRuleSslProtocolCondition. Set to 'UrlFileExtension' for type DeliveryRuleUrlFileExtensionCondition. Set to 'UrlFileName' for type DeliveryRuleUrlFileNameCondition. Set to 'UrlPath' for type DeliveryRuleUrlPathCondition. | 'ClientPort' 'Cookies' 'HostName' 'HttpVersion' 'IsDevice' 'PostArgs' 'QueryString' 'RemoteAddress' 'RequestBody' 'RequestHeader' 'RequestMethod' 'RequestScheme' 'RequestUri' 'ServerPort' 'SocketAddr' 'SslProtocol' '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) |
DeliveryRuleEdgeActionParameters
| Name | Description | Value |
|---|---|---|
| edgeActionReference | defines the edge action that will be invoked. | ResourceReference (required) |
| invocationPoint | Defines at which point in the request processing pipeline the edge action will be invoked. | 'ClientRequest' 'OriginRequest' (required) |
| typeName | 'DeliveryRuleCacheExpirationActionParameters' 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' 'DeliveryRuleEdgeActionParameters' 'DeliveryRuleHeaderActionParameters' 'DeliveryRuleOriginGroupOverrideActionParameters' 'DeliveryRuleRouteConfigurationOverrideActionParameters' 'DeliveryRuleUrlRedirectActionParameters' 'DeliveryRuleUrlRewriteActionParameters' 'DeliveryRuleUrlSigningActionParameters' (required) |
DeliveryRuleHostNameCondition
| Name | Description | Value |
|---|---|---|
| name | The name of the condition for the delivery rule. | 'HostName' (required) |
| parameters | Defines the parameters for the condition. | HostNameMatchConditionParameters (required) |
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) |
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) |
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) |
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) |
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) |
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) |
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) |
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) |
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) |
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) |
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) |
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) |
DeliveryRuleRouteConfigurationOverrideAction
| Name | Description | Value |
|---|---|---|
| name | The name of the action for the delivery rule. | 'RouteConfigurationOverride' (required) |
| parameters | Defines the parameters for the action. | RouteConfigurationOverrideActionParameters (required) |
DeliveryRuleServerPortCondition
| Name | Description | Value |
|---|---|---|
| name | The name of the condition for the delivery rule. | 'ServerPort' (required) |
| parameters | Defines the parameters for the condition. | ServerPortMatchConditionParameters (required) |
DeliveryRuleSocketAddrCondition
| Name | Description | Value |
|---|---|---|
| name | The name of the condition for the delivery rule. | 'SocketAddr' (required) |
| parameters | Defines the parameters for the condition. | SocketAddrMatchConditionParameters (required) |
DeliveryRuleSslProtocolCondition
| Name | Description | Value |
|---|---|---|
| name | The name of the condition for the delivery rule. | 'SslProtocol' (required) |
| parameters | Defines the parameters for the condition. | SslProtocolMatchConditionParameters (required) |
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) |
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) |
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) |
EdgeAction
| Name | Description | Value |
|---|---|---|
| name | The name of the action for the delivery rule. | 'EdgeAction' (required) |
| parameters | Defines the parameters for the action. | DeliveryRuleEdgeActionParameters (required) |
EndpointProperties
| Name | Description | Value |
|---|---|---|
| contentTypesToCompress | List of content types on which compression applies. The value should be a valid MIME type. | string[] |
| defaultOriginGroup | A reference to the origin group. | ResourceReference |
| deliveryPolicy | A policy that specifies the delivery rules to be used for an endpoint. | EndpointPropertiesUpdateParametersDeliveryPolicy |
| geoFilters | List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/ | GeoFilter[] |
| isCompressionEnabled | Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB. | bool |
| isHttpAllowed | Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. | bool |
| isHttpsAllowed | Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. | bool |
| optimizationType | Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. Download, Media services. With this information, CDN can apply scenario driven optimization. | 'DynamicSiteAcceleration' 'GeneralMediaStreaming' 'GeneralWebDelivery' 'LargeFileDownload' 'VideoOnDemandMediaStreaming' |
| originGroups | The origin groups comprising of origins that are used for load balancing the traffic based on availability. | DeepCreatedOriginGroup[] |
| originHostHeader | The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. | string |
| originPath | A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. | string |
| origins | The source of the content being delivered via CDN. | DeepCreatedOrigin[] (required) |
| probePath | Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin. | string |
| queryStringCachingBehavior | Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. | 'BypassCaching' 'IgnoreQueryString' 'NotSet' 'UseQueryString' |
| urlSigningKeys | List of keys used to validate the signed URL hashes. | UrlSigningKey[] |
| webApplicationFirewallPolicyLink | Defines the Web Application Firewall policy for the endpoint (if applicable) | EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink |
EndpointPropertiesUpdateParametersDeliveryPolicy
| Name | Description | Value |
|---|---|---|
| description | User-friendly description of the policy. | string |
| rules | A list of the delivery rules. | DeliveryRule[] (required) |
EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
GeoFilter
| Name | Description | Value |
|---|---|---|
| action | Action of the geo filter, i.e. allow or block access. | 'Allow' 'Block' (required) |
| countryCodes | Two letter country or region codes defining user country or region access in a geo filter, e.g. AU, MX, US. | string[] (required) |
| relativePath | Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.) | string (required) |
HeaderActionParameters
| Name | Description | Value |
|---|---|---|
| headerAction | Action to perform | 'Append' 'Delete' 'Overwrite' (required) |
| headerName | Name of the header to modify | string (required) |
| typeName | 'DeliveryRuleCacheExpirationActionParameters' 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' 'DeliveryRuleEdgeActionParameters' 'DeliveryRuleHeaderActionParameters' 'DeliveryRuleOriginGroupOverrideActionParameters' 'DeliveryRuleRouteConfigurationOverrideActionParameters' 'DeliveryRuleUrlRedirectActionParameters' 'DeliveryRuleUrlRewriteActionParameters' 'DeliveryRuleUrlSigningActionParameters' (required) |
|
| value | Value for the specified action | string |
HealthProbeParameters
| Name | Description | Value |
|---|---|---|
| probeIntervalInSeconds | The number of seconds between health probes.Default is 240sec. | int Constraints: Min value = 1 Max value = 255 |
| probePath | The path relative to the origin that is used to determine the health of the origin. | string |
| probeProtocol | Protocol to use for health probe. | 'Grpc' 'Http' 'Https' 'NotSet' |
| probeRequestType | The type of health probe request that is made. | 'GET' 'HEAD' 'NotSet' |
HostNameMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
HttpErrorRangeParameters
| Name | Description | Value |
|---|---|---|
| begin | The inclusive start of the http status code range. | int Constraints: Min value = 100 Max value = 999 |
| end | The inclusive end of the http status code range. | int Constraints: Min value = 100 Max value = 999 |
HttpVersionMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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) |
| transforms | List of transforms | String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
IsDeviceMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
KeyVaultSigningKeyParameters
| Name | Description | Value |
|---|---|---|
| resourceGroupName | Resource group of the user's Key Vault containing the secret | string (required) |
| secretName | The name of secret in Key Vault. | string (required) |
| secretVersion | The version(GUID) of secret in Key Vault. | string (required) |
| subscriptionId | Subscription Id of the user's Key Vault containing the secret | string (required) |
| typeName | 'KeyVaultSigningKeyParameters' (required) | |
| vaultName | The name of the user's Key Vault containing the secret | string (required) |
OriginGroupOverride
| Name | Description | Value |
|---|---|---|
| forwardingProtocol | Protocol this rule will use when forwarding traffic to backends. | 'HttpOnly' 'HttpsOnly' 'MatchRequest' |
| originGroup | defines the OriginGroup that would override the DefaultOriginGroup on route. | ResourceReference |
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 |
|---|---|---|
| originGroup | defines the OriginGroup that would override the DefaultOriginGroup. | ResourceReference (required) |
| typeName | 'DeliveryRuleCacheExpirationActionParameters' 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' 'DeliveryRuleEdgeActionParameters' 'DeliveryRuleHeaderActionParameters' 'DeliveryRuleOriginGroupOverrideActionParameters' 'DeliveryRuleRouteConfigurationOverrideActionParameters' 'DeliveryRuleUrlRedirectActionParameters' 'DeliveryRuleUrlRewriteActionParameters' 'DeliveryRuleUrlSigningActionParameters' (required) |
PostArgsMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
QueryStringMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
RemoteAddressMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
RequestBodyMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
RequestHeaderMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
RequestMethodMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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) |
| transforms | List of transforms | String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
RequestSchemeMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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) |
| transforms | List of transforms | String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
RequestUriMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
ResourceReference
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
ResponseBasedOriginErrorDetectionParameters
| Name | Description | Value |
|---|---|---|
| httpErrorRanges | The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. | HttpErrorRangeParameters[] |
| responseBasedDetectedErrorTypes | Type of response errors for real user requests for which origin will be deemed unhealthy | 'None' 'TcpAndHttpErrors' 'TcpErrorsOnly' |
| responseBasedFailoverThresholdPercentage | The percentage of failed requests in the sample where failover should trigger. | int Constraints: Min value = 0 Max value = 100 |
RouteConfigurationOverrideActionParameters
| Name | Description | Value |
|---|---|---|
| cacheConfiguration | The caching configuration associated with this rule. To disable caching, do not provide a cacheConfiguration object. | CacheConfiguration |
| originGroupOverride | A reference to the origin group override configuration. Leave empty to use the default origin group on route. | OriginGroupOverride |
| typeName | 'DeliveryRuleCacheExpirationActionParameters' 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' 'DeliveryRuleEdgeActionParameters' 'DeliveryRuleHeaderActionParameters' 'DeliveryRuleOriginGroupOverrideActionParameters' 'DeliveryRuleRouteConfigurationOverrideActionParameters' 'DeliveryRuleUrlRedirectActionParameters' 'DeliveryRuleUrlRewriteActionParameters' 'DeliveryRuleUrlSigningActionParameters' (required) |
ServerPortMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
SocketAddrMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' 'IPMatch' (required) |
| transforms | List of transforms | String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
SslProtocolMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| matchValues | The match value for the condition of the delivery rule | String array containing any of: 'TLSv1' 'TLSv1.1' 'TLSv1.2' |
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
UrlFileExtensionMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
UrlFileNameMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
UrlPathMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
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 |
|---|---|---|
| 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) |
| typeName | 'DeliveryRuleCacheExpirationActionParameters' 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' 'DeliveryRuleEdgeActionParameters' 'DeliveryRuleHeaderActionParameters' 'DeliveryRuleOriginGroupOverrideActionParameters' 'DeliveryRuleRouteConfigurationOverrideActionParameters' 'DeliveryRuleUrlRedirectActionParameters' 'DeliveryRuleUrlRewriteActionParameters' 'DeliveryRuleUrlSigningActionParameters' (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 |
|---|---|---|
| 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) |
| typeName | 'DeliveryRuleCacheExpirationActionParameters' 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' 'DeliveryRuleEdgeActionParameters' 'DeliveryRuleHeaderActionParameters' 'DeliveryRuleOriginGroupOverrideActionParameters' 'DeliveryRuleRouteConfigurationOverrideActionParameters' 'DeliveryRuleUrlRedirectActionParameters' 'DeliveryRuleUrlRewriteActionParameters' 'DeliveryRuleUrlSigningActionParameters' (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 |
|---|---|---|
| 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[] |
| typeName | 'DeliveryRuleCacheExpirationActionParameters' 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' 'DeliveryRuleEdgeActionParameters' 'DeliveryRuleHeaderActionParameters' 'DeliveryRuleOriginGroupOverrideActionParameters' 'DeliveryRuleRouteConfigurationOverrideActionParameters' 'DeliveryRuleUrlRedirectActionParameters' 'DeliveryRuleUrlRewriteActionParameters' 'DeliveryRuleUrlSigningActionParameters' (required) |
UrlSigningKey
| Name | Description | Value |
|---|---|---|
| keyId | Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash. | string (required) |
| keySourceParameters | Defines the parameters for using customer key vault for Url Signing Key. | KeyVaultSigningKeyParameters (required) |
UrlSigningParamIdentifier
| Name | Description | Value |
|---|---|---|
| paramIndicator | Indicates the purpose of the parameter | 'Expires' 'KeyId' 'Signature' (required) |
| paramName | Parameter name | string (required) |
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| Create a CDN Endpoint with cache override through Rules |
This template creates a CDN Profile and a CDN Endpoint with a user specified origin and all of our most commonly used settings on CDN. This template also configures rules engine with a path based rule and overrides cache expiration. |
| Create a CDN Endpoint with response header addition |
This template creates a CDN Profile and a CDN Endpoint with a user specified origin and all of our most commonly used settings on CDN. This template also configures rules engine with Remote address based match and adds corresponding response headers. |
| Create a CDN Endpoint with rewrite and redirect rules |
This template creates a CDN Profile and a CDN Endpoint with a user specified origin and all of our most commonly used settings on CDN. This template also configures rules engine device based path rewrite and request scheme based redirect. |
| Create a CDN Endpoint with UrlSigning action |
This template creates a CDN Profile and a CDN Endpoint with a user specified origin and all of our most commonly used settings on CDN. This template also configures rules engine UrlSigning action for default and override parameters. |
| Create a CDN Profile and a CDN Endpoint with custom origin |
This template creates a CDN Profile and a CDN Endpoint with a user specified origin and all of our most commonly used settings on CDN. |
| Create a CDN Profile and a CDN Endpoint with parameters |
This template creates a CDN Profile and a CDN Endpoint with parameterized configuration settings |
| Create a CDN Profile, a CDN Endpoint and a Web App |
This template creates a CDN Profile and a CDN Endpoint with a Web App as the origin |
| Create a CDN Profile, Endpoint and a Storage Account |
This template creates a CDN Profile and a CDN Endpoint with origin as a Storage Account. Note that user needs to create a public container in the Storage Account in order for CDN Endpoint to serve content from the Storage Account. |
Terraform (AzAPI provider) resource definition
The profiles/endpoints resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Cdn/profiles/endpoints resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Cdn/profiles/endpoints@2025-09-01-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
contentTypesToCompress = [
"string"
]
defaultOriginGroup = {
id = "string"
}
deliveryPolicy = {
description = "string"
rules = [
{
actions = [
{
name = "string"
// For remaining properties, see DeliveryRuleAction objects
}
]
conditions = [
{
name = "string"
// For remaining properties, see DeliveryRuleCondition objects
}
]
name = "string"
order = int
}
]
}
geoFilters = [
{
action = "string"
countryCodes = [
"string"
]
relativePath = "string"
}
]
isCompressionEnabled = bool
isHttpAllowed = bool
isHttpsAllowed = bool
optimizationType = "string"
originGroups = [
{
name = "string"
properties = {
healthProbeSettings = {
probeIntervalInSeconds = int
probePath = "string"
probeProtocol = "string"
probeRequestType = "string"
}
origins = [
{
id = "string"
}
]
responseBasedOriginErrorDetectionSettings = {
httpErrorRanges = [
{
begin = int
end = int
}
]
responseBasedDetectedErrorTypes = "string"
responseBasedFailoverThresholdPercentage = int
}
trafficRestorationTimeToHealedOrNewEndpointsInMinutes = int
}
}
]
originHostHeader = "string"
originPath = "string"
origins = [
{
name = "string"
properties = {
enabled = bool
hostName = "string"
httpPort = int
httpsPort = int
originHostHeader = "string"
priority = int
privateLinkAlias = "string"
privateLinkApprovalMessage = "string"
privateLinkLocation = "string"
privateLinkResourceId = "string"
weight = int
}
}
]
probePath = "string"
queryStringCachingBehavior = "string"
urlSigningKeys = [
{
keyId = "string"
keySourceParameters = {
resourceGroupName = "string"
secretName = "string"
secretVersion = "string"
subscriptionId = "string"
typeName = "string"
vaultName = "string"
}
}
]
webApplicationFirewallPolicyLink = {
id = "string"
}
}
}
}
DeliveryRuleAction objects
Set the name property to specify the type of object.
For AfdUrlSigning, use:
{
name = "AfdUrlSigning"
parameters = {
algorithm = "string"
keyGroupReference = {
id = "string"
}
parameterNameOverride = [
{
paramIndicator = "string"
paramName = "string"
}
]
typeName = "string"
}
}
For CacheExpiration, use:
{
name = "CacheExpiration"
parameters = {
cacheBehavior = "string"
cacheDuration = "string"
cacheType = "string"
typeName = "string"
}
}
For CacheKeyQueryString, use:
{
name = "CacheKeyQueryString"
parameters = {
queryParameters = "string"
queryStringBehavior = "string"
typeName = "string"
}
}
For EdgeAction, use:
{
name = "EdgeAction"
parameters = {
edgeActionReference = {
id = "string"
}
invocationPoint = "string"
typeName = "string"
}
}
For ModifyRequestHeader, use:
{
name = "ModifyRequestHeader"
parameters = {
headerAction = "string"
headerName = "string"
typeName = "string"
value = "string"
}
}
For ModifyResponseHeader, use:
{
name = "ModifyResponseHeader"
parameters = {
headerAction = "string"
headerName = "string"
typeName = "string"
value = "string"
}
}
For OriginGroupOverride, use:
{
name = "OriginGroupOverride"
parameters = {
originGroup = {
id = "string"
}
typeName = "string"
}
}
For RouteConfigurationOverride, use:
{
name = "RouteConfigurationOverride"
parameters = {
cacheConfiguration = {
cacheBehavior = "string"
cacheDuration = "string"
isCompressionEnabled = "string"
queryParameters = "string"
queryStringCachingBehavior = "string"
}
originGroupOverride = {
forwardingProtocol = "string"
originGroup = {
id = "string"
}
}
typeName = "string"
}
}
For UrlRedirect, use:
{
name = "UrlRedirect"
parameters = {
customFragment = "string"
customHostname = "string"
customPath = "string"
customQueryString = "string"
destinationProtocol = "string"
redirectType = "string"
typeName = "string"
}
}
For UrlRewrite, use:
{
name = "UrlRewrite"
parameters = {
destination = "string"
preserveUnmatchedPath = bool
sourcePattern = "string"
typeName = "string"
}
}
For UrlSigning, use:
{
name = "UrlSigning"
parameters = {
algorithm = "string"
parameterNameOverride = [
{
paramIndicator = "string"
paramName = "string"
}
]
typeName = "string"
}
}
DeliveryRuleCondition objects
Set the name property to specify the type of object.
For ClientPort, use:
{
name = "ClientPort"
parameters = {
matchValues = [
"string"
]
negateCondition = bool
operator = "string"
transforms = [
"string"
]
typeName = "string"
}
}
For Cookies, use:
{
name = "Cookies"
parameters = {
matchValues = [
"string"
]
negateCondition = bool
operator = "string"
selector = "string"
transforms = [
"string"
]
typeName = "string"
}
}
For HostName, use:
{
name = "HostName"
parameters = {
matchValues = [
"string"
]
negateCondition = bool
operator = "string"
transforms = [
"string"
]
typeName = "string"
}
}
For HttpVersion, use:
{
name = "HttpVersion"
parameters = {
matchValues = [
"string"
]
negateCondition = bool
operator = "string"
transforms = [
"string"
]
typeName = "string"
}
}
For IsDevice, use:
{
name = "IsDevice"
parameters = {
matchValues = [
"string"
]
negateCondition = bool
operator = "string"
transforms = [
"string"
]
typeName = "string"
}
}
For PostArgs, use:
{
name = "PostArgs"
parameters = {
matchValues = [
"string"
]
negateCondition = bool
operator = "string"
selector = "string"
transforms = [
"string"
]
typeName = "string"
}
}
For QueryString, use:
{
name = "QueryString"
parameters = {
matchValues = [
"string"
]
negateCondition = bool
operator = "string"
transforms = [
"string"
]
typeName = "string"
}
}
For RemoteAddress, use:
{
name = "RemoteAddress"
parameters = {
matchValues = [
"string"
]
negateCondition = bool
operator = "string"
transforms = [
"string"
]
typeName = "string"
}
}
For RequestBody, use:
{
name = "RequestBody"
parameters = {
matchValues = [
"string"
]
negateCondition = bool
operator = "string"
transforms = [
"string"
]
typeName = "string"
}
}
For RequestHeader, use:
{
name = "RequestHeader"
parameters = {
matchValues = [
"string"
]
negateCondition = bool
operator = "string"
selector = "string"
transforms = [
"string"
]
typeName = "string"
}
}
For RequestMethod, use:
{
name = "RequestMethod"
parameters = {
matchValues = [
"string"
]
negateCondition = bool
operator = "string"
transforms = [
"string"
]
typeName = "string"
}
}
For RequestScheme, use:
{
name = "RequestScheme"
parameters = {
matchValues = [
"string"
]
negateCondition = bool
operator = "string"
transforms = [
"string"
]
typeName = "string"
}
}
For RequestUri, use:
{
name = "RequestUri"
parameters = {
matchValues = [
"string"
]
negateCondition = bool
operator = "string"
transforms = [
"string"
]
typeName = "string"
}
}
For ServerPort, use:
{
name = "ServerPort"
parameters = {
matchValues = [
"string"
]
negateCondition = bool
operator = "string"
transforms = [
"string"
]
typeName = "string"
}
}
For SocketAddr, use:
{
name = "SocketAddr"
parameters = {
matchValues = [
"string"
]
negateCondition = bool
operator = "string"
transforms = [
"string"
]
typeName = "string"
}
}
For SslProtocol, use:
{
name = "SslProtocol"
parameters = {
matchValues = [
"string"
]
negateCondition = bool
operator = "string"
transforms = [
"string"
]
typeName = "string"
}
}
For UrlFileExtension, use:
{
name = "UrlFileExtension"
parameters = {
matchValues = [
"string"
]
negateCondition = bool
operator = "string"
transforms = [
"string"
]
typeName = "string"
}
}
For UrlFileName, use:
{
name = "UrlFileName"
parameters = {
matchValues = [
"string"
]
negateCondition = bool
operator = "string"
transforms = [
"string"
]
typeName = "string"
}
}
For UrlPath, use:
{
name = "UrlPath"
parameters = {
matchValues = [
"string"
]
negateCondition = bool
operator = "string"
transforms = [
"string"
]
typeName = "string"
}
}
Property Values
Microsoft.Cdn/profiles/endpoints
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| 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: profiles |
| properties | The JSON object that contains the properties required to create an endpoint. | EndpointProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Cdn/profiles/endpoints@2025-09-01-preview" |
AfdUrlSigningAction
| Name | Description | Value |
|---|---|---|
| name | The name of the action for the delivery rule. | 'AfdUrlSigning' (required) |
| parameters | Defines the parameters for the action. | AfdUrlSigningActionParameters (required) |
AfdUrlSigningActionParameters
| Name | Description | Value |
|---|---|---|
| algorithm | Algorithm to use for URL signing | 'SHA256' |
| keyGroupReference | Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/keyGroups/{keyGroupName} | ResourceReference (required) |
| parameterNameOverride | Defines which query string parameters in the url to be considered for expires, key id etc. | UrlSigningParamIdentifier[] |
| typeName | 'DeliveryRuleAfdUrlSigningActionParameters' (required) |
CacheConfiguration
| Name | Description | Value |
|---|---|---|
| cacheBehavior | Caching behavior for the requests | 'HonorOrigin' 'OverrideAlways' 'OverrideIfOriginMissing' |
| cacheDuration | The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss | string |
| isCompressionEnabled | Indicates whether content compression is enabled. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB. | 'Disabled' 'Enabled' |
| queryParameters | query parameters to include or exclude (comma separated). | string |
| queryStringCachingBehavior | Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings. | 'IgnoreQueryString' 'IgnoreSpecifiedQueryStrings' 'IncludeSpecifiedQueryStrings' 'UseQueryString' |
CacheExpirationActionParameters
| Name | Description | Value |
|---|---|---|
| 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) |
| typeName | 'DeliveryRuleCacheExpirationActionParameters' 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' 'DeliveryRuleEdgeActionParameters' 'DeliveryRuleHeaderActionParameters' 'DeliveryRuleOriginGroupOverrideActionParameters' 'DeliveryRuleRouteConfigurationOverrideActionParameters' 'DeliveryRuleUrlRedirectActionParameters' 'DeliveryRuleUrlRewriteActionParameters' 'DeliveryRuleUrlSigningActionParameters' (required) |
CacheKeyQueryStringActionParameters
| Name | Description | Value |
|---|---|---|
| queryParameters | query parameters to include or exclude (comma separated). | string |
| queryStringBehavior | Caching behavior for the requests | 'Exclude' 'ExcludeAll' 'Include' 'IncludeAll' (required) |
| typeName | 'DeliveryRuleCacheExpirationActionParameters' 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' 'DeliveryRuleEdgeActionParameters' 'DeliveryRuleHeaderActionParameters' 'DeliveryRuleOriginGroupOverrideActionParameters' 'DeliveryRuleRouteConfigurationOverrideActionParameters' 'DeliveryRuleUrlRedirectActionParameters' 'DeliveryRuleUrlRewriteActionParameters' 'DeliveryRuleUrlSigningActionParameters' (required) |
ClientPortMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
CookiesMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
DeepCreatedOrigin
| Name | Description | Value |
|---|---|---|
| name | Origin name which must be unique within the endpoint. | string (required) |
| properties | Properties of the origin created on the CDN endpoint. | DeepCreatedOriginProperties |
DeepCreatedOriginGroup
| Name | Description | Value |
|---|---|---|
| name | Origin group name which must be unique within the endpoint. | string (required) |
| properties | Properties of the origin group created on the CDN endpoint. | DeepCreatedOriginGroupProperties |
DeepCreatedOriginGroupProperties
| Name | Description | Value |
|---|---|---|
| healthProbeSettings | Health probe settings to the origin that is used to determine the health of the origin. | HealthProbeParameters |
| origins | The source of the content being delivered via CDN within given origin group. | ResourceReference[] (required) |
| responseBasedOriginErrorDetectionSettings | The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported. | ResponseBasedOriginErrorDetectionParameters |
| trafficRestorationTimeToHealedOrNewEndpointsInMinutes | Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. | int Constraints: Max value = 50 |
DeepCreatedOriginProperties
| Name | Description | Value |
|---|---|---|
| enabled | Origin is enabled for load balancing or not. By default, origin is always enabled. | bool |
| hostName | The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. | string (required) |
| httpPort | The value of the HTTP port. Must be between 1 and 65535. | int Constraints: Min value = 1 Max value = 65535 |
| httpsPort | The value of the HTTPS port. Must be between 1 and 65535. | int Constraints: Min value = 1 Max value = 65535 |
| originHostHeader | The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. | string |
| priority | Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. | int Constraints: Min value = 1 Max value = 5 |
| privateLinkAlias | The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' | string |
| privateLinkApprovalMessage | A custom message to be included in the approval request to connect to the Private Link. | string |
| privateLinkLocation | The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated | string |
| privateLinkResourceId | The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' | string |
| weight | Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 | int Constraints: Min value = 1 Max value = 1000 |
DeliveryRule
| Name | Description | Value |
|---|---|---|
| actions | A list of actions that are executed when all the conditions of a rule are satisfied. | DeliveryRuleAction[] (required) |
| conditions | A list of conditions that must be matched for the actions to be executed | DeliveryRuleCondition[] |
| name | Name of the rule | string |
| 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 (required) |
DeliveryRuleAction
| Name | Description | Value |
|---|---|---|
| name | Set to 'AfdUrlSigning' for type AfdUrlSigningAction. Set to 'CacheExpiration' for type DeliveryRuleCacheExpirationAction. Set to 'CacheKeyQueryString' for type DeliveryRuleCacheKeyQueryStringAction. Set to 'EdgeAction' for type EdgeAction. Set to 'ModifyRequestHeader' for type DeliveryRuleRequestHeaderAction. Set to 'ModifyResponseHeader' for type DeliveryRuleResponseHeaderAction. Set to 'OriginGroupOverride' for type OriginGroupOverrideAction. Set to 'RouteConfigurationOverride' for type DeliveryRuleRouteConfigurationOverrideAction. Set to 'UrlRedirect' for type UrlRedirectAction. Set to 'UrlRewrite' for type UrlRewriteAction. Set to 'UrlSigning' for type UrlSigningAction. | 'AfdUrlSigning' 'CacheExpiration' 'CacheKeyQueryString' 'EdgeAction' 'ModifyRequestHeader' 'ModifyResponseHeader' 'OriginGroupOverride' 'RouteConfigurationOverride' '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) |
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) |
DeliveryRuleClientPortCondition
| Name | Description | Value |
|---|---|---|
| name | The name of the condition for the delivery rule. | 'ClientPort' (required) |
| parameters | Defines the parameters for the condition. | ClientPortMatchConditionParameters (required) |
DeliveryRuleCondition
| Name | Description | Value |
|---|---|---|
| name | Set to 'ClientPort' for type DeliveryRuleClientPortCondition. Set to 'Cookies' for type DeliveryRuleCookiesCondition. Set to 'HostName' for type DeliveryRuleHostNameCondition. Set to 'HttpVersion' for type DeliveryRuleHttpVersionCondition. Set to 'IsDevice' for type DeliveryRuleIsDeviceCondition. Set to 'PostArgs' for type DeliveryRulePostArgsCondition. Set to 'QueryString' for type DeliveryRuleQueryStringCondition. Set to 'RemoteAddress' for type DeliveryRuleRemoteAddressCondition. Set to 'RequestBody' for type DeliveryRuleRequestBodyCondition. Set to 'RequestHeader' for type DeliveryRuleRequestHeaderCondition. Set to 'RequestMethod' for type DeliveryRuleRequestMethodCondition. Set to 'RequestScheme' for type DeliveryRuleRequestSchemeCondition. Set to 'RequestUri' for type DeliveryRuleRequestUriCondition. Set to 'ServerPort' for type DeliveryRuleServerPortCondition. Set to 'SocketAddr' for type DeliveryRuleSocketAddrCondition. Set to 'SslProtocol' for type DeliveryRuleSslProtocolCondition. Set to 'UrlFileExtension' for type DeliveryRuleUrlFileExtensionCondition. Set to 'UrlFileName' for type DeliveryRuleUrlFileNameCondition. Set to 'UrlPath' for type DeliveryRuleUrlPathCondition. | 'ClientPort' 'Cookies' 'HostName' 'HttpVersion' 'IsDevice' 'PostArgs' 'QueryString' 'RemoteAddress' 'RequestBody' 'RequestHeader' 'RequestMethod' 'RequestScheme' 'RequestUri' 'ServerPort' 'SocketAddr' 'SslProtocol' '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) |
DeliveryRuleEdgeActionParameters
| Name | Description | Value |
|---|---|---|
| edgeActionReference | defines the edge action that will be invoked. | ResourceReference (required) |
| invocationPoint | Defines at which point in the request processing pipeline the edge action will be invoked. | 'ClientRequest' 'OriginRequest' (required) |
| typeName | 'DeliveryRuleCacheExpirationActionParameters' 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' 'DeliveryRuleEdgeActionParameters' 'DeliveryRuleHeaderActionParameters' 'DeliveryRuleOriginGroupOverrideActionParameters' 'DeliveryRuleRouteConfigurationOverrideActionParameters' 'DeliveryRuleUrlRedirectActionParameters' 'DeliveryRuleUrlRewriteActionParameters' 'DeliveryRuleUrlSigningActionParameters' (required) |
DeliveryRuleHostNameCondition
| Name | Description | Value |
|---|---|---|
| name | The name of the condition for the delivery rule. | 'HostName' (required) |
| parameters | Defines the parameters for the condition. | HostNameMatchConditionParameters (required) |
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) |
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) |
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) |
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) |
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) |
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) |
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) |
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) |
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) |
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) |
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) |
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) |
DeliveryRuleRouteConfigurationOverrideAction
| Name | Description | Value |
|---|---|---|
| name | The name of the action for the delivery rule. | 'RouteConfigurationOverride' (required) |
| parameters | Defines the parameters for the action. | RouteConfigurationOverrideActionParameters (required) |
DeliveryRuleServerPortCondition
| Name | Description | Value |
|---|---|---|
| name | The name of the condition for the delivery rule. | 'ServerPort' (required) |
| parameters | Defines the parameters for the condition. | ServerPortMatchConditionParameters (required) |
DeliveryRuleSocketAddrCondition
| Name | Description | Value |
|---|---|---|
| name | The name of the condition for the delivery rule. | 'SocketAddr' (required) |
| parameters | Defines the parameters for the condition. | SocketAddrMatchConditionParameters (required) |
DeliveryRuleSslProtocolCondition
| Name | Description | Value |
|---|---|---|
| name | The name of the condition for the delivery rule. | 'SslProtocol' (required) |
| parameters | Defines the parameters for the condition. | SslProtocolMatchConditionParameters (required) |
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) |
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) |
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) |
EdgeAction
| Name | Description | Value |
|---|---|---|
| name | The name of the action for the delivery rule. | 'EdgeAction' (required) |
| parameters | Defines the parameters for the action. | DeliveryRuleEdgeActionParameters (required) |
EndpointProperties
| Name | Description | Value |
|---|---|---|
| contentTypesToCompress | List of content types on which compression applies. The value should be a valid MIME type. | string[] |
| defaultOriginGroup | A reference to the origin group. | ResourceReference |
| deliveryPolicy | A policy that specifies the delivery rules to be used for an endpoint. | EndpointPropertiesUpdateParametersDeliveryPolicy |
| geoFilters | List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/ | GeoFilter[] |
| isCompressionEnabled | Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB. | bool |
| isHttpAllowed | Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. | bool |
| isHttpsAllowed | Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. | bool |
| optimizationType | Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. Download, Media services. With this information, CDN can apply scenario driven optimization. | 'DynamicSiteAcceleration' 'GeneralMediaStreaming' 'GeneralWebDelivery' 'LargeFileDownload' 'VideoOnDemandMediaStreaming' |
| originGroups | The origin groups comprising of origins that are used for load balancing the traffic based on availability. | DeepCreatedOriginGroup[] |
| originHostHeader | The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. | string |
| originPath | A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. | string |
| origins | The source of the content being delivered via CDN. | DeepCreatedOrigin[] (required) |
| probePath | Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin. | string |
| queryStringCachingBehavior | Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. | 'BypassCaching' 'IgnoreQueryString' 'NotSet' 'UseQueryString' |
| urlSigningKeys | List of keys used to validate the signed URL hashes. | UrlSigningKey[] |
| webApplicationFirewallPolicyLink | Defines the Web Application Firewall policy for the endpoint (if applicable) | EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink |
EndpointPropertiesUpdateParametersDeliveryPolicy
| Name | Description | Value |
|---|---|---|
| description | User-friendly description of the policy. | string |
| rules | A list of the delivery rules. | DeliveryRule[] (required) |
EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
GeoFilter
| Name | Description | Value |
|---|---|---|
| action | Action of the geo filter, i.e. allow or block access. | 'Allow' 'Block' (required) |
| countryCodes | Two letter country or region codes defining user country or region access in a geo filter, e.g. AU, MX, US. | string[] (required) |
| relativePath | Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.) | string (required) |
HeaderActionParameters
| Name | Description | Value |
|---|---|---|
| headerAction | Action to perform | 'Append' 'Delete' 'Overwrite' (required) |
| headerName | Name of the header to modify | string (required) |
| typeName | 'DeliveryRuleCacheExpirationActionParameters' 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' 'DeliveryRuleEdgeActionParameters' 'DeliveryRuleHeaderActionParameters' 'DeliveryRuleOriginGroupOverrideActionParameters' 'DeliveryRuleRouteConfigurationOverrideActionParameters' 'DeliveryRuleUrlRedirectActionParameters' 'DeliveryRuleUrlRewriteActionParameters' 'DeliveryRuleUrlSigningActionParameters' (required) |
|
| value | Value for the specified action | string |
HealthProbeParameters
| Name | Description | Value |
|---|---|---|
| probeIntervalInSeconds | The number of seconds between health probes.Default is 240sec. | int Constraints: Min value = 1 Max value = 255 |
| probePath | The path relative to the origin that is used to determine the health of the origin. | string |
| probeProtocol | Protocol to use for health probe. | 'Grpc' 'Http' 'Https' 'NotSet' |
| probeRequestType | The type of health probe request that is made. | 'GET' 'HEAD' 'NotSet' |
HostNameMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
HttpErrorRangeParameters
| Name | Description | Value |
|---|---|---|
| begin | The inclusive start of the http status code range. | int Constraints: Min value = 100 Max value = 999 |
| end | The inclusive end of the http status code range. | int Constraints: Min value = 100 Max value = 999 |
HttpVersionMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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) |
| transforms | List of transforms | String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
IsDeviceMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
KeyVaultSigningKeyParameters
| Name | Description | Value |
|---|---|---|
| resourceGroupName | Resource group of the user's Key Vault containing the secret | string (required) |
| secretName | The name of secret in Key Vault. | string (required) |
| secretVersion | The version(GUID) of secret in Key Vault. | string (required) |
| subscriptionId | Subscription Id of the user's Key Vault containing the secret | string (required) |
| typeName | 'KeyVaultSigningKeyParameters' (required) | |
| vaultName | The name of the user's Key Vault containing the secret | string (required) |
OriginGroupOverride
| Name | Description | Value |
|---|---|---|
| forwardingProtocol | Protocol this rule will use when forwarding traffic to backends. | 'HttpOnly' 'HttpsOnly' 'MatchRequest' |
| originGroup | defines the OriginGroup that would override the DefaultOriginGroup on route. | ResourceReference |
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 |
|---|---|---|
| originGroup | defines the OriginGroup that would override the DefaultOriginGroup. | ResourceReference (required) |
| typeName | 'DeliveryRuleCacheExpirationActionParameters' 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' 'DeliveryRuleEdgeActionParameters' 'DeliveryRuleHeaderActionParameters' 'DeliveryRuleOriginGroupOverrideActionParameters' 'DeliveryRuleRouteConfigurationOverrideActionParameters' 'DeliveryRuleUrlRedirectActionParameters' 'DeliveryRuleUrlRewriteActionParameters' 'DeliveryRuleUrlSigningActionParameters' (required) |
PostArgsMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
QueryStringMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
RemoteAddressMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
RequestBodyMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
RequestHeaderMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
RequestMethodMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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) |
| transforms | List of transforms | String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
RequestSchemeMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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) |
| transforms | List of transforms | String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
RequestUriMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
ResourceReference
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
ResponseBasedOriginErrorDetectionParameters
| Name | Description | Value |
|---|---|---|
| httpErrorRanges | The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. | HttpErrorRangeParameters[] |
| responseBasedDetectedErrorTypes | Type of response errors for real user requests for which origin will be deemed unhealthy | 'None' 'TcpAndHttpErrors' 'TcpErrorsOnly' |
| responseBasedFailoverThresholdPercentage | The percentage of failed requests in the sample where failover should trigger. | int Constraints: Min value = 0 Max value = 100 |
RouteConfigurationOverrideActionParameters
| Name | Description | Value |
|---|---|---|
| cacheConfiguration | The caching configuration associated with this rule. To disable caching, do not provide a cacheConfiguration object. | CacheConfiguration |
| originGroupOverride | A reference to the origin group override configuration. Leave empty to use the default origin group on route. | OriginGroupOverride |
| typeName | 'DeliveryRuleCacheExpirationActionParameters' 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' 'DeliveryRuleEdgeActionParameters' 'DeliveryRuleHeaderActionParameters' 'DeliveryRuleOriginGroupOverrideActionParameters' 'DeliveryRuleRouteConfigurationOverrideActionParameters' 'DeliveryRuleUrlRedirectActionParameters' 'DeliveryRuleUrlRewriteActionParameters' 'DeliveryRuleUrlSigningActionParameters' (required) |
ServerPortMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
SocketAddrMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' 'IPMatch' (required) |
| transforms | List of transforms | String array containing any of: 'Lowercase' 'RemoveNulls' 'Trim' 'Uppercase' 'UrlDecode' 'UrlEncode' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
SslProtocolMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| matchValues | The match value for the condition of the delivery rule | String array containing any of: 'TLSv1' 'TLSv1.1' 'TLSv1.2' |
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
UrlFileExtensionMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
UrlFileNameMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
UrlPathMatchConditionParameters
| Name | Description | Value |
|---|---|---|
| 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' |
| typeName | 'DeliveryRuleClientPortConditionParameters' 'DeliveryRuleCookiesConditionParameters' 'DeliveryRuleHostNameConditionParameters' 'DeliveryRuleHttpVersionConditionParameters' 'DeliveryRuleIsDeviceConditionParameters' 'DeliveryRulePostArgsConditionParameters' 'DeliveryRuleQueryStringConditionParameters' 'DeliveryRuleRemoteAddressConditionParameters' 'DeliveryRuleRequestBodyConditionParameters' 'DeliveryRuleRequestHeaderConditionParameters' 'DeliveryRuleRequestMethodConditionParameters' 'DeliveryRuleRequestSchemeConditionParameters' 'DeliveryRuleRequestUriConditionParameters' 'DeliveryRuleServerPortConditionParameters' 'DeliveryRuleSocketAddrConditionParameters' 'DeliveryRuleSslProtocolConditionParameters' 'DeliveryRuleUrlFileExtensionMatchConditionParameters' 'DeliveryRuleUrlFilenameConditionParameters' 'DeliveryRuleUrlPathMatchConditionParameters' (required) |
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 |
|---|---|---|
| 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) |
| typeName | 'DeliveryRuleCacheExpirationActionParameters' 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' 'DeliveryRuleEdgeActionParameters' 'DeliveryRuleHeaderActionParameters' 'DeliveryRuleOriginGroupOverrideActionParameters' 'DeliveryRuleRouteConfigurationOverrideActionParameters' 'DeliveryRuleUrlRedirectActionParameters' 'DeliveryRuleUrlRewriteActionParameters' 'DeliveryRuleUrlSigningActionParameters' (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 |
|---|---|---|
| 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) |
| typeName | 'DeliveryRuleCacheExpirationActionParameters' 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' 'DeliveryRuleEdgeActionParameters' 'DeliveryRuleHeaderActionParameters' 'DeliveryRuleOriginGroupOverrideActionParameters' 'DeliveryRuleRouteConfigurationOverrideActionParameters' 'DeliveryRuleUrlRedirectActionParameters' 'DeliveryRuleUrlRewriteActionParameters' 'DeliveryRuleUrlSigningActionParameters' (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 |
|---|---|---|
| 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[] |
| typeName | 'DeliveryRuleCacheExpirationActionParameters' 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' 'DeliveryRuleEdgeActionParameters' 'DeliveryRuleHeaderActionParameters' 'DeliveryRuleOriginGroupOverrideActionParameters' 'DeliveryRuleRouteConfigurationOverrideActionParameters' 'DeliveryRuleUrlRedirectActionParameters' 'DeliveryRuleUrlRewriteActionParameters' 'DeliveryRuleUrlSigningActionParameters' (required) |
UrlSigningKey
| Name | Description | Value |
|---|---|---|
| keyId | Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash. | string (required) |
| keySourceParameters | Defines the parameters for using customer key vault for Url Signing Key. | KeyVaultSigningKeyParameters (required) |
UrlSigningParamIdentifier
| Name | Description | Value |
|---|---|---|
| paramIndicator | Indicates the purpose of the parameter | 'Expires' 'KeyId' 'Signature' (required) |
| paramName | Parameter name | string (required) |
Usage Examples
Terraform Samples
A basic example of deploying CDN Endpoint.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "profile" {
type = "Microsoft.Cdn/profiles@2020-09-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
sku = {
name = "Standard_Verizon"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "endpoint" {
type = "Microsoft.Cdn/profiles/endpoints@2020-09-01"
parent_id = azapi_resource.profile.id
name = var.resource_name
location = var.location
body = {
properties = {
isHttpAllowed = true
isHttpsAllowed = true
origins = [
{
name = "acceptanceTestCdnOrigin1"
properties = {
hostName = "www.contoso.com"
httpPort = 80
httpsPort = 443
}
},
]
queryStringCachingBehavior = "IgnoreQueryString"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}