swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector DeviceServices API
schemes:
- https
tags:
- name: DeviceServices
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.WindowsIoT/deviceServices/{deviceName}
  : get:
      tags:
      - DeviceServices
      description: Get the non-security related metadata of a Windows IoT Device Service.
      operationId: microsoftAzureServicesGet
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/DeviceNameParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/DeviceService'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorDetails'
      deprecated: false
      x-ms-examples:
        Services_GetProperties:
          $ref: ./examples/Service_GetProperties.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Windowsiot Deviceservices Devicename
    put:
      tags:
      - DeviceServices
      summary: Microsoft Azure Create Or Update The Metadata Of A Windows Iot Device Service
      description: Create or update the metadata of a Windows IoT Device Service. The usual pattern to modify a property is to retrieve the Windows IoT Device Service metadata and security metadata, and then combine them with the modified values in a new body to update the Windows IoT Device Service.
      operationId: microsoftAzureServicesCreateorupdate
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/DeviceNameParameter'
      - name: deviceService
        in: body
        description: The Windows IoT Device Service metadata and security metadata.
        required: true
        schema:
          $ref: '#/definitions/DeviceService'
      - name: If-Match
        in: header
        required: false
        type: string
        description: ETag of the Windows IoT Device Service. Do not specify for creating a new Windows IoT Device Service. Required to update an existing Windows IoT Device Service.
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/DeviceService'
        '201':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/DeviceService'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorDetails'
      deprecated: false
      x-ms-examples:
        Service_Create:
          $ref: ./examples/Service_Create.json
    patch:
      tags:
      - DeviceServices
      summary: Microsoft Azure Updates The Metadata Of A Windows Iot Device Service
      description: Updates the metadata of a Windows IoT Device Service. The usual pattern to modify a property is to retrieve the Windows IoT Device Service metadata and security metadata, and then combine them with the modified values in a new body to update the Windows IoT Device Service.
      operationId: microsoftAzureServicesUpdate
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/DeviceNameParameter'
      - name: deviceService
        in: body
        description: The Windows IoT Device Service metadata and security metadata.
        required: true
        schema:
          $ref: '#/definitions/DeviceService'
      - name: If-Match
        in: header
        required: false
        type: string
        description: ETag of the Windows IoT Device Service. Do not specify for creating a brand new Windows IoT Device Service. Required to update an existing Windows IoT Device Service.
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/DeviceService'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorDetails'
      deprecated: false
      x-ms-examples:
        Service_Update:
          $ref: ./examples/Service_Update.json
    delete:
      tags:
      - DeviceServices
      description: Delete a Windows IoT Device Service.
      operationId: microsoftAzureServicesDelete
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/DeviceNameParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/DeviceService'
        '204':
          description: OK. The request has succeeded with no content to return.
          schema:
            $ref: '#/definitions/DeviceService'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorDetails'
      deprecated: false
      x-ms-examples:
        Service_Delete:
          $ref: ./examples/Service_Delete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Windowsiot Deviceservices Devicename
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.WindowsIoT/deviceServices:
    get:
      tags:
      - DeviceServices
      description: Get all the IoT hubs in a resource group.
      operationId: microsoftAzureServicesListbyresourcegroup
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/DeviceServiceDescriptionListResult'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorDetails'
      deprecated: false
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Service_ListByResourceGroup:
          $ref: ./examples/Service_ListByResourceGroup.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Windowsiot Deviceservices
  /subscriptions/{subscriptionId}/providers/Microsoft.WindowsIoT/deviceServices:
    get:
      tags:
      - DeviceServices
      description: Get all the IoT hubs in a subscription.
      operationId: microsoftAzureServicesList
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/DeviceServiceDescriptionListResult'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorDetails'
      deprecated: false
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Service_List:
          $ref: ./examples/Service_List.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Windowsiot Deviceservices
definitions:
  Resource:
    description: The core properties of ARM resources
    properties:
      id:
        readOnly: true
        type: string
        description: Fully qualified resource Id for the resource
      name:
        readOnly: true
        type: string
        description: The name of the resource
      type:
        readOnly: true
        type: string
        description: The type of the resource.
    x-ms-azure-resource: true
  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
  DeviceService:
    description: The description of the Windows IoT Device Service.
    type: object
    properties:
      etag:
        description: The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.
        type: string
      properties:
        description: The properties of a Windows IoT Device Service.
        $ref: '#/definitions/DeviceServiceProperties'
        x-ms-client-flatten: true
    allOf:
    - $ref: '#/definitions/TrackedResource'
  TrackedResource:
    description: The resource model definition for a ARM tracked top level resource
    properties:
      tags:
        type: object
        additionalProperties:
          type: string
        x-ms-mutability:
        - read
        - create
        - update
        description: Resource tags.
      location:
        type: string
        x-ms-mutability:
        - read
        - create
        description: The Azure Region where the resource lives
    allOf:
    - $ref: '#/definitions/Resource'
  DeviceServiceProperties:
    description: The properties of a Windows IoT Device Service.
    type: object
    properties:
      notes:
        description: Windows IoT Device Service notes.
        type: string
      startDate:
        description: Windows IoT Device Service start date,
        type: string
        format: date-time
        readOnly: true
      quantity:
        description: Windows IoT Device Service device allocation,
        type: integer
        format: int64
      billingDomainName:
        description: Windows IoT Device Service ODM AAD domain
        type: string
      adminDomainName:
        description: Windows IoT Device Service OEM AAD domain
        type: string
  DeviceServiceDescriptionListResult:
    description: The JSON-serialized array of DeviceService objects with a next link.
    type: object
    properties:
      value:
        description: The array of DeviceService objects.
        type: array
        items:
          $ref: '#/definitions/DeviceService'
      nextLink:
        description: The next link.
        type: string
        readOnly: true
parameters:
  DeviceNameParameter:
    name: deviceName
    in: path
    description: The name of the Windows IoT Device Service.
    required: true
    type: string
    x-ms-parameter-location: method
  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
  ResourceGroupNameParameter:
    name: resourceGroupName
    description: The name of the resource group that contains the Windows IoT Device Service.
    in: path
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'