swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector SessionHostManagement API
schemes:
- https
tags:
- name: SessionHostManagement
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default
  : put:
      tags:
      - SessionHostManagement
      operationId: microsoftAzureSessionhostmanagementsCreateorupdate
      description: Create or update a SessionHostManagement.
      x-ms-examples:
        SessionHostManagements_Create:
          $ref: ./examples/SessionHostManagements_Create.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/HostPoolNameParameter'
      - name: sessionHostManagement
        description: Object containing SessionHostManagement definitions.
        in: body
        required: true
        schema:
          $ref: '#/definitions/SessionHostManagement'
      responses:
        '200':
          description: Successfully updated SessionHostManagement.
          schema:
            $ref: '#/definitions/SessionHostManagement'
        '201':
          description: Successfully created SessionHostManagement.
          schema:
            $ref: '#/definitions/SessionHostManagement'
        default:
          description: Automation error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Hostpools Hostpoolname Sessionhostmanagements Default
    patch:
      tags:
      - SessionHostManagement
      operationId: microsoftAzureSessionhostmanagementsUpdate
      description: Update a SessionHostManagement.
      x-ms-examples:
        SessionHostManagements_Update:
          $ref: ./examples/SessionHostManagements_Update.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/HostPoolNameParameter'
      - name: sessionHostManagement
        description: Object containing SessionHostManagement definitions.
        in: body
        required: false
        schema:
          $ref: '#/definitions/SessionHostManagementPatch'
      responses:
        '200':
          description: Update SessionHostManagement success.
          schema:
            $ref: '#/definitions/SessionHostManagement'
        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 Hostpools Hostpoolname Sessionhostmanagements Default
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/initiateSessionHostUpdate
  : post:
      tags:
      - SessionHostManagement
      operationId: microsoftAzureInitiatesessionhostupdatePost
      description: Initiates a hostpool update or schedule an update for the future.
      x-ms-examples:
        HostPools_Update_Post:
          $ref: ./examples/SessionHostManagements_UpdateSessionHosts_Post.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/HostPoolNameParameter'
      - name: updateSessionHostsRequestBody
        description: Object containing the definition for properties to be used in the sessionHostUpdate validation.
        in: body
        schema:
          $ref: '#/definitions/UpdateSessionHostsRequestBody'
      responses:
        '202':
          description: Successfully initiated hostpool update.
          headers:
            Location:
              description: The URL of the resource used to check the status of the asynchronous operation.
              type: string
            Azure-AsyncOperation:
              description: The URL of the resource used to check the status of the asynchronous operation.
              type: string
            Retry-After:
              description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.
              type: integer
              format: int32
        default:
          description: Automation error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Hostpools Hostpoolname Sessionhostmanagements Default Initiatesessionhostupdate
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/controlSessionHostUpdate
  : post:
      tags:
      - SessionHostManagement
      operationId: microsoftAzureControlsessionhostupdatePost
      description: Control update of a hostpool.
      x-ms-examples:
        SessionHostManagements_ControlUpdate_Post:
          $ref: ./examples/SessionHostManagements_ControlSessionHostUpdate_Post.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/HostPoolNameParameter'
      - name: hostPoolControlParameter
        description: Object containing control action for hostpool update.
        in: body
        required: true
        schema:
          $ref: '#/definitions/HostPoolControlParameter'
      responses:
        '202':
          description: Successfully controlled hostpool update.
          headers:
            Location:
              description: The URL of the resource used to check the status of the asynchronous operation.
              type: string
            Azure-AsyncOperation:
              description: The URL of the resource used to check the status of the asynchronous operation.
              type: string
            Retry-After:
              description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.
              type: integer
              format: int32
        default:
          description: Automation error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Hostpools Hostpoolname Sessionhostmanagements Default Controlsessionhostupdate
definitions:
  SessionHostManagement:
    type: object
    description: Represents a SessionHostManagement definition.
    allOf:
    - $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource
    required:
    - properties
    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 SessionHostManagement
        x-ms-client-flatten: true
        $ref: '#/definitions/SessionHostManagementProperties'
  HostPoolUpdateConfigurationPatchProperties:
    description: The configurations of a hostpool update.
    type: object
    properties:
      deleteOriginalVm:
        type: boolean
        description: Whether not to save original disk. False by default.
      maxVmsRemoved:
        type: integer
        format: int32
        description: The maximum number of virtual machines to be removed during hostpool update.
        minimum: 1
      logOffDelayMinutes:
        type: integer
        format: int32
        description: Grace period before logging off users in minutes.
      logOffMessage:
        type: string
        description: Log off message sent to user for logoff.
        maxLength: 260
  HostPoolUpdateConfigurationProperties:
    description: The configurations of a hostpool update.
    type: object
    required:
    - maxVmsRemoved
    - logOffDelayMinutes
    properties:
      deleteOriginalVm:
        type: boolean
        description: Whether not to save original disk. False by default.
      maxVmsRemoved:
        type: integer
        format: int32
        description: The maximum number of virtual machines to be removed during hostpool update.
        minimum: 1
      logOffDelayMinutes:
        type: integer
        format: int32
        description: Grace period before logging off users in minutes.
      logOffMessage:
        type: string
        description: Log off message sent to user for logoff. Default value is an empty string.
        maxLength: 260
        default: ''
  HostPoolControlParameter:
    description: Represents properties for a hostpool update.
    type: object
    required:
    - action
    properties:
      action:
        enum:
        - Start
        - Pause
        - Cancel
        - Retry
        - Resume
        x-ms-enum:
          name: HostPoolUpdateAction
          modelAsString: true
          values:
          - value: Start
            description: Start the hostpool update.
          - value: Pause
            description: Pause the hostpool update.
          - value: Cancel
            description: Cancel the hostpool update.
          - value: Retry
            description: Retry the hostpool update.
          - value: Resume
            description: Resume the hostpool update.
        type: string
        description: Action types for controlling hostpool update.
        x-nullable: false
      cancelMessage:
        type: string
        description: The cancel message sent to the user on the session host. This is can only be specified if the action is 'Cancel'.
        maxLength: 260
  CloudError:
    description: Cloud error object.
    type: object
    x-ms-external: true
    properties:
      error:
        $ref: '#/definitions/CloudErrorProperties'
  SessionHostManagementPatchProperties:
    description: Session host Managements of HostPool.
    type: object
    properties:
      scheduledDateTimeZone:
        type: string
        description: Time zone for sessionHostManagement operations as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Must be set if useLocalTime is true.
      update:
        $ref: '#/definitions/HostPoolUpdateConfigurationPatchProperties'
        description: Parameters for a hostpool update.
  SessionHostManagementPatch:
    type: object
    description: Represents a SessionHostManagementPatch definition.
    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 SessionHostManagementPatch
        x-ms-client-flatten: true
        $ref: '#/definitions/SessionHostManagementPatchProperties'
  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
  SessionHostManagementProperties:
    description: Session host Managements of HostPool.
    type: object
    required:
    - scheduledDateTimeZone
    - update
    properties:
      scheduledDateTimeZone:
        type: string
        description: Time zone for sessionHostManagement operations as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Must be set if useLocalTime is true.
      update:
        $ref: '#/definitions/HostPoolUpdateConfigurationProperties'
        description: Parameters for a hostpool update.
  UpdateSessionHostsRequestBody:
    description: Object containing the definition for properties to be used for a sessionHostUpdate operation.
    type: object
    properties:
      scheduledDateTime:
        type: string
        format: date-time
        description: The timestamp that the update validation is scheduled for. If none is provided, the update will be executed immediately
      scheduledDateTimeZone:
        type: string
        description: The timeZone as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid.
      update:
        description: settings for management information for the hostpool update operation. If none is provided the update will use the settings saved in the sessionHostManagement object.
        $ref: '#/definitions/HostPoolUpdateConfigurationPatchProperties'
parameters:
  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
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'