swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector CheckNameAvailabilityWithSubscription API
schemes:
- https
tags:
- name: CheckNameAvailabilityWithSubscription
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Cdn/checkNameAvailability:
    post:
      tags:
      - CheckNameAvailabilityWithSubscription
      description: Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.
      operationId: microsoftAzureChecknameavailabilitywithsubscription
      x-ms-examples:
        CheckNameAvailabilityWithSubscription:
          $ref: ./examples/CheckNameAvailabilityWithSubscription.json
      parameters:
      - name: checkNameAvailabilityInput
        in: body
        description: Input to check.
        required: true
        schema:
          $ref: '#/definitions/CheckNameAvailabilityInput'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/CheckNameAvailabilityOutput'
        default:
          description: CDN error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Cdn Checknameavailability
definitions:
  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
  CheckNameAvailabilityInput:
    description: Input of CheckNameAvailability API.
    type: object
    required:
    - name
    - type
    properties:
      name:
        description: The resource name to validate.
        type: string
      type:
        description: The type of the resource whose name is to be validated.
        $ref: '#/definitions/ResourceType'
  ResourceType:
    description: Type of CDN resource used in CheckNameAvailability.
    enum:
    - Microsoft.Cdn/Profiles/Endpoints
    - Microsoft.Cdn/Profiles/AfdEndpoints
    type: string
    x-ms-enum:
      name: ResourceType
      modelAsString: true
  CheckNameAvailabilityOutput:
    description: Output of check name availability API.
    type: object
    properties:
      nameAvailable:
        description: Indicates whether the name is available.
        readOnly: true
        type: boolean
      reason:
        description: The reason why the name is not available.
        readOnly: true
        type: string
      message:
        description: The detailed error message describing why the name is not available.
        readOnly: true
        type: string
parameters:
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: Azure Subscription ID.
    required: true
    type: string
  apiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Version of the API to be used with the client request. Current version is 2023-05-01.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'