AFDEndpoint

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-cdn/json-schema/microsoft-azure-cdn-afdendpoint-schema.json",
  "title": "AFDEndpoint",
  "description": "Azure Front Door endpoint is the entity within a Azure Front Door profile containing configuration information such as origin, protocol, content caching and delivery behavior. The AzureFrontDoor endpoint uses the URL format <endpointname>.azureedge.net.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-azure-cdn-afdendpoints-api-openapi.yml#/components/schemas/AFDEndpoint",
  "type": "object",
  "properties": {
    "properties": {
      "$ref": "#/$defs/AFDEndpointProperties",
      "description": "The JSON object that contains the properties required to create an endpoint.",
      "x-ms-client-flatten": true
    }
  },
  "allOf": [
    {
      "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource"
    }
  ],
  "$defs": {
    "AFDEndpointProperties": {
      "type": "object",
      "description": "The JSON object that contains the properties required to create an endpoint.",
      "properties": {
        "profileName": {
          "type": "string",
          "description": "The name of the profile which holds the endpoint.",
          "readOnly": true
        },
        "enabledState": {
          "$ref": "#/$defs/EnabledState",
          "description": "Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'"
        },
        "enforceMtls": {
          "$ref": "#/$defs/EnforceMtlsEnabledState",
          "description": "Set to Disabled by default. If set to Enabled, only custom domains with mTLS enabled can be added to child Route resources."
        },
        "provisioningState": {
          "$ref": "#/$defs/AfdProvisioningState",
          "description": "Provisioning status",
          "readOnly": true
        },
        "deploymentStatus": {
          "$ref": "#/$defs/DeploymentStatus",
          "readOnly": true
        },
        "hostName": {
          "type": "string",
          "description": "The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net",
          "readOnly": true
        },
        "autoGeneratedDomainNameLabelScope": {
          "$ref": "#/$defs/AutoGeneratedDomainNameLabelScope",
          "description": "Indicates the endpoint name reuse scope. The default value is TenantReuse."
        }
      }
    },
    "AfdProvisioningState": {
      "type": "string",
      "description": "Provisioning status",
      "enum": [
        "Succeeded",
        "Failed",
        "Updating",
        "Deleting",
        "Creating"
      ],
      "x-ms-enum": {
        "name": "AfdProvisioningState",
        "modelAsString": true,
        "values": [
          {
            "name": "Succeeded",
            "value": "Succeeded"
          },
          {
            "name": "Failed",
            "value": "Failed"
          },
          {
            "name": "Updating",
            "value": "Updating"
          },
          {
            "name": "Deleting",
            "value": "Deleting"
          },
          {
            "name": "Creating",
            "value": "Creating"
          }
        ]
      }
    },
    "AutoGeneratedDomainNameLabelScope": {
      "type": "string",
      "description": "Indicates the endpoint name reuse scope. The default value is TenantReuse.",
      "enum": [
        "TenantReuse",
        "SubscriptionReuse",
        "ResourceGroupReuse",
        "NoReuse"
      ],
      "x-ms-enum": {
        "name": "AutoGeneratedDomainNameLabelScope",
        "modelAsString": true,
        "values": [
          {
            "name": "TenantReuse",
            "value": "TenantReuse"
          },
          {
            "name": "SubscriptionReuse",
            "value": "SubscriptionReuse"
          },
          {
            "name": "ResourceGroupReuse",
            "value": "ResourceGroupReuse"
          },
          {
            "name": "NoReuse",
            "value": "NoReuse"
          }
        ]
      }
    },
    "DeploymentStatus": {
      "type": "string",
      "enum": [
        "NotStarted",
        "InProgress",
        "Succeeded",
        "Failed"
      ],
      "x-ms-enum": {
        "name": "DeploymentStatus",
        "modelAsString": true,
        "values": [
          {
            "name": "NotStarted",
            "value": "NotStarted"
          },
          {
            "name": "InProgress",
            "value": "InProgress"
          },
          {
            "name": "Succeeded",
            "value": "Succeeded"
          },
          {
            "name": "Failed",
            "value": "Failed"
          }
        ]
      }
    },
    "EnabledState": {
      "type": "string",
      "description": "Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'",
      "enum": [
        "Enabled",
        "Disabled"
      ],
      "x-ms-enum": {
        "name": "EnabledState",
        "modelAsString": true,
        "values": [
          {
            "name": "Enabled",
            "value": "Enabled"
          },
          {
            "name": "Disabled",
            "value": "Disabled"
          }
        ]
      }
    },
    "EnforceMtlsEnabledState": {
      "type": "string",
      "description": "Set to Disabled by default. If set to Enabled, only custom domains with mTLS enabled can be added to child Route resources.",
      "enum": [
        "Enabled",
        "Disabled"
      ],
      "x-ms-enum": {
        "name": "EnforceMtlsEnabledState",
        "modelAsString": true,
        "values": [
          {
            "name": "Enabled",
            "value": "Enabled"
          },
          {
            "name": "Disabled",
            "value": "Disabled"
          }
        ]
      }
    }
  }
}