openapi: 3.2.0
info:
  title: CdnManagementClient Endpoints API
  version: '2026-07-01'
  description: Use these APIs to manage Azure Front Door and CDN resources through the Azure Resource Manager. You must make sure that requests made to these resources are secure.
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Endpoints
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints
  : get:
      operationId: Endpoints_ListByProfile
      tags:
      - Endpoints
      description: Lists existing CDN endpoints.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter
      - name: profileName
        in: path
        description: Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
        required: true
        schema:
          type: string
          maxLength: 260
          minLength: 1
          pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Endpoints_ListByProfile:
          $ref: ./examples/Endpoints_ListByProfile.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Endpoints list by profile
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}
  : get:
      operationId: Endpoints_Get
      tags:
      - Endpoints
      description: Gets an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter
      - name: profileName
        in: path
        description: Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
        required: true
        schema:
          type: string
          maxLength: 260
          minLength: 1
          pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$
      - name: endpointName
        in: path
        description: Name of the endpoint under the profile which is unique globally.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Endpoint'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Endpoints_Get:
          $ref: ./examples/Endpoints_Get.json
      summary: Endpoints get
      x-summary-source: derived
    put:
      operationId: Endpoints_Create
      tags:
      - Endpoints
      description: Creates a new CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter
      - name: profileName
        in: path
        description: Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
        required: true
        schema:
          type: string
          maxLength: 260
          minLength: 1
          pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$
      - name: endpointName
        in: path
        description: Name of the endpoint under the profile which is unique globally.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource 'Endpoint' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Endpoint'
        '201':
          description: Resource 'Endpoint' create operation succeeded
          headers:
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Endpoint'
        '202':
          description: The request has been accepted for processing, but processing has not yet completed.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Endpoint'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Endpoints_Create:
          $ref: ./examples/Endpoints_Create.json
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/Endpoint'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Endpoint'
        description: Endpoint properties
        required: true
      summary: Endpoints create
      x-summary-source: derived
    patch:
      operationId: Endpoints_Update
      tags:
      - Endpoints
      description: Updates an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update origin groups, use the Update Origin group operation. To update custom domains, use the Update Custom Domain operation.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter
      - name: profileName
        in: path
        description: Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
        required: true
        schema:
          type: string
          maxLength: 260
          minLength: 1
          pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$
      - name: endpointName
        in: path
        description: Name of the endpoint under the profile which is unique globally.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Endpoint'
        '202':
          description: The request has been accepted for processing, but processing has not yet completed.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Endpoint'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Endpoints_Update:
          $ref: ./examples/Endpoints_Update.json
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/Endpoint'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EndpointUpdateParameters'
        description: Endpoint update properties
        required: true
      summary: Endpoints update
      x-summary-source: derived
    delete:
      operationId: Endpoints_Delete
      tags:
      - Endpoints
      description: Deletes an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter
      - name: profileName
        in: path
        description: Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
        required: true
        schema:
          type: string
          maxLength: 260
          minLength: 1
          pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$
      - name: endpointName
        in: path
        description: Name of the endpoint under the profile which is unique globally.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource deleted successfully.
        '202':
          description: Resource deletion accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Endpoints_Delete:
          $ref: ./examples/Endpoints_Delete.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Endpoints delete
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/checkResourceUsage
  : post:
      operationId: Endpoints_ListResourceUsage
      tags:
      - Endpoints
      description: Checks the quota and usage of geo filters and custom domains under the given endpoint.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter
      - name: profileName
        in: path
        description: Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
        required: true
        schema:
          type: string
          maxLength: 260
          minLength: 1
          pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$
      - name: endpointName
        in: path
        description: Name of the endpoint under the profile which is unique globally.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceUsageListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Endpoints_ListResourceUsage:
          $ref: ./examples/Endpoints_ListResourceUsage.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Endpoints list resource usage
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/load
  : post:
      operationId: Endpoints_LoadContent
      tags:
      - Endpoints
      description: Pre-loads a content to CDN. Available for Verizon Profiles.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter
      - name: profileName
        in: path
        description: Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
        required: true
        schema:
          type: string
          maxLength: 260
          minLength: 1
          pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$
      - name: endpointName
        in: path
        description: Name of the endpoint under the profile which is unique globally.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
        '202':
          description: Resource operation accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Endpoints_LoadContent:
          $ref: ./examples/Endpoints_LoadContent.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoadParameters'
        description: 'The path to the content to be loaded. Path should be a full URL, e.g. ‘/pictures/city.png'' which loads a single file '
        required: true
      summary: Endpoints load content
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/purge
  : post:
      operationId: Endpoints_PurgeContent
      tags:
      - Endpoints
      description: Removes a content from CDN.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter
      - name: profileName
        in: path
        description: Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
        required: true
        schema:
          type: string
          maxLength: 260
          minLength: 1
          pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$
      - name: endpointName
        in: path
        description: Name of the endpoint under the profile which is unique globally.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
        '202':
          description: Resource operation accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Endpoints_PurgeContent:
          $ref: ./examples/Endpoints_PurgeContent.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PurgeParameters'
        description: The path to the content to be purged. Path can be a full URL, e.g. '/pictures/city.png' which removes a single file, or a directory with a wildcard, e.g. '/pictures/*' which removes all folders and files in the directory.
        required: true
      summary: Endpoints purge content
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/start
  : post:
      operationId: Endpoints_Start
      tags:
      - Endpoints
      description: Starts an existing CDN endpoint that is on a stopped state.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter
      - name: profileName
        in: path
        description: Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
        required: true
        schema:
          type: string
          maxLength: 260
          minLength: 1
          pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$
      - name: endpointName
        in: path
        description: Name of the endpoint under the profile which is unique globally.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Endpoint'
        '202':
          description: The request has been accepted for processing, but processing has not yet completed.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Endpoint'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Endpoints_Start:
          $ref: ./examples/Endpoints_Start.json
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/Endpoint'
      x-ms-long-running-operation: true
      summary: Endpoints start
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/stop
  : post:
      operationId: Endpoints_Stop
      tags:
      - Endpoints
      description: Stops an existing running CDN endpoint.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter
      - name: profileName
        in: path
        description: Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
        required: true
        schema:
          type: string
          maxLength: 260
          minLength: 1
          pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$
      - name: endpointName
        in: path
        description: Name of the endpoint under the profile which is unique globally.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Endpoint'
        '202':
          description: The request has been accepted for processing, but processing has not yet completed.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Endpoint'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Endpoints_Stop:
          $ref: ./examples/Endpoints_Stop.json
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/Endpoint'
      x-ms-long-running-operation: true
      summary: Endpoints stop
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/validateCustomDomain
  : post:
      operationId: Endpoints_ValidateCustomDomain
      tags:
      - Endpoints
      description: Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter
      - name: profileName
        in: path
        description: Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
        required: true
        schema:
          type: string
          maxLength: 260
          minLength: 1
          pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$
      - name: endpointName
        in: path
        description: Name of the endpoint under the profile which is unique globally.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateCustomDomainOutput'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Endpoints_ValidateCustomDomain:
          $ref: ./examples/Endpoints_ValidateCustomDomain.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateCustomDomainInput'
        description: Custom domain to be validated.
        required: true
      summary: Endpoints validate custom domain
      x-summary-source: derived
components:
  schemas:
    EndpointPropertiesUpdateParameters:
      type: object
      description: The JSON object containing endpoint update parameters.
      properties:
        originPath:
          type: string
          description: A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
        contentTypesToCompress:
          type: array
          description: List of content types on which compression applies. The value should be a valid MIME type.
          items:
            type: string
        originHostHeader:
          type: string
          description: 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.
        isCompressionEnabled:
          type: boolean
          description: 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.
        isHttpAllowed:
          type: boolean
          description: Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
          default: true
        isHttpsAllowed:
          type: boolean
          description: Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
          default: true
        queryStringCachingBehavior:
          type: string
          description: 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.
          default: NotSet
          enum:
          - IgnoreQueryString
          - BypassCaching
          - UseQueryString
          - NotSet
          x-ms-enum:
            name: QueryStringCachingBehavior
            modelAsString: false
        optimizationType:
          $ref: '#/components/schemas/OptimizationType'
          description: 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.
        probePath:
          type: string
          description: 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.
        geoFilters:
          type: array
          description: 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/
          items:
            $ref: '#/components/schemas/GeoFilter'
          x-ms-identifiers: []
        defaultOriginGroup:
          $ref: '#/components/schemas/ResourceReference'
          description: A reference to the origin group.
        urlSigningKeys:
          type: array
          description: List of keys used to validate the signed URL hashes.
          items:
            $ref: '#/components/schemas/UrlSigningKey'
          x-ms-identifiers:
          - keyId
        deliveryPolicy:
          $ref: '#/components/schemas/EndpointPropertiesUpdateParametersDeliveryPolicy'
          description: A policy that specifies the delivery rules to be used for an endpoint.
        webApplicationFirewallPolicyLink:
          $ref: '#/components/schemas/EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink'
          description: Defines the Web Application Firewall policy for the endpoint (if applicable)
    LoadParameters:
      type: object
      description: Parameters required for content load.
      properties:
        contentPaths:
          type: array
          description: The path to the content to be loaded. Path should be a relative file URL of the origin.
          items:
            type: string
      required:
      - contentPaths
    UrlSigningKey:
      type: object
      description: Url signing key
      properties:
        keyId:
          type: string
          description: Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash.
        keySourceParameters:
          $ref: '#/components/schemas/KeyVaultSigningKeyParameters'
          description: Defines the parameters for using customer key vault for Url Signing Key.
      required:
      - keyId
      - keySourceParameters
    DeepCreatedOriginProperties:
      type: object
      description: Properties of the origin created on the CDN endpoint.
      properties:
        hostName:
          type: string
          description: 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.
        httpPort:
          type: integer
          format: int32
          description: The value of the HTTP port. Must be between 1 and 65535.
          minimum: 1
          maximum: 65535
        httpsPort:
          type: integer
          format: int32
          description: The value of the HTTPS port. Must be between 1 and 65535.
          minimum: 1
          maximum: 65535
        originHostHeader:
          type: string
          description: 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.
        priority:
          type: integer
          format: int32
          description: 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.
          minimum: 1
          maximum: 5
        weight:
          type: integer
          format: int32
          description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000
          minimum: 1
          maximum: 1000
        enabled:
          type: boolean
          description: Origin is enabled for load balancing or not. By default, origin is always enabled.
        privateLinkAlias:
          type: string
          description: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'
        privateLinkResourceId:
          type: string
          description: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'
        privateLinkLocation:
          type: string
          description: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated
        privateLinkApprovalMessage:
          type: string
          description: A custom message to be included in the approval request to connect to the Private Link.
        privateEndpointStatus:
          $ref: '#/components/schemas/PrivateEndpointStatus'
          description: The approval status for the connection to the Private Link
          readOnly: true
      required:
      - hostName
    HealthProbeRequestType:
      type: string
      description: The type of health probe request that is made.
      enum:
      - NotSet
      - GET
      - HEAD
      x-ms-enum:
        name: HealthProbeRequestType
        modelAsString: false
    EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink:
      type: object
      description: Defines the Web Application Firewall policy for the endpoint (if applicable)
      properties:
        id:
          type: string
          description: Resource ID.
    EndpointProperties:
      type: object
      description: The JSON object that contains the properties required to create an endpoint.
      properties:
        hostName:
          type: string
          description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net
          readOnly: true
        origins:
          type: array
          description: The source of the content being delivered via CDN.
          items:
            $ref: '#/components/schemas/DeepCreatedOrigin'
          x-ms-identifiers:
          - name
        originGroups:
          type: array
          description: The origin groups comprising of origins that are used for load balancing the traffic based on availability.
          items:
            $ref: '#/components/schemas/DeepCreatedOriginGroup'
          x-ms-identifiers:
          - name
        customDomains:
          type: array
          description: The custom domains under the endpoint.
          items:
            $ref: '#/components/schemas/DeepCreatedCustomDomain'
          readOnly: true
          x-ms-identifiers:
          - name
        resourceState:
          $ref: '#/components/schemas/EndpointResourceState'
          description: Resource status of the endpoint.
          readOnly: true
        provisioningState:
          $ref: '#/components/schemas/EndpointProvisioningState'
          description: Provisioning status of the endpoint.
          readOnly: true
      required:
      - origins
      allOf:
      - $ref: '#/components/schemas/EndpointPropertiesUpdateParameters'
    DeepCreatedCustomDomain:
      type: object
      description: Custom domains created on the CDN endpoint.
      properties:
        name:
          type: string
          description: Custom domain name.
        properties:
          $ref: '#/components/schemas/DeepCreatedCustomDomainProperties'
          description: Properties of the custom domain created on the CDN endpoint.
          x-ms-client-flatten: true
      required:
      - name
    DeepCreatedOriginGroupProperties:
      type: object
      description: Properties of the origin group created on the CDN endpoint.
      properties:
        healthProbeSettings:
          $ref: '#/components/schemas/HealthProbeParameters'
          description: Health probe settings to the origin that is used to determine the health of the origin.
        origins:
          type: array
          description: The source of the content being delivered via CDN within given origin group.
          items:
            $ref: '#/components/schemas/ResourceReference'
        trafficRestorationTimeToHealedOrNewEndpointsInMinutes:
          type: integer
          format: int32
          description: 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.
          maximum: 50
        responseBasedOriginErrorDetectionSettings:
          $ref: '#/components/schemas/ResponseBasedOriginErrorDetectionParameters'
          description: The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported.
      required:
      - origins
    EndpointResourceState:
      type: string
      description: Resource status of the endpoint.
      enum:
      - Creating
      - Deleting
      - Running
      - Starting
      - Stopped
      - Stopping
      x-ms-enum:
        name: EndpointResourceState
        modelAsString: true
        values:
        - name: Creating
          value: Creating
        - name: Deleting
          value: Deleting
        - name: Running
          value: Running
        - name: Starting
          value: Starting
        - name: Stopped
          value: Stopped
        - name: Stopping
          value: Stopping
    DeepCreatedOriginGroup:
      type: object
      description: The origin group for CDN content which is added when creating a CDN endpoint. Traffic is sent to the origins within the origin group based on origin health.
      properties:
        name:
          type: string
          description: Origin group name which must be unique within the endpoint.
        properties:
          $ref: '#/components/schemas/DeepCreatedOriginGroupProperties'
          description: Properties of the origin group created on the CDN endpoint.
          x-ms-client-flatten: true
      required:
      - name
    HttpErrorRangeParameters:
      type: object
      description: The JSON object that represents the range for http status codes
      properties:
        begin:
          type: integer
          format: int32
          description: The inclusive start of the http status code range.
          minimum: 100
          maximum: 999
        end:
          type: integer
          format: int32
          description: The inclusive end of the http status code range.
          minimum: 100
          maximum: 999
    DeliveryRuleAction:
      type: object
      description: An action for the delivery rule.
      properties:
        name:
          $ref: '#/components/schemas/DeliveryRuleActionName'
          description: The name of the action for the delivery rule.
      discriminator:
        propertyName: name
      required:
      - name
    ValidateCustomDomainInput:
      type: object
      description: Input of the custom domain to be validated for DNS mapping.
      properties:
        hostName:
          type: string
          description: The host name of the custom domain. Must be a domain name.
      required:
      - hostName
    GeoFilterActions:
      type: string
      description: Action of the geo filter, i.e. allow or block access.
      enum:
      - Block
      - Allow
      x-ms-enum:
        name: GeoFilterActions
        modelAsString: false
    EndpointProvisioningState:
      type: string
      description: Provisioning status of the endpoint.
      enum:
      - Succeeded
      - Failed
      - Updating
      - Deleting
      - Creating
      x-ms-enum:
        name: EndpointProvisioningState
        modelAsString: true
        values:
        - name: Succeeded
          value: Succeeded
        - name: Failed
          value: Failed
        - name: Updating
          value: Updating
        - name: Deleting
          value: Deleting
        - name: Creating
          value: Creating
    HealthProbeParameters:
      type: object
      description: The JSON object that contains the properties to send health probes to origin.
      properties:
        probePath:
          type: string
          description: The path relative to the origin that is used to determine the health of the origin.
        probeRequestType:
          $ref: '#/components/schemas/HealthProbeRequestType'
          description: The type of health probe request that is made.
        probeProtocol:
          $ref: '#/components/schemas/ProbeProtocol'
          description: Protocol to use for health probe.
        probeIntervalInSeconds:
          type: integer
          format: int32
          description: The number of seconds between health probes.Default is 240sec.
          minimum: 1
          maximum: 255
    PrivateEndpointStatus:
      type: string
      description: The approval status for the connection to the Private Link
      enum:
      - Pending
      - Approved
      - Rejected
      - Disconnected
      - Timeout
      x-ms-enum:
        name: PrivateEndpointStatus
        modelAsString: true
        values:
        - name: Pending
          value: Pending
        - name: Approved
          value: Approved
        - name: Rejected
          value: Rejected
        - name: Disconnected
          value: Disconnected
        - name: Timeout
          value: Timeout
    DeepCreatedCustomDomainProperties:
      type: object
      description: Properties of the custom domain created on the CDN endpoint.
      properties:
        hostName:
          type: string
          description: The host name of the custom domain. Must be a domain name.
        validationData:
          type: string
          description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China.
      required:
      - hostName
    ResourceUsageListResult:
      type: object
      description: Output of check resource usage API.
      properties:
        value:
          type: array
          description: The ResourceUsage items on this page
          items:
            $ref: '#/components/schemas/ResourceUsage'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    OptimizationType:
      type: string
      description: Specifies what scenario the customer wants this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization.
      enum:
      - GeneralWebDelivery
      - GeneralMediaStreaming
      - VideoOnDemandMediaStreaming
      - LargeFileDownload
      - DynamicSiteAcceleration
      x-ms-enum:
        name: OptimizationType
        modelAsString: true
        values:
        - name: GeneralWebDelivery
          value: GeneralWebDelivery
        - name: GeneralMediaStreaming
          value: GeneralMediaStreaming
        - name: VideoOnDemandMediaStreaming
          value: VideoOnDemandMediaStreaming
        - name: LargeFileDownload
          value: LargeFileDownload
        - name: DynamicSiteAcceleration
          value: DynamicSiteAcceleration
    ResourceUsage:
      type: object
      description: Output of check resource usage API.
      properties:
        resourceType:
          type: string
          description: Resource type for which the usage is provided.
          readOnly: true
        unit:
          $ref: '#/components/schemas/ResourceUsageUnit'
          description: Unit of the usage. e.g. count.
          readOnly: true
        currentValue:
          type: integer
          format: int32
          description: Actual value of usage on the specified resource type.
          readOnly: true
        limit:
          type: integer
          format: int32
          description: Quota of the specified resource type.
          readOnly: true
    EndpointUpdateParameters:
      type: object
      description: Properties required to create or update an endpoint.
      properties:
        tags:
          type: object
          description: Endpoint tags.
          additionalProperties:
            type: string
        properties:
          $ref: '#/components/schemas/EndpointPropertiesUpdateParameters'
          description: The JSON object containing endpoint update parameters.
          x-ms-client-flatten: true
    PurgeParameters:
      type: object
      description: Parameters required for content purge.
      properties:
        contentPaths:
          type: array
          description: The path to the content to be purged. Can describe a file path or a wild card directory.
          items:
            type: string
      required:
      - contentPaths
    DeliveryRuleActionName:
      type: string
      description: The name of the action for the delivery rule.
      enum:
      - CacheExpiration
      - CacheKeyQueryString
      - ModifyRequestHeader
      - ModifyResponseHeader
      - UrlRedirect
      - UrlRewrite
      - UrlSigning
      - OriginGroupOverride
      - RouteConfigurationOverride
      - EdgeAction
      - AfdUrlSigning
      x-ms-enum:
        name: DeliveryRuleActionName
        modelAsString: true
        values:
        - name: CacheExpiration
          value: CacheExpiration
        - name: CacheKeyQueryString
          value: CacheKeyQueryString
        - name: ModifyRequestHeader
          value: ModifyRequestHeader
        - name: ModifyResponseHeader
          value: ModifyResponseHeader
        - name: UrlRedirect
          value: UrlRedirect
        - name: UrlRewrite
          value: UrlRewrite
        - name: UrlSigning
          value: UrlSigning
        - name: OriginGroupOverride
          value: OriginGroupOverride
        - name: RouteConfigurationOverride
          value: RouteConfigurationOverride
        - name: EdgeAction
          value: EdgeAction
        - name: AfdUrlSigning
          value: AfdUrlSigning
    KeyVaultSigningKeyParameters:
      type: object
      description: Describes the parameters for using a user's KeyVault for URL Signing Key.
      properties:
        typeName:
          $ref: '#/components/schemas/KeyVaultSigningKeyParametersType'
        subscriptionId:
          type: string
          description: Subscription Id of the user's Key Vault containing the secret
        resourceGroupName:
          type: string
          description: Resource group of the user's Key Vault containing the secret
        vaultName:
          type: string
          description: The name of the user's Key Vault containing the secret
        secretName:
          type: string
          description: The name of secret in Key Vault.
        secretVersion:
          type: string
          description: The version(GUID) of secret in Key Vault.
      required:
      - typeName
      - subscriptionId
      - resourceGroupName
      - vaultName
      - secretName
      - secretVersion
    Endpoint:
      type: object
      description: CDN endpoint is the entity within a CDN profile containing configuration information such as origin, protocol, content caching and delivery behavior. The CDN endpoint uses the URL format <endpointname>.azureedge.net.
      properties:
        properties:
          $ref: '#/components/schemas/EndpointProperties'
          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
    MatchVariable:
      type: string
      description: Request variable to compare with.
      enum:
      - RemoteAddress
      - RequestMethod
      - QueryString
      - PostArgs
      - RequestUri
      - RequestHeader
      - RequestBody
      - RequestScheme
      - UrlPath
      - UrlFileExtension
      - UrlFileName
      - HttpVersion
      - Cookies
      - IsDevice
      - SocketAddr
      - ClientPort
      - ServerPort
      - HostName
      - SslProtocol
      x-ms-enum:
        name: MatchVariable
        modelAsString: true
        values:
        - name: RemoteAddress
          value: RemoteAddress
        - name: RequestMethod
          value: RequestMethod
        - name: QueryString
          value: QueryString
        - name: PostArgs
          value: PostArgs
        - name: RequestUri
          value: RequestUri
        - name: RequestHeader
          value: RequestHeader
        - name: RequestBody
          value: RequestBody
        - name: RequestScheme
          value: RequestScheme
        - name: UrlPath
          value: UrlPath
        - name: UrlFileExtension
          value: UrlFileExtension
        - name: UrlFileName
          value: UrlFileName
        - name: HttpVersion
          value: HttpVersion
        - name: Cookies
          value: Cookies
        - name: IsDevice
          value: IsDevice
        - name: SocketAddr
          value: SocketAddr
        - name: ClientPort
          value: ClientPort
        - name: ServerPort
          value: ServerPort
        - name: HostName
          value: HostName
        - name: SslProtocol
          value: SslProtocol
    DeepCreatedOrigin:
      type: object
      description: The main origin of CDN content which is added when creating a CDN endpoint.
      properties:
        name:
          type: string
          description: Origin name which must be unique within the endpoint.
        properties:
          $ref: '#/components/schemas/DeepCreatedOriginProperties'
          description: Properties of the origin created on the CDN endpoint.
          x-ms-client-flatten: true
      required:
      - name
    EndpointPropertiesUpdateParametersDeliveryPolicy:
      type: object
      description: A policy that specifies the delivery rules to be used for an endpoint.
      properties:
        description:
          type: string
          description: User-friendly description of the policy.
        rules:
          type: array
          description: A list of the delivery rules.
          items:
            $ref: '#/components/schemas/DeliveryRule'
          x-ms-identifiers:
          - name
      required:
      - rules
    ResponseBasedOriginErrorDetectionParameters:
      type: object
      description: The JSON object that contains the properties to determine origin health using real requests/responses.
      properties:
        responseBasedDetectedErrorTypes:
          $ref: '#/components/schemas/ResponseBasedDetectedErrorTypes'
          description: Type of response errors for real user requests for which origin will be deemed unhealthy
        responseBasedFailoverThresholdPercentage:
          type: integer
          format: int32
          description: The percentage of failed requests in the sample where failover should trigger.
          minimum: 0
          maximum: 100
        httpErrorRanges:
          type: array
          description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy.
          items:
            $ref: '#/components/schemas/HttpErrorRangeParameters'
          x-ms-identifiers: []
    DeliveryRule:
      type: object
      description: A rule that specifies a set of actions and conditions
      properties:
        name:
          type: string
          description: Name of the rule
        order:
          type: integer
          format: int32
          description: 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.
        conditions:
          type: array
          description: A list of conditions that must be matched for the actions to be executed
          items:
            $ref: '#/components/schemas/DeliveryRuleCondition'
          x-ms-identifiers:
          - name
        actions:
          type: array
          description: A list of actions that are executed when all the conditions of a rule are satisfied.
          items:
            $ref: '#/components/schemas/DeliveryRuleAction'
          x-ms-identifiers:
          - name
      required:
      - order
      - actions
    ValidateCustomDomainOutput:
      type: object
      description: Output of custom domain validation.
      properties:
        customDomainValidated:
          type: boolean
          description: Indicates whether the custom domain is valid or not.
          readOnly: true
        reason:
          type: string
          description: The reason why the custom domain is not valid.
          readOnly: true
        message:
          type: string
          description: Error message describing why the custom domain is not valid.
          readOnly: true
    KeyVaultSigningKeyParametersType:
      type: string
      enum:
      - KeyVaultSigningKeyParameters
      x-ms-enum:
        name: KeyVaultSigningKeyParametersType
        modelAsString: true
        values:
        - name: KeyVaultSigningKeyParameters
          value: KeyVaultSigningKeyParameters
    ProbeProtocol:
      type: string
      description: Protocol to use for health probe.
      enum:
      - NotSet
      - Http
      - Https
      x-ms-enum:
        name: ProbeProtocol
        modelAsString: false
    GeoFilter:
      type: object
      description: Rules defining user's geo access within a CDN endpoint.
      properties:
        relativePath:
          type: string
          description: Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.)
        action:
          $ref: '#/components/schemas/GeoFilterActions'
          description: Action of the geo filter, i.e. allow or block access.
        countryCodes:
          type: array
          description: Two letter country or region codes defining user country or region access in a geo filter, e.g. AU, MX, US.
          items:
            type: string
      required:
      - relativePath
      - action
      - countryCodes
    ResourceUsageUnit:
      type: string
      description: Unit of the usage. e.g. count.
      enum:
      - count
      x-ms-enum:
        name: ResourceUsageUnit
        modelAsString: true
        values:
        - name: count
          value: count
    ResourceReference:
      type: object
      description: Reference to another resource.
      properties:
        id:
          type: string
          description: Resource ID.
    DeliveryRuleCondition:
      type: object
      description: A condition for the delivery rule.
      properties:
        name:
          $ref: '#/components/schemas/MatchVariable'
          description: The name of the condition for the delivery rule.
      discriminator:
        propertyName: name
      required:
      - name
    EndpointListResult:
      type: object
      description: The response of a Endpoint list operation.
      properties:
        value:
          type: array
          description: The Endpoint items on this page
          items:
            $ref: '#/components/schemas/Endpoint'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    ResponseBasedDetectedErrorTypes:
      type: string
      description: Type of response errors for real user requests for which origin will be deemed unhealthy
      enum:
      - None
      - TcpErrorsOnly
      - TcpAndHttpErrors
      x-ms-enum:
        name: ResponseBasedDetectedErrorTypes
        modelAsString: false
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.