Microsoft.Cdn profiles/customDomains 2021-06-01
Bicep resource definition
The profiles/customDomains 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/customDomains resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Cdn/profiles/customDomains@2021-06-01' = {
name: 'string'
parent: resourceSymbolicName
properties: {
azureDnsZone: {
id: 'string'
}
hostName: 'string'
preValidatedCustomDomainResourceId: {
id: 'string'
}
tlsSettings: {
certificateType: 'string'
minimumTlsVersion: 'string'
secret: {
id: 'string'
}
}
}
}
Property values
profiles/customDomains
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: profiles |
| properties | The JSON object that contains the properties of the domain to create. | AFDDomainProperties |
AFDDomainProperties
| Name | Description | Value |
|---|---|---|
| azureDnsZone | Resource reference to the Azure DNS zone | ResourceReference |
| hostName | The host name of the domain. Must be a domain name. | string (required) |
| preValidatedCustomDomainResourceId | Resource reference to the Azure resource where custom domain ownership was prevalidated | ResourceReference |
| tlsSettings | The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user's own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default. | AFDDomainHttpsParameters |
ResourceReference
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
AFDDomainHttpsParameters
| Name | Description | Value |
|---|---|---|
| certificateType | Defines the source of the SSL certificate. | 'AzureFirstPartyManagedCertificate' 'CustomerCertificate' 'ManagedCertificate' (required) |
| minimumTlsVersion | TLS protocol version that will be used for Https | 'TLS10' 'TLS12' |
| secret | Resource reference to the secret. ie. subs/rg/profile/secret | ResourceReference |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
FrontDoor CDN with WAF, Domains and Logs to EventHub |
This template creates a new Azure FrontDoor cdn profile. Create WAF with custom and managed rules, cdn routes, origin and groups with their association with WAF and routes, configures custom domains, create event hub and diagnostic settings for sending CDN access logs using event hub. |
| Front Door Premium with blob origin and Private Link |
This template creates a Front Door Premium and an Azure Storage blob container, and uses a private endpoint for Front Door to send traffic to the storage account. |
| Front Door Standard/Premium with custom domain |
This template creates a Front Door Standard/Premium including a custom domain and Microsoft-managed certificate. |
| Front Door Standard/Premium with Azure DNS and custom domain |
This template creates a Front Door Standard/Premium including a custom domain on Azure DNS and Microsoft-managed certificate. |
| Front Door Standard/Premium with domain and certificate |
This template creates a Front Door Standard/Premium including a custom domain and customer-managed certificate. |
ARM template resource definition
The profiles/customDomains 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/customDomains resource, add the following JSON to your template.
{
"type": "Microsoft.Cdn/profiles/customDomains",
"apiVersion": "2021-06-01",
"name": "string",
"properties": {
"azureDnsZone": {
"id": "string"
},
"hostName": "string",
"preValidatedCustomDomainResourceId": {
"id": "string"
},
"tlsSettings": {
"certificateType": "string",
"minimumTlsVersion": "string",
"secret": {
"id": "string"
}
}
}
}
Property values
profiles/customDomains
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Cdn/profiles/customDomains' |
| apiVersion | The resource api version | '2021-06-01' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
| properties | The JSON object that contains the properties of the domain to create. | AFDDomainProperties |
AFDDomainProperties
| Name | Description | Value |
|---|---|---|
| azureDnsZone | Resource reference to the Azure DNS zone | ResourceReference |
| hostName | The host name of the domain. Must be a domain name. | string (required) |
| preValidatedCustomDomainResourceId | Resource reference to the Azure resource where custom domain ownership was prevalidated | ResourceReference |
| tlsSettings | The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user's own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default. | AFDDomainHttpsParameters |
ResourceReference
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
AFDDomainHttpsParameters
| Name | Description | Value |
|---|---|---|
| certificateType | Defines the source of the SSL certificate. | 'AzureFirstPartyManagedCertificate' 'CustomerCertificate' 'ManagedCertificate' (required) |
| minimumTlsVersion | TLS protocol version that will be used for Https | 'TLS10' 'TLS12' |
| secret | Resource reference to the secret. ie. subs/rg/profile/secret | ResourceReference |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| FrontDoor CDN with WAF, Domains and Logs to EventHub |
This template creates a new Azure FrontDoor cdn profile. Create WAF with custom and managed rules, cdn routes, origin and groups with their association with WAF and routes, configures custom domains, create event hub and diagnostic settings for sending CDN access logs using event hub. |
| Front Door Premium with blob origin and Private Link |
This template creates a Front Door Premium and an Azure Storage blob container, and uses a private endpoint for Front Door to send traffic to the storage account. |
| Front Door Standard/Premium with custom domain |
This template creates a Front Door Standard/Premium including a custom domain and Microsoft-managed certificate. |
| Front Door Standard/Premium with Azure DNS and custom domain |
This template creates a Front Door Standard/Premium including a custom domain on Azure DNS and Microsoft-managed certificate. |
| Front Door Standard/Premium with domain and certificate |
This template creates a Front Door Standard/Premium including a custom domain and customer-managed certificate. |
Terraform (AzAPI provider) resource definition
The profiles/customDomains 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/customDomains resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Cdn/profiles/customDomains@2021-06-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
azureDnsZone = {
id = "string"
}
hostName = "string"
preValidatedCustomDomainResourceId = {
id = "string"
}
tlsSettings = {
certificateType = "string"
minimumTlsVersion = "string"
secret = {
id = "string"
}
}
}
})
}
Property values
profiles/customDomains
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Cdn/profiles/customDomains@2021-06-01" |
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: profiles |
| properties | The JSON object that contains the properties of the domain to create. | AFDDomainProperties |
AFDDomainProperties
| Name | Description | Value |
|---|---|---|
| azureDnsZone | Resource reference to the Azure DNS zone | ResourceReference |
| hostName | The host name of the domain. Must be a domain name. | string (required) |
| preValidatedCustomDomainResourceId | Resource reference to the Azure resource where custom domain ownership was prevalidated | ResourceReference |
| tlsSettings | The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user's own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default. | AFDDomainHttpsParameters |
ResourceReference
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
AFDDomainHttpsParameters
| Name | Description | Value |
|---|---|---|
| certificateType | Defines the source of the SSL certificate. | "AzureFirstPartyManagedCertificate" "CustomerCertificate" "ManagedCertificate" (required) |
| minimumTlsVersion | TLS protocol version that will be used for Https | "TLS10" "TLS12" |
| secret | Resource reference to the secret. ie. subs/rg/profile/secret | ResourceReference |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for