swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector UserSession API
schemes:
- https
tags:
- name: UserSession
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/userSessions
  : get:
      tags:
      - UserSession
      operationId: microsoftAzureUsersessionsListbyhostpool
      description: List userSessions.
      x-ms-examples:
        UserSession_ListByHostPool:
          $ref: ./examples/UserSession_ListByHostPool.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/HostPoolNameParameter'
      - name: $filter
        in: query
        required: false
        type: string
        description: OData filter expression. Valid properties for filtering are userprincipalname and sessionstate.
      - 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 user sessions in host pool.
          schema:
            $ref: '#/definitions/UserSessionList'
        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 Hostpools Hostpoolname Usersessions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}
  : get:
      tags:
      - UserSession
      operationId: microsoftAzureUsersessionsGet
      description: Get a userSession.
      x-ms-examples:
        UserSession_Get:
          $ref: ./examples/UserSession_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/HostPoolNameParameter'
      - $ref: '#/parameters/SessionHostNameParameter'
      - $ref: '#/parameters/UserSessionIdParameter'
      responses:
        '200':
          description: Successfully retrieved user session.
          schema:
            $ref: '#/definitions/UserSession'
        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 Hostpools Hostpoolname Sessionhosts Sessionhostname Usersessions Usersessionid
    delete:
      tags:
      - UserSession
      operationId: microsoftAzureUsersessionsDelete
      description: Remove a userSession.
      x-ms-examples:
        UserSession_Delete:
          $ref: ./examples/UserSession_Delete.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/HostPoolNameParameter'
      - $ref: '#/parameters/SessionHostNameParameter'
      - $ref: '#/parameters/UserSessionIdParameter'
      - name: force
        in: query
        required: false
        type: boolean
        description: Force flag to login off userSession.
      responses:
        '200':
          description: Successfully removed user session.
        '204':
          description: User session does not exist.
        default:
          description: Automation error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Hostpools Hostpoolname Sessionhosts Sessionhostname Usersessions Usersessionid
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions
  : get:
      tags:
      - UserSession
      operationId: microsoftAzureUsersessionsList
      description: List userSessions.
      x-ms-examples:
        UserSession_List:
          $ref: ./examples/UserSession_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/HostPoolNameParameter'
      - $ref: '#/parameters/SessionHostNameParameter'
      - 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 user sessions in session host.
          schema:
            $ref: '#/definitions/UserSessionList'
        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 Hostpools Hostpoolname Sessionhosts Sessionhostname Usersessions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/disconnect
  : post:
      tags:
      - UserSession
      operationId: microsoftAzureUsersessionsDisconnect
      description: Disconnect a userSession.
      x-ms-examples:
        UserSession_Disconnect_Post:
          $ref: ./examples/UserSession_Disconnect_Post.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/HostPoolNameParameter'
      - $ref: '#/parameters/SessionHostNameParameter'
      - $ref: '#/parameters/UserSessionIdParameter'
      responses:
        '200':
          description: Successfully disconnected user session.
        default:
          description: Automation error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Hostpools Hostpoolname Sessionhosts Sessionhostname Usersessions Usersessionid Disconnect
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/sendMessage
  : post:
      tags:
      - UserSession
      operationId: microsoftAzureUsersessionsSendmessage
      description: Send a message to a user.
      x-ms-examples:
        UserSession_SendMessage_Post:
          $ref: ./examples/UserSession_SendMessage_Post.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/HostPoolNameParameter'
      - $ref: '#/parameters/SessionHostNameParameter'
      - $ref: '#/parameters/UserSessionIdParameter'
      - name: sendMessage
        description: Object containing message includes title and message body
        in: body
        required: false
        schema:
          $ref: '#/definitions/SendMessage'
      responses:
        '200':
          description: Successfully sent message to user session.
        default:
          description: Automation error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Hostpools Hostpoolname Sessionhosts Sessionhostname Usersessions Usersessionid Sendmessage
definitions:
  SendMessage:
    description: Represents message sent to a UserSession.
    type: object
    properties:
      messageTitle:
        type: string
        description: Title of message.
      messageBody:
        type: string
        description: Body of message.
  CloudError:
    description: Cloud error object.
    type: object
    x-ms-external: true
    properties:
      error:
        $ref: '#/definitions/CloudErrorProperties'
  UserSessionList:
    type: object
    title: UserSessionList
    description: List of UserSession definitions.
    properties:
      value:
        type: array
        description: List of UserSession definitions.
        items:
          $ref: '#/definitions/UserSession'
      nextLink:
        type: string
        readOnly: true
        description: Link to the next page of results.
  UserSession:
    type: object
    description: Represents a UserSession definition.
    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 UserSession
        x-ms-client-flatten: true
        $ref: '#/definitions/UserSessionProperties'
  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
  UserSessionProperties:
    description: Schema for UserSession properties.
    type: object
    properties:
      objectId:
        type: string
        description: ObjectId of user session. (internal use)
        readOnly: true
      userPrincipalName:
        type: string
        description: The user principal name.
      applicationType:
        enum:
        - RemoteApp
        - Desktop
        x-ms-enum:
          name: ApplicationType
          modelAsString: true
        type: string
        description: Application type of application.
      sessionState:
        enum:
        - Unknown
        - Active
        - Disconnected
        - Pending
        - LogOff
        - UserProfileDiskMounted
        x-ms-enum:
          name: SessionState
          modelAsString: true
        type: string
        description: State of user session.
      activeDirectoryUserName:
        type: string
        description: The active directory user name.
      createTime:
        format: date-time
        type: string
        description: The timestamp of the user session create.
parameters:
  SessionHostNameParameter:
    name: sessionHostName
    in: path
    required: true
    type: string
    description: The name of the session host within the specified host pool
    maxLength: 48
    minLength: 3
    x-ms-parameter-location: method
  HostPoolNameParameter:
    name: hostPoolName
    in: path
    required: true
    type: string
    description: The name of the host pool within the specified resource group
    maxLength: 64
    minLength: 3
    x-ms-parameter-location: method
  UserSessionIdParameter:
    name: userSessionId
    in: path
    required: true
    type: string
    description: The name of the user session within the specified session host
    maxLength: 24
    minLength: 1
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'