Microsoft.Cdn profiles/afdEndpoints

• Latest
• 2023-07-01-preview
• 2023-05-01
• 2022-11-01-preview
• 2022-05-01-preview
• 2021-06-01
• 2020-09-01

Bicep resource definition

The profiles/afdEndpoints 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/afdEndpoints resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Cdn/profiles/afdEndpoints@2023-07-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    autoGeneratedDomainNameLabelScope: 'string'
    enabledState: 'string'
  }
}

Property values

profiles/afdEndpoints

Name	Description	Value
name	The resource name See how to set names and types for child resources in Bicep.	string (required)
location	Resource location.	string (required)
tags	Resource tags.	Dictionary of tag names and values. See Tags in templates
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.	AFDEndpointProperties

AFDEndpointProperties

Name	Description	Value
autoGeneratedDomainNameLabelScope	Indicates the endpoint name reuse scope. The default value is TenantReuse.	'NoReuse' 'ResourceGroupReuse' 'SubscriptionReuse' 'TenantReuse'
enabledState	Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'	'Disabled' 'Enabled'

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 App Service origin and Private Link	This template creates a Front Door Premium and an App Service, and uses a private endpoint for Front Door to send traffic to the application.
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 Premium with VM and Private Link service	This template creates a Front Door Premium and a virtual machine configured as a web server. Front Door uses a private endpoint with Private Link service to send traffic to the VM.
Front Door Premium with WAF and Microsoft-managed rule sets	This template creates a Front Door Premium including a web application firewall with the Microsoft-managed default and bot protection rule sets.
Front Door Standard/Premium	This template creates a Front Door Standard/Premium.
Front Door Standard/Premium with API Management origin	This template creates a Front Door Premium and an API Management instance, and uses an NSG and global API Management policy to validate that traffic has come through the Front Door origin.
Front Door Standard/Premium with App Service origin	This template creates a Front Door Standard/Premium, an App Service, and configures the App Service to validate that traffic has come through the Front Door origin.
Front Door Standard/Premium with Application Gateway origin	This template creates a Front Door Standard/Premium and an Application Gateway instance, and uses an NSG and WAF policy to validate that traffic has come through the Front Door origin.
Front Door with Container Instances and Application Gateway	This template creates a Front Door Standard/Premium with a container group and Application Gateway.
Front Door Standard/Premium with Azure Container Instances	This template creates a Front Door Standard/Premium with a container group.
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.
Front Door Standard/Premium with Azure Functions origin	This template creates a Front Door Standard/Premium, an Azure Functions app, and configures the function app to validate that traffic has come through the Front Door origin.
Front Door Standard/Premium with geo-filtering	This template creates a Front Door Standard/Premium including a web application firewall with a geo-filtering rule.
Front Door Standard/Premium with rate limit	This template creates a Front Door Standard/Premium including a web application firewall with a rate limit rule.
Front Door Standard/Premium with rule set	This template creates a Front Door Standard/Premium including a rule set.
Front Door Standard/Premium with static website origin	This template creates a Front Door Standard/Premium and an Azure Storage static website, and configured Front Door to send traffic to the static website.
Front Door Standard/Premium with WAF and custom rule	This template creates a Front Door Standard/Premium including a web application firewall with a custom rule.
Function App secured by Azure Frontdoor	This template allows you to deploy an azure premium function protected and published by Azure Frontdoor premium. The conenction between Azure Frontdoor and Azure Functions is protected by Azure Private Link.
Highly Available Multi-region Web App	This template allows you to create a secure, highly available, multi-region end to end solution with two web apps in different regions behind Azure Front Door

ARM template resource definition

The profiles/afdEndpoints 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/afdEndpoints resource, add the following JSON to your template.

{
  "type": "Microsoft.Cdn/profiles/afdEndpoints",
  "apiVersion": "2023-07-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "autoGeneratedDomainNameLabelScope": "string",
    "enabledState": "string"
  }
}

Property values

profiles/afdEndpoints

Name	Description	Value
type	The resource type	'Microsoft.Cdn/profiles/afdEndpoints'
apiVersion	The resource api version	'2023-07-01-preview'
name	The resource name See how to set names and types for child resources in JSON ARM templates.	string (required)
location	Resource location.	string (required)
tags	Resource tags.	Dictionary of tag names and values. See Tags in templates
properties	The JSON object that contains the properties required to create an endpoint.	AFDEndpointProperties

AFDEndpointProperties

Name	Description	Value
autoGeneratedDomainNameLabelScope	Indicates the endpoint name reuse scope. The default value is TenantReuse.	'NoReuse' 'ResourceGroupReuse' 'SubscriptionReuse' 'TenantReuse'
enabledState	Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'	'Disabled' 'Enabled'

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 App Service origin and Private Link	This template creates a Front Door Premium and an App Service, and uses a private endpoint for Front Door to send traffic to the application.
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 Premium with VM and Private Link service	This template creates a Front Door Premium and a virtual machine configured as a web server. Front Door uses a private endpoint with Private Link service to send traffic to the VM.
Front Door Premium with WAF and Microsoft-managed rule sets	This template creates a Front Door Premium including a web application firewall with the Microsoft-managed default and bot protection rule sets.
Front Door Standard/Premium	This template creates a Front Door Standard/Premium.
Front Door Standard/Premium with API Management origin	This template creates a Front Door Premium and an API Management instance, and uses an NSG and global API Management policy to validate that traffic has come through the Front Door origin.
Front Door Standard/Premium with App Service origin	This template creates a Front Door Standard/Premium, an App Service, and configures the App Service to validate that traffic has come through the Front Door origin.
Front Door Standard/Premium with Application Gateway origin	This template creates a Front Door Standard/Premium and an Application Gateway instance, and uses an NSG and WAF policy to validate that traffic has come through the Front Door origin.
Front Door with Container Instances and Application Gateway	This template creates a Front Door Standard/Premium with a container group and Application Gateway.
Front Door Standard/Premium with Azure Container Instances	This template creates a Front Door Standard/Premium with a container group.
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.
Front Door Standard/Premium with Azure Functions origin	This template creates a Front Door Standard/Premium, an Azure Functions app, and configures the function app to validate that traffic has come through the Front Door origin.
Front Door Standard/Premium with geo-filtering	This template creates a Front Door Standard/Premium including a web application firewall with a geo-filtering rule.
Front Door Standard/Premium with rate limit	This template creates a Front Door Standard/Premium including a web application firewall with a rate limit rule.
Front Door Standard/Premium with rule set	This template creates a Front Door Standard/Premium including a rule set.
Front Door Standard/Premium with static website origin	This template creates a Front Door Standard/Premium and an Azure Storage static website, and configured Front Door to send traffic to the static website.
Front Door Standard/Premium with WAF and custom rule	This template creates a Front Door Standard/Premium including a web application firewall with a custom rule.
Function App secured by Azure Frontdoor	This template allows you to deploy an azure premium function protected and published by Azure Frontdoor premium. The conenction between Azure Frontdoor and Azure Functions is protected by Azure Private Link.
Highly Available Multi-region Web App	This template allows you to create a secure, highly available, multi-region end to end solution with two web apps in different regions behind Azure Front Door

Terraform (AzAPI provider) resource definition

The profiles/afdEndpoints 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/afdEndpoints resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Cdn/profiles/afdEndpoints@2023-07-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      autoGeneratedDomainNameLabelScope = "string"
      enabledState = "string"
    }
  })
}

Property values

profiles/afdEndpoints

Name	Description	Value
type	The resource type	"Microsoft.Cdn/profiles/afdEndpoints@2023-07-01-preview"
name	The resource name	string (required)
location	Resource location.	string (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: profiles
tags	Resource tags.	Dictionary of tag names and values.
properties	The JSON object that contains the properties required to create an endpoint.	AFDEndpointProperties

AFDEndpointProperties

Name	Description	Value
autoGeneratedDomainNameLabelScope	Indicates the endpoint name reuse scope. The default value is TenantReuse.	"NoReuse" "ResourceGroupReuse" "SubscriptionReuse" "TenantReuse"
enabledState	Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'	"Disabled" "Enabled"