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-06-01
- 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:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Cdn/profiles/endpoints resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Cdn/profiles/endpoints@2015-06-01' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
contentTypesToCompress: [
'string'
]
isCompressionEnabled: bool
isHttpAllowed: bool
isHttpsAllowed: bool
originHostHeader: 'string'
originPath: 'string'
origins: [
{
name: 'string'
properties: {
hostName: 'string'
httpPort: int
httpsPort: int
}
}
]
queryStringCachingBehavior: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.Cdn/profiles/endpoints
Name | Description | Value |
---|---|---|
location | Endpoint location | 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 | EndpointPropertiesCreateParametersOrEndpointProperties | |
tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
DeepCreatedOrigin
Name | Description | Value |
---|---|---|
name | Origin name | string (required) |
properties | Properties of deep created origin on a CDN endpoint. | DeepCreatedOriginProperties |
DeepCreatedOriginProperties
Name | Description | Value |
---|---|---|
hostName | The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported. | string (required) |
httpPort | The value of the HTTP port. Must be between 1 and 65535 | int |
httpsPort | The value of the HTTPS port. Must be between 1 and 65535 | int |
EndpointCreateParametersTags
Name | Description | Value |
---|
EndpointPropertiesCreateParametersOrEndpointProperties
Name | Description | Value |
---|---|---|
contentTypesToCompress | List of content types on which compression will be applied. The value for the elements should be a valid MIME type. | string[] |
isCompressionEnabled | Indicates whether content compression is enabled. Default value is false. If compression is enabled, the content transferred from the CDN endpoint to the end user will be compressed. The requested content must be larger than 1 byte and smaller 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 |
originHostHeader | The host header CDN provider will send along with content requests to origins. The default value is the host name of the origin. | string |
originPath | The path used for origin requests. | string |
origins | The set of origins for the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options. | DeepCreatedOrigin[] (required) |
queryStringCachingBehavior | Defines the query string caching behavior. | 'BypassCaching' 'IgnoreQueryString' 'NotSet' 'UseQueryString' |
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:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Cdn/profiles/endpoints resource, add the following JSON to your template.
{
"type": "Microsoft.Cdn/profiles/endpoints",
"apiVersion": "2015-06-01",
"name": "string",
"location": "string",
"properties": {
"contentTypesToCompress": [ "string" ],
"isCompressionEnabled": "bool",
"isHttpAllowed": "bool",
"isHttpsAllowed": "bool",
"originHostHeader": "string",
"originPath": "string",
"origins": [
{
"name": "string",
"properties": {
"hostName": "string",
"httpPort": "int",
"httpsPort": "int"
}
}
],
"queryStringCachingBehavior": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Cdn/profiles/endpoints
Name | Description | Value |
---|---|---|
apiVersion | The api version | '2015-06-01' |
location | Endpoint location | string (required) |
name | The resource name | string (required) |
properties | EndpointPropertiesCreateParametersOrEndpointProperties | |
tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
type | The resource type | 'Microsoft.Cdn/profiles/endpoints' |
DeepCreatedOrigin
Name | Description | Value |
---|---|---|
name | Origin name | string (required) |
properties | Properties of deep created origin on a CDN endpoint. | DeepCreatedOriginProperties |
DeepCreatedOriginProperties
Name | Description | Value |
---|---|---|
hostName | The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported. | string (required) |
httpPort | The value of the HTTP port. Must be between 1 and 65535 | int |
httpsPort | The value of the HTTPS port. Must be between 1 and 65535 | int |
EndpointCreateParametersTags
Name | Description | Value |
---|
EndpointPropertiesCreateParametersOrEndpointProperties
Name | Description | Value |
---|---|---|
contentTypesToCompress | List of content types on which compression will be applied. The value for the elements should be a valid MIME type. | string[] |
isCompressionEnabled | Indicates whether content compression is enabled. Default value is false. If compression is enabled, the content transferred from the CDN endpoint to the end user will be compressed. The requested content must be larger than 1 byte and smaller 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 |
originHostHeader | The host header CDN provider will send along with content requests to origins. The default value is the host name of the origin. | string |
originPath | The path used for origin requests. | string |
origins | The set of origins for the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options. | DeepCreatedOrigin[] (required) |
queryStringCachingBehavior | Defines the query string caching behavior. | 'BypassCaching' 'IgnoreQueryString' 'NotSet' 'UseQueryString' |
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:
- Resource groups
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@2015-06-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
contentTypesToCompress = [
"string"
]
isCompressionEnabled = bool
isHttpAllowed = bool
isHttpsAllowed = bool
originHostHeader = "string"
originPath = "string"
origins = [
{
name = "string"
properties = {
hostName = "string"
httpPort = int
httpsPort = int
}
}
]
queryStringCachingBehavior = "string"
}
}
}
Property Values
Microsoft.Cdn/profiles/endpoints
Name | Description | Value |
---|---|---|
location | Endpoint location | 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 | EndpointPropertiesCreateParametersOrEndpointProperties | |
tags | Resource tags | Dictionary of tag names and values. |
type | The resource type | "Microsoft.Cdn/profiles/endpoints@2015-06-01" |
DeepCreatedOrigin
Name | Description | Value |
---|---|---|
name | Origin name | string (required) |
properties | Properties of deep created origin on a CDN endpoint. | DeepCreatedOriginProperties |
DeepCreatedOriginProperties
Name | Description | Value |
---|---|---|
hostName | The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported. | string (required) |
httpPort | The value of the HTTP port. Must be between 1 and 65535 | int |
httpsPort | The value of the HTTPS port. Must be between 1 and 65535 | int |
EndpointCreateParametersTags
Name | Description | Value |
---|
EndpointPropertiesCreateParametersOrEndpointProperties
Name | Description | Value |
---|---|---|
contentTypesToCompress | List of content types on which compression will be applied. The value for the elements should be a valid MIME type. | string[] |
isCompressionEnabled | Indicates whether content compression is enabled. Default value is false. If compression is enabled, the content transferred from the CDN endpoint to the end user will be compressed. The requested content must be larger than 1 byte and smaller 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 |
originHostHeader | The host header CDN provider will send along with content requests to origins. The default value is the host name of the origin. | string |
originPath | The path used for origin requests. | string |
origins | The set of origins for the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options. | DeepCreatedOrigin[] (required) |
queryStringCachingBehavior | Defines the query string caching behavior. | 'BypassCaching' 'IgnoreQueryString' 'NotSet' 'UseQueryString' |