swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector NameAvailability API
schemes:
- https
tags:
- name: NameAvailability
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/checkNameAvailability
  : post:
      tags:
      - NameAvailability
      summary: Microsoft Azure Check Availability Of Engagementfabric Resource
      operationId: microsoftAzureChecknameavailability
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - name: parameters
        in: body
        description: Parameter describing the name to be checked
        required: true
        schema:
          $ref: '#/definitions/CheckNameAvailabilityParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/CheckNameAvailabilityResult'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        CheckNameAvailabilityExample:
          $ref: ./examples/CheckNameAvailabilityExample.json
      description: Needs a more full description created.
  /subscriptions/{subscriptionId}/providers/Microsoft.VideoIndexer/checkNameAvailability:
    post:
      tags:
      - NameAvailability
      operationId: microsoftAzureAccountsChecknameavailability
      description: Checks that the Video Indexer account name is valid and is not already in use.
      x-ms-examples:
        Check free account name availability:
          $ref: ./examples/ViAccountCheckNameAvailabilityFree.json
        Check taken account name availability:
          $ref: ./examples/ViAccountCheckNameAvailabilityTaken.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
      - name: checkNameAvailabilityParameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/AccountCheckNameAvailabilityParameters'
        description: The name of the Video Indexer account. Name must be unique globally
      responses:
        '200':
          description: OK - Operation to check the Video Indexer account name availability was successful. Ok does not indicate the name is available, the body of the response does.
          schema:
            $ref: '#/definitions/CheckNameAvailabilityResult_2'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Videoindexer Checknameavailability
definitions:
  ErrorDefinition:
    description: Error definition.
    type: object
    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: '#/definitions/ErrorDefinition'
        readOnly: true
  ErrorResponse:
    description: Error response.
    type: object
    properties:
      error:
        $ref: '#/definitions/ErrorDefinition'
        description: The error details.
  CloudError:
    description: The default error response
    type: object
    properties:
      error:
        $ref: '#/definitions/CloudErrorBody'
        description: Content of the error
    x-ms-external: true
  CheckNameAvailabilityResult:
    description: The result of name availability check
    type: object
    properties:
      nameAvailable:
        description: The name to be checked
        type: boolean
        readOnly: true
      reason:
        $ref: '#/definitions/CheckNameUnavailableReason'
        description: The reason if name is unavailable
        readOnly: true
      message:
        description: The message if name is unavailable
        type: string
        readOnly: true
  CloudErrorBody:
    description: Content of the default error response
    type: object
    properties:
      code:
        description: The error code
        type: string
      message:
        description: The error message
        type: string
      target:
        description: The target of the particular error
        type: string
      details:
        description: The list of additional details
        type: array
        items:
          $ref: '#/definitions/CloudErrorBody'
    x-ms-external: true
  AccountCheckNameAvailabilityParameters:
    type: object
    properties:
      name:
        type: string
        description: The VideoIndexer account name.
      type:
        type: string
        enum:
        - Microsoft.VideoIndexer/accounts
        x-ms-enum:
          name: Type
          modelAsString: true
        description: The type of resource, Microsoft.VideoIndexer/accounts
    required:
    - name
    - type
    description: The parameters used to check the availability of the Video Indexer account name.
  CheckNameAvailabilityParameter:
    description: The parameter for name availability check
    required:
    - name
    - type
    type: object
    properties:
      name:
        description: The name to be checked
        type: string
      type:
        description: The fully qualified resource type for the name to be checked
        type: string
  CheckNameAvailabilityResult_2:
    type: object
    properties:
      nameAvailable:
        readOnly: true
        type: boolean
        description: Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken.
      reason:
        readOnly: true
        type: string
        description: Gets the reason that a Video Indexer account name could not be used. The Reason element is only returned if NameAvailable is false.
        enum:
        - AlreadyExists
        x-ms-enum:
          name: Reason
          modelAsString: true
      message:
        readOnly: true
        type: string
        description: Gets an error message explaining the Reason value in more detail.
    description: The CheckNameAvailability operation response.
  CheckNameUnavailableReason:
    description: The reason of name availability result
    enum:
    - Invalid
    - AlreadyExists
    type: string
    x-ms-enum:
      name: CheckNameUnavailableReason
      modelAsString: true
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    description: API version
    required: true
    type: string
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    description: Subscription ID
    required: true
    type: string
  ResourceGroupNameParameter:
    name: resourceGroupName
    in: path
    description: Resource Group Name
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'