swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Desktop API
schemes:
- https
tags:
- name: Desktop
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops/{desktopName}
  : get:
      tags:
      - Desktop
      operationId: microsoftAzureDesktopsGet
      description: Get a desktop.
      x-ms-examples:
        Desktop_Get:
          $ref: ./examples/Desktop_Get.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/ApplicationGroupNameParameter'
      - $ref: '#/parameters/DesktopNameParameter'
      responses:
        '200':
          description: Successfully retrieved desktop.
          schema:
            $ref: '#/definitions/Desktop'
        default:
          description: Automation error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Applicationgroups Applicationgroupname Desktops Desktopname
    patch:
      tags:
      - Desktop
      operationId: microsoftAzureDesktopsUpdate
      description: Update a desktop.
      x-ms-examples:
        Desktop_Update:
          $ref: ./examples/Desktop_Update.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/ApplicationGroupNameParameter'
      - $ref: '#/parameters/DesktopNameParameter'
      - name: desktop
        description: Object containing Desktop definitions.
        in: body
        required: false
        schema:
          $ref: '#/definitions/DesktopPatch'
      responses:
        '200':
          description: Successfully updated desktop.
          schema:
            $ref: '#/definitions/Desktop'
        default:
          description: Automation error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Applicationgroups Applicationgroupname Desktops Desktopname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops
  : get:
      tags:
      - Desktop
      operationId: microsoftAzureDesktopsList
      description: List desktops.
      x-ms-examples:
        Desktop_List:
          $ref: ./examples/Desktop_List.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/ApplicationGroupNameParameter'
      - name: pageSize
        in: query
        required: false
        type: integer
        format: int32
        description: Number of items per page.
      - name: isDescending
        in: query
        required: false
        type: boolean
        description: Indicates whether the collection is descending.
      - name: initialSkip
        in: query
        required: false
        type: integer
        format: int32
        description: Initial number of items to skip.
      responses:
        '200':
          description: Successfully retrieved desktops in application group.
          schema:
            $ref: '#/definitions/DesktopList'
        default:
          description: Automation error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Applicationgroups Applicationgroupname Desktops
definitions:
  DesktopProperties:
    description: Schema for Desktop properties.
    type: object
    properties:
      objectId:
        type: string
        description: ObjectId of Desktop. (internal use)
        readOnly: true
      description:
        type: string
        description: Description of Desktop.
      friendlyName:
        type: string
        description: Friendly name of Desktop.
      iconHash:
        readOnly: true
        type: string
        description: Hash of the icon.
      iconContent:
        readOnly: true
        type: string
        format: byte
        description: The icon a 64 bit string as a byte array.
  CloudError:
    description: Cloud error object.
    type: object
    x-ms-external: true
    properties:
      error:
        $ref: '#/definitions/CloudErrorProperties'
  DesktopPatch:
    type: object
    description: Desktop properties that can be patched.
    properties:
      tags:
        type: object
        additionalProperties:
          type: string
        description: tags to be updated
      properties:
        description: Detailed properties for Desktop
        x-ms-client-flatten: true
        $ref: '#/definitions/DesktopPatchProperties'
  DesktopPatchProperties:
    description: Desktop properties that can be patched.
    type: object
    properties:
      description:
        type: string
        description: Description of Desktop.
      friendlyName:
        type: string
        description: Friendly name of Desktop.
  Desktop:
    description: Schema for Desktop properties.
    type: object
    allOf:
    - $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/Resource
    properties:
      systemData:
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
        description: Metadata pertaining to creation and last modification of the resource.
      properties:
        description: Detailed properties for Desktop
        x-ms-client-flatten: true
        $ref: '#/definitions/DesktopProperties'
  CloudErrorProperties:
    description: Cloud error object properties.
    type: object
    properties:
      code:
        description: Error code
        type: string
      message:
        description: Error message indicating why the operation failed.
        type: string
  DesktopList:
    type: object
    title: DesktopList
    description: List of Desktop definitions.
    properties:
      value:
        type: array
        description: List of Desktop definitions.
        items:
          $ref: '#/definitions/Desktop'
      nextLink:
        type: string
        readOnly: true
        description: Link to the next page of results.
parameters:
  ApplicationGroupNameParameter:
    name: applicationGroupName
    in: path
    required: true
    type: string
    description: The name of the application group
    maxLength: 64
    minLength: 3
    x-ms-parameter-location: method
  DesktopNameParameter:
    name: desktopName
    in: path
    required: true
    type: string
    description: The name of the desktop within the specified desktop group
    maxLength: 24
    minLength: 3
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'