swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector CheckDeviceServiceNameAvailability API
schemes:
- https
tags:
- name: CheckDeviceServiceNameAvailability
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.WindowsIoT/checkDeviceServiceNameAvailability:
    post:
      tags:
      - CheckDeviceServiceNameAvailability
      description: Check if a Windows IoT Device Service name is available.
      operationId: microsoftAzureServicesCheckdeviceservicenameavailability
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: deviceServiceCheckNameAvailabilityParameters
        in: body
        description: Set the name parameter in the DeviceServiceCheckNameAvailabilityParameters structure to the name of the Windows IoT Device Service to check.
        required: true
        schema:
          $ref: '#/definitions/DeviceServiceCheckNameAvailabilityParameters'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/DeviceServiceNameAvailabilityInfo'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorDetails'
      deprecated: false
      x-ms-examples:
        Service_CheckNameAvailability:
          $ref: ./examples/Service_CheckNameAvailability.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Windowsiot Checkdeviceservicenameavailability
definitions:
  ErrorDetails:
    description: The details of the error.
    properties:
      error:
        type: object
        description: The error object.
        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
          target:
            description: The target of the particular error.
            type: string
          details:
            description: A human-readable representation of the error's details.
            type: string
  DeviceServiceNameAvailabilityInfo:
    description: The properties indicating whether a given Windows IoT Device Service name is available.
    type: object
    properties:
      nameAvailable:
        description: The value which indicates whether the provided name is available.
        type: boolean
        readOnly: true
      reason:
        description: The reason for unavailability.
        enum:
        - Invalid
        - AlreadyExists
        type: string
        readOnly: true
        x-ms-enum:
          name: serviceNameUnavailabilityReason
          modelAsString: false
      message:
        description: The detailed reason message.
        type: string
  DeviceServiceCheckNameAvailabilityParameters:
    description: Input values.
    type: object
    properties:
      name:
        description: The name of the Windows IoT Device Service to check.
        type: string
    required:
    - name
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    description: The version of the API.
    required: true
    type: string
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    description: The subscription identifier.
    required: true
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'