Microsoft Azure CustomDomains API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Custom Domains API
tags:
- name: CustomDomains
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains
  : get:
      tags:
      - CustomDomains
      description: Lists all of the existing custom domains within an endpoint.
      operationId: microsoftAzureCustomdomainsListbyendpoint
      x-ms-examples:
        CustomDomains_ListByEndpoint:
          $ref: ./examples/CustomDomains_ListByEndpoint.json
      parameters:
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - name: profileName
        in: path
        description: Name of the CDN profile which is unique within the resource group.
        required: true
        schema:
          type: string
      - name: endpointName
        in: path
        description: Name of the endpoint under the profile which is unique globally.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomDomainListResult'
        default:
          description: CDN error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname Customdomains
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}
  : get:
      tags:
      - CustomDomains
      description: Gets an existing custom domain within an endpoint.
      operationId: microsoftAzureCustomdomainsGet
      x-ms-examples:
        CustomDomains_Get:
          $ref: ./examples/CustomDomains_Get.json
      parameters:
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - name: profileName
        in: path
        description: Name of the CDN profile which is unique within the resource group.
        required: true
        schema:
          type: string
      - name: endpointName
        in: path
        description: Name of the endpoint under the profile which is unique globally.
        required: true
        schema:
          type: string
      - name: customDomainName
        in: path
        description: Name of the custom domain within an endpoint.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomDomain'
        default:
          description: CDN error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname Customdomains Customdomainname
    put:
      tags:
      - CustomDomains
      description: Creates a new custom domain within an endpoint.
      operationId: microsoftAzureCustomdomainsCreate
      x-ms-examples:
        CustomDomains_Create:
          $ref: ./examples/CustomDomains_Create.json
      parameters:
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - name: profileName
        in: path
        description: Name of the CDN profile which is unique within the resource group.
        required: true
        schema:
          type: string
      - name: endpointName
        in: path
        description: Name of the endpoint under the profile which is unique globally.
        required: true
        schema:
          type: string
      - name: customDomainName
        in: path
        description: Name of the custom domain within an endpoint.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomDomain'
        '201':
          description: Created. The request has been fulfilled and a new custom domain has been created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomDomain'
        '202':
          description: Accepted and the operation will complete asynchronously.
          headers:
            location:
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomDomain'
        default:
          description: CDN error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname Customdomains Customdomainname
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomDomainParameters'
        description: Properties required to create a new custom domain.
        required: true
    delete:
      tags:
      - CustomDomains
      description: Deletes an existing custom domain within an endpoint.
      operationId: microsoftAzureCustomdomainsDelete
      x-ms-examples:
        CustomDomains_Delete:
          $ref: ./examples/CustomDomains_Delete.json
      parameters:
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - name: profileName
        in: path
        description: Name of the CDN profile which is unique within the resource group.
        required: true
        schema:
          type: string
      - name: endpointName
        in: path
        description: Name of the endpoint under the profile which is unique globally.
        required: true
        schema:
          type: string
      - name: customDomainName
        in: path
        description: Name of the custom domain within an endpoint.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
        '202':
          description: Accepted and the operation will complete asynchronously.
          headers:
            location:
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomDomain'
        '204':
          description: No Content. The request has been accepted but the custom domain was not found
        default:
          description: CDN error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname Customdomains Customdomainname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/disableCustomHttps
  : post:
      tags:
      - CustomDomains
      description: Disable https delivery of the custom domain.
      operationId: microsoftAzureCustomdomainsDisablecustomhttps
      x-ms-examples:
        CustomDomains_DisableCustomHttps:
          $ref: ./examples/CustomDomains_DisableCustomHttps.json
      parameters:
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - name: profileName
        in: path
        description: Name of the CDN profile which is unique within the resource group.
        required: true
        schema:
          type: string
      - name: endpointName
        in: path
        description: Name of the endpoint under the profile which is unique globally.
        required: true
        schema:
          type: string
      - name: customDomainName
        in: path
        description: Name of the custom domain within an endpoint.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomDomain'
        '202':
          description: Accepted and the operation will complete asynchronously.
          headers:
            location:
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomDomain'
        default:
          description: CDN error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname Customdomains Customdomainname Disablecustomhttps
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/enableCustomHttps
  : post:
      tags:
      - CustomDomains
      description: Enable https delivery of the custom domain.
      operationId: microsoftAzureCustomdomainsEnablecustomhttps
      x-ms-examples:
        CustomDomains_EnableCustomHttpsUsingYourOwnCertificate:
          $ref: ./examples/CustomDomains_EnableCustomHttpsUsingBYOC.json
        CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate:
          $ref: ./examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json
      parameters:
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - name: profileName
        in: path
        description: Name of the CDN profile which is unique within the resource group.
        required: true
        schema:
          type: string
      - name: endpointName
        in: path
        description: Name of the endpoint under the profile which is unique globally.
        required: true
        schema:
          type: string
      - name: customDomainName
        in: path
        description: Name of the custom domain within an endpoint.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomDomain'
        '202':
          description: Accepted and the operation will complete asynchronously.
          headers:
            location:
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomDomain'
        default:
          description: CDN error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname Customdomains Customdomainname Enablecustomhttps
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomDomainHttpsParameters'
        description: The configuration specifying how to enable HTTPS for the custom domain - using CDN managed certificate or user's own certificate. If not specified, enabling ssl uses CDN managed certificate by default.
components:
  schemas:
    ErrorResponse:
      title: Error response
      description: Error response indicates Azure Front Door Standard or Azure Front Door Premium or CDN service is not able to process the incoming request. The reason is provided in the error message.
      type: object
      properties:
        error:
          $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail
    CustomDomainProperties:
      description: The JSON object that contains the properties of the custom domain to create.
      required:
      - hostName
      properties:
        hostName:
          description: The host name of the custom domain. Must be a domain name.
          type: string
        resourceState:
          description: Resource status of the custom domain.
          readOnly: true
          enum:
          - Creating
          - Active
          - Deleting
          type: string
          x-ms-enum:
            name: CustomDomainResourceState
            modelAsString: true
        customHttpsProvisioningState:
          description: Provisioning status of the custom domain.
          readOnly: true
          enum:
          - Enabling
          - Enabled
          - Disabling
          - Disabled
          - Failed
          type: string
          x-ms-enum:
            name: CustomHttpsProvisioningState
            modelAsString: true
        customHttpsProvisioningSubstate:
          description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.
          readOnly: true
          enum:
          - SubmittingDomainControlValidationRequest
          - PendingDomainControlValidationREquestApproval
          - DomainControlValidationRequestApproved
          - DomainControlValidationRequestRejected
          - DomainControlValidationRequestTimedOut
          - IssuingCertificate
          - DeployingCertificate
          - CertificateDeployed
          - DeletingCertificate
          - CertificateDeleted
          type: string
          x-ms-enum:
            name: CustomHttpsProvisioningSubstate
            modelAsString: true
        customHttpsParameters:
          description: Certificate parameters for securing custom HTTPS
          $ref: '#/components/schemas/CustomDomainHttpsParameters'
        validationData:
          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.
          type: string
        provisioningState:
          description: Provisioning status of Custom Https of the custom domain.
          readOnly: true
          enum:
          - Enabling
          - Enabled
          - Disabling
          - Disabled
          - Failed
          type: string
          x-ms-enum:
            name: CustomHttpsProvisioningState
            modelAsString: true
    CustomDomainPropertiesParameters:
      description: The JSON object that contains the properties of the custom domain to create.
      required:
      - hostName
      properties:
        hostName:
          description: The host name of the custom domain. Must be a domain name.
          type: string
    CustomDomain:
      description: Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com.
      type: object
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/CustomDomainProperties'
    IdentityType:
      description: The type of identity that creates/modifies resources
      type: string
      enum:
      - user
      - application
      - managedIdentity
      - key
      x-ms-enum:
        name: IdentityType
        modelAsString: true
    SystemData:
      description: Read only system data
      readOnly: true
      type: object
      properties:
        createdBy:
          type: string
          description: An identifier for the identity that created the resource
        createdByType:
          $ref: '#/components/schemas/IdentityType'
          description: The type of identity that created the resource
        createdAt:
          type: string
          format: date-time
          description: The timestamp of resource creation (UTC)
        lastModifiedBy:
          type: string
          description: An identifier for the identity that last modified the resource
        lastModifiedByType:
          $ref: '#/components/schemas/IdentityType'
          description: The type of identity that last modified the resource
        lastModifiedAt:
          type: string
          format: date-time
          description: The timestamp of resource last modification (UTC)
    Resource:
      description: The core properties of ARM resources
      properties:
        id:
          description: Resource ID.
          readOnly: true
          type: string
        name:
          description: Resource name.
          readOnly: true
          type: string
        type:
          description: Resource type.
          readOnly: true
          type: string
        systemData:
          $ref: '#/components/schemas/SystemData'
          readOnly: true
      x-ms-azure-resource: true
    CustomDomainListResult:
      description: Result of the request to list custom domains. It contains a list of custom domain objects and a URL link to get the next set of results.
      properties:
        value:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/CustomDomain'
          description: List of CDN CustomDomains within an endpoint.
        nextLink:
          type: string
          description: URL to get the next set of custom domain objects if there are any.
    CustomDomainHttpsParameters:
      description: The JSON object that contains the properties to secure a custom domain.
      discriminator:
        propertyName: certificateSource
      required:
      - certificateSource
      - protocolType
      properties:
        certificateSource:
          description: Defines the source of the SSL certificate.
          enum:
          - AzureKeyVault
          - Cdn
          type: string
          x-ms-enum:
            name: CertificateSource
            modelAsString: true
        protocolType:
          description: Defines the TLS extension protocol that is used for secure delivery.
          enum:
          - ServerNameIndication
          - IPBased
          type: string
          x-ms-enum:
            name: ProtocolType
            modelAsString: true
        minimumTlsVersion:
          description: TLS protocol version that will be used for Https
          enum:
          - None
          - TLS10
          - TLS12
          type: string
          x-ms-enum:
            name: MinimumTlsVersion
            modelAsString: false
    ProxyResource:
      description: The resource model definition for a ARM proxy resource. It will have everything other than required location and tags
      allOf:
      - $ref: '#/components/schemas/Resource'
      properties: {}
    CustomDomainParameters:
      description: The customDomain JSON object required for custom domain creation or update.
      type: object
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/CustomDomainPropertiesParameters'
  parameters:
    apiVersionParameter:
      name: api-version
      in: query
      required: true
      description: Version of the API to be used with the client request. Current version is 2023-05-01.
      schema:
        type: string
    resourceGroupNameParameter:
      name: resourceGroupName
      in: path
      required: true
      x-ms-parameter-location: method
      description: Name of the Resource group within the Azure subscription.
      schema:
        type: string
        maxLength: 90
        minLength: 1
        pattern: ^[-\w\._\(\)]+$
    subscriptionIdParameter:
      name: subscriptionId
      in: path
      description: Azure Subscription ID.
      required: true
      schema:
        type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'