Microsoft Azure CheckNameAvailability API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Check Name Availability API
tags:
- name: CheckNameAvailability
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.AgFoodPlatform/checkNameAvailability:
    post:
      tags:
      - CheckNameAvailability
      description: Checks the name availability of the resource with requested resource name.
      operationId: microsoftAzureChecknameavailabilityChecknameavailability
      parameters:
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/CheckNameAvailabilityResponse
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse
      x-ms-examples:
        CheckNameAvailability_CheckNameAvailability_AlreadyExists:
          $ref: ./examples/CheckNameAvailability_CheckNameAvailability_AlreadyExists.json
        CheckNameAvailability_CheckNameAvailability_Available:
          $ref: ./examples/CheckNameAvailability_CheckNameAvailability_Available.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Agfoodplatform Checknameavailability
      requestBody:
        content:
          application/json:
            schema:
              $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/CheckNameAvailabilityRequest
        description: NameAvailabilityRequest object.
        required: true
  /subscriptions/{subscriptionId}/providers/Microsoft.DigitalTwins/locations/{location}/checkNameAvailability:
    post:
      tags:
      - CheckNameAvailability
      description: Check if a DigitalTwinsInstance name is available.
      operationId: microsoftAzureDigitaltwinsChecknameavailability
      x-ms-examples:
        Check name Availability:
          $ref: ./examples/DigitalTwinsCheckNameAvailability_example.json
      parameters:
      - $ref: '#/components/parameters/api-version'
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/location'
      responses:
        '200':
          description: This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the DigitalTwins service name is available. If the name is not available, the body contains the reason.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckNameResult'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Digitaltwins Locations Location Checknameavailability
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckNameRequest'
        description: Set the name parameter in the DigitalTwinsInstanceCheckName structure to the name of the DigitalTwinsInstance to check.
        required: true
  /providers/Microsoft.Cdn/checkNameAvailability:
    post:
      tags:
      - CheckNameAvailability
      description: Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.
      operationId: microsoftAzureChecknameavailability
      x-ms-examples:
        CheckNameAvailability:
          $ref: ./examples/CheckNameAvailability.json
      parameters:
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckNameAvailabilityOutput'
        default:
          description: CDN error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
      summary: Microsoft Azure Post Providers Microsoft Cdn Checknameavailability
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckNameAvailabilityInput'
        description: Input to check.
        required: true
  /{scope}/providers/Microsoft.Help/checkNameAvailability:
    post:
      tags:
      - CheckNameAvailability
      description: This API is used to check the uniqueness of a resource name used for a diagnostic, troubleshooter or solutions
      operationId: microsoftAzureChecknameavailabilityPost
      parameters:
      - $ref: '#/components/parameters/ScopeParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Response for the availability of the requested resource name.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckNameAvailabilityResponse'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Example when name is available for a Diagnostic resource:
          $ref: ./examples/CheckNameAvailabilityForDiagnosticWhenNameIsAvailable.json
        Example when name is not available for a Diagnostic resource:
          $ref: ./examples/CheckNameAvailabilityForDiagnosticWhenNameIsNotAvailable.json
      summary: Microsoft Azure Post Scope Providers Microsoft Help Checknameavailability
      requestBody:
        content:
          application/json:
            schema:
              $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityRequest
        description: The required parameters for availability check.
  /providers/Microsoft.Management/checkNameAvailability:
    post:
      tags:
      - CheckNameAvailability
      operationId: microsoftAzureChecknameavailability
      description: Checks if the specified management group name is valid and unique
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter_2'
      - $ref: '#/components/parameters/CheckNameAvailabilityParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckNameAvailabilityResult'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_3'
      x-ms-examples:
        CheckManagementGroupNameAvailability:
          $ref: ./examples/CheckManagementGroupNameAvailability.json
      summary: Microsoft Azure Post Providers Microsoft Management Checknameavailability
  /subscriptions/{subscriptionId}/providers/Microsoft.DBforMariaDB/checkNameAvailability:
    post:
      tags:
      - CheckNameAvailability
      operationId: microsoftAzureChecknameavailabilityExecute
      x-ms-examples:
        NameAvailability:
          $ref: ./examples/CheckNameAvailability.json
      description: Check the availability of name for resource
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter_3'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NameAvailability'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Dbformariadb Checknameavailability
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NameAvailabilityRequest'
        description: The required parameters for checking if resource name is available.
        required: true
  /subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/checkNameAvailability:
    post:
      tags:
      - CheckNameAvailability
      operationId: microsoftAzureChecknameavailabilityExecute
      x-ms-examples:
        Check name availability:
          $ref: ./examples/CheckNameAvailability.json
      description: Check the availability of name for server
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../common-types/v1/common-types.json#/parameters/LocationNameParameter
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NameAvailability_2'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Dbformysql Locations Locationname Checknameavailability
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NameAvailabilityRequest_2'
        description: The required parameters for checking if server name is available.
        required: true
  /subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/checkNameAvailability:
    post:
      tags:
      - CheckNameAvailability
      operationId: microsoftAzureChecknameavailabilitywithoutlocationExecute
      x-ms-examples:
        Check name availability:
          $ref: ./examples/CheckNameAvailability.json
      description: Check the availability of name for server
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NameAvailability_2'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Dbformysql Checknameavailability
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NameAvailabilityRequest_2'
        description: The required parameters for checking if server name is available.
        required: true
components:
  schemas:
    CheckNameRequest:
      type: object
      properties:
        name:
          type: string
          description: Resource name.
        type:
          type: string
          enum:
          - Microsoft.DigitalTwins/digitalTwinsInstances
          x-ms-enum:
            name: Type
            modelAsString: false
          description: The type of resource, for instance Microsoft.DigitalTwins/digitalTwinsInstances.
      required:
      - name
      - type
      description: The result returned from a database check name availability request.
    NameAvailabilityRequest_2:
      type: object
      required:
      - name
      properties:
        name:
          type: string
          description: Resource name to verify.
        type:
          type: string
          description: Resource type used for verification.
      description: Request from client to check resource name availability.
    CheckNameResult:
      type: object
      properties:
        nameAvailable:
          type: boolean
          description: Specifies a Boolean value that indicates if the name is available.
        name:
          type: string
          description: The name that was checked.
        message:
          type: string
          description: Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated.
        reason:
          type: string
          enum:
          - Invalid
          - AlreadyExists
          x-ms-enum:
            name: reason
            modelAsString: true
          description: Message providing the reason why the given name is invalid.
      description: The result returned from a check name availability request.
    ErrorResponse_2:
      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
    NameAvailability_2:
      type: object
      properties:
        message:
          type: string
          description: Error Message.
        nameAvailable:
          type: boolean
          description: Indicates whether the resource name is available.
        reason:
          type: string
          description: Reason for name being unavailable.
      description: Represents a resource name availability.
    CheckNameAvailabilityResponse:
      description: Response for whether the requested resource name is available or not.
      type: object
      properties:
        nameAvailable:
          description: Returns true or false depending on the availability of the name
          type: boolean
        reason:
          description: Reason for why value is not available. This field is returned if nameAvailable is false.
          type: string
        message:
          description: Gets an error message explaining the 'reason' value with more details. This field is returned iif nameAvailable is false.
          type: string
    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
    ErrorDetails:
      description: The details of the error.
      properties:
        code:
          description: One of a server-defined set of error codes.
          type: string
        message:
          description: A human-readable representation of the error.
          type: string
        details:
          description: A human-readable representation of the error's details.
          type: string
    ErrorResponse_3:
      description: The error object.
      properties:
        error:
          title: Error
          $ref: '#/components/schemas/ErrorDetails'
    CheckNameAvailabilityResult:
      description: Describes the result of the request to check management group name availability.
      properties:
        nameAvailable:
          description: Required. True indicates name is valid and available. False indicates the name is invalid, unavailable, or both.
          type: boolean
          readOnly: true
        reason:
          description: Required if nameAvailable == false. Invalid indicates the name provided does not match the resource provider's naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable.
          type: string
          enum:
          - Invalid
          - AlreadyExists
          x-ms-enum:
            name: Reason
            modelAsString: false
            values:
            - value: Invalid
            - value: AlreadyExists
          readOnly: true
        message:
          description: Required if nameAvailable == false. Localized. If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that is already in use, and direct them to select a different name.
          type: string
          readOnly: true
    NameAvailabilityRequest:
      required:
      - name
      properties:
        name:
          type: string
          description: Resource name to verify.
        type:
          type: string
          description: Resource type used for verification.
      description: Request from client to check resource name availability.
    NameAvailability:
      properties:
        message:
          type: string
          description: Error Message.
        nameAvailable:
          type: boolean
          description: Indicates whether the resource name is available.
        reason:
          type: string
          description: Reason for name being unavailable.
      description: Represents a resource name availability.
    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: '#/components/schemas/ResourceType'
    ErrorDefinition:
      description: Error definition.
      properties:
        code:
          description: Service specific error code which serves as the substatus for the HTTP error code.
          type: string
          readOnly: true
        message:
          description: Description of the error.
          type: string
          readOnly: true
        details:
          description: Internal error details.
          type: array
          items:
            $ref: '#/components/schemas/ErrorDefinition'
          readOnly: true
    ErrorResponse:
      description: Error response.
      properties:
        error:
          description: Error description
          $ref: '#/components/schemas/ErrorDefinition'
    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
    CheckNameAvailabilityRequest:
      description: Management group name availability check parameters.
      type: object
      properties:
        name:
          type: string
          description: the name to check for availability
        type:
          type: string
          enum:
          - /providers/Microsoft.Management/managementGroups
          x-ms-enum:
            name: Type
            modelAsString: false
            values:
            - value: /providers/Microsoft.Management/managementGroups
          description: fully qualified resource type which includes provider namespace
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: Client Api Version.
      x-ms-parameter-location: client
      schema:
        type: string
    location:
      name: location
      in: path
      description: Location of DigitalTwinsInstance.
      x-ms-parameter-location: method
      required: true
      schema:
        type: string
        minLength: 3
    subscriptionId:
      name: subscriptionId
      in: path
      description: The subscription identifier.
      required: true
      schema:
        type: string
    ScopeParameter:
      name: scope
      in: path
      required: true
      description: 'scope = resourceUri of affected resource.<br/> For example: /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read '
      x-ms-parameter-location: method
      x-ms-skip-url-encoding: true
      schema:
        type: string
    CheckNameAvailabilityParameter:
      name: checkNameAvailabilityRequest
      in: body
      required: true
      description: Management group name availability check parameters.
      schema:
        $ref: '#/components/schemas/CheckNameAvailabilityRequest'
      x-ms-parameter-location: client
    ApiVersionParameter_2:
      name: api-version
      in: query
      required: true
      description: Version of the API to be used with the client request. The current version is 2018-01-01-preview.
      schema:
        type: string
    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
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      required: true
      description: The subscription ID that identifies an Azure subscription.
      schema:
        type: string
    api-version:
      name: api-version
      in: query
      description: Version of the DigitalTwinsInstance Management API.
      required: true
      schema:
        type: string
        enum:
        - 2020-03-01-preview
        minLength: 10
    ApiVersionParameter_3:
      name: api-version
      in: query
      required: true
      description: The API version to use for the request.
      schema:
        type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'