swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ScalingPlan API
schemes:
- https
tags:
- name: ScalingPlan
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}
  : get:
      tags:
      - ScalingPlan
      operationId: microsoftAzureScalingplansGet
      description: Get a scaling plan.
      x-ms-examples:
        ScalingPlans_Get:
          $ref: ./examples/ScalingPlan_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/ScalingPlanNameParameter'
      responses:
        '200':
          description: Successfully retrieved scaling plan.
          schema:
            $ref: '#/definitions/ScalingPlan'
        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 Scalingplans Scalingplanname
    put:
      tags:
      - ScalingPlan
      operationId: microsoftAzureScalingplansCreate
      description: Create or update a scaling plan.
      x-ms-examples:
        ScalingPlans_Create:
          $ref: ./examples/ScalingPlan_Create.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/ScalingPlanNameParameter'
      - name: scalingPlan
        description: Object containing scaling plan definitions.
        in: body
        required: true
        schema:
          $ref: '#/definitions/ScalingPlan'
      responses:
        '200':
          description: Successfully updated scaling plan.
          schema:
            $ref: '#/definitions/ScalingPlan'
        '201':
          description: Successfully created scaling plan.
          schema:
            $ref: '#/definitions/ScalingPlan'
        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 Scalingplans Scalingplanname
    delete:
      tags:
      - ScalingPlan
      operationId: microsoftAzureScalingplansDelete
      description: Remove a scaling plan.
      x-ms-examples:
        ScalingPlans_Delete:
          $ref: ./examples/ScalingPlan_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/ScalingPlanNameParameter'
      responses:
        '200':
          description: Successfully deleted scaling plan.
        '204':
          description: Scaling plan 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 Scalingplans Scalingplanname
    patch:
      tags:
      - ScalingPlan
      operationId: microsoftAzureScalingplansUpdate
      description: Update a scaling plan.
      x-ms-examples:
        ScalingPlans_Update:
          $ref: ./examples/ScalingPlan_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/ScalingPlanNameParameter'
      - name: scalingPlan
        description: Object containing scaling plan definitions.
        in: body
        required: false
        schema:
          $ref: '#/definitions/ScalingPlanPatch'
      responses:
        '200':
          description: Successfully updated scaling plan.
          schema:
            $ref: '#/definitions/ScalingPlan'
        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 Scalingplans Scalingplanname
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans:
    get:
      tags:
      - ScalingPlan
      operationId: microsoftAzureScalingplansListbyresourcegroup
      description: List scaling plans.
      x-ms-examples:
        ScalingPlans_ListByResourceGroup:
          $ref: ./examples/ScalingPlan_ListByResourceGroup.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
      - 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 scaling plans in resource group.
          schema:
            $ref: '#/definitions/ScalingPlanList'
        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 Scalingplans
  /subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/scalingPlans:
    get:
      tags:
      - ScalingPlan
      operationId: microsoftAzureScalingplansListbysubscription
      description: List scaling plans in subscription.
      x-ms-examples:
        ScalingPlans_ListBySubscription:
          $ref: ./examples/ScalingPlan_ListBySubscription.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - 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 scaling plans in subscription.
          schema:
            $ref: '#/definitions/ScalingPlanList'
        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 Providers Microsoft Desktopvirtualization Scalingplans
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/scalingPlans
  : get:
      tags:
      - ScalingPlan
      operationId: microsoftAzureScalingplansListbyhostpool
      description: List scaling plan associated with hostpool.
      x-ms-examples:
        ScalingPlan_ListByHostPool:
          $ref: ./examples/ScalingPlan_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: 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 scaling plan associated with hostpool.
          schema:
            $ref: '#/definitions/ScalingPlanList'
        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 Scalingplans
definitions:
  ScalingPlanProperties:
    type: object
    description: Scaling plan properties.
    required:
    - timeZone
    properties:
      objectId:
        type: string
        description: ObjectId of scaling plan. (internal use)
        readOnly: true
      description:
        type: string
        description: Description of scaling plan.
      friendlyName:
        type: string
        description: User friendly name of scaling plan.
      timeZone:
        type: string
        description: Timezone of the scaling plan.
      hostPoolType:
        enum:
        - Pooled
        x-ms-enum:
          name: ScalingHostPoolType
          modelAsString: true
          values:
          - value: Pooled
            description: Users get a new (random) SessionHost every time it connects to the HostPool.
        default: Pooled
        type: string
        description: HostPool type for desktop.
        x-nullable: false
      exclusionTag:
        type: string
        description: Exclusion tag for scaling plan.
      schedules:
        type: array
        description: List of ScalingPlanPooledSchedule definitions.
        items:
          $ref: '#/definitions/ScalingSchedule'
      hostPoolReferences:
        type: array
        description: List of ScalingHostPoolReference definitions.
        items:
          $ref: '#/definitions/ScalingHostPoolReference'
  Time:
    description: The time for a scaling action to occur.
    required:
    - hour
    - minute
    type: object
    properties:
      hour:
        format: int32
        description: The hour.
        maximum: 23
        minimum: 0
        type: integer
      minute:
        format: int32
        description: The minute.
        maximum: 59
        minimum: 0
        type: integer
  ScalingHostPoolReference:
    description: Scaling plan reference to hostpool.
    type: object
    properties:
      hostPoolArmPath:
        type: string
        description: Arm path of referenced hostpool.
      scalingPlanEnabled:
        type: boolean
        description: Is the scaling plan enabled for this hostpool.
  CloudError:
    description: Cloud error object.
    type: object
    x-ms-external: true
    properties:
      error:
        $ref: '#/definitions/CloudErrorProperties'
  ScalingPlanPatch:
    type: object
    description: Scaling plan properties that can be patched.
    properties:
      tags:
        type: object
        additionalProperties:
          type: string
        description: tags to be updated
      properties:
        description: Detailed properties for scaling plan
        x-ms-client-flatten: true
        $ref: '#/definitions/ScalingPlanPatchProperties'
  ScalingPlanList:
    type: object
    title: ScalingPlanList
    description: List of scaling plan definitions.
    properties:
      value:
        type: array
        description: List of scaling plan definitions.
        items:
          $ref: '#/definitions/ScalingPlan'
      nextLink:
        type: string
        readOnly: true
        description: Link to the next page of results.
  ScalingSchedule:
    description: A ScalingPlanPooledSchedule.
    type: object
    properties:
      name:
        type: string
        description: Name of the ScalingPlanPooledSchedule.
      daysOfWeek:
        type: array
        description: Set of days of the week on which this schedule is active.
        items:
          enum:
          - Sunday
          - Monday
          - Tuesday
          - Wednesday
          - Thursday
          - Friday
          - Saturday
          type: string
      rampUpStartTime:
        $ref: '#/definitions/Time'
        description: Starting time for ramp up period.
      rampUpLoadBalancingAlgorithm:
        enum:
        - BreadthFirst
        - DepthFirst
        x-ms-enum:
          name: SessionHostLoadBalancingAlgorithm
          modelAsString: true
        type: string
        description: Load balancing algorithm for ramp up period.
      rampUpMinimumHostsPct:
        type: integer
        format: int32
        minimum: 0
        maximum: 100
        description: Minimum host percentage for ramp up period.
      rampUpCapacityThresholdPct:
        type: integer
        format: int32
        minimum: 1
        maximum: 100
        description: Capacity threshold for ramp up period.
      peakStartTime:
        $ref: '#/definitions/Time'
        description: Starting time for peak period.
      peakLoadBalancingAlgorithm:
        enum:
        - BreadthFirst
        - DepthFirst
        x-ms-enum:
          name: SessionHostLoadBalancingAlgorithm
          modelAsString: true
        type: string
        description: Load balancing algorithm for peak period.
      rampDownStartTime:
        $ref: '#/definitions/Time'
        description: Starting time for ramp down period.
      rampDownLoadBalancingAlgorithm:
        enum:
        - BreadthFirst
        - DepthFirst
        x-ms-enum:
          name: SessionHostLoadBalancingAlgorithm
          modelAsString: true
        type: string
        description: Load balancing algorithm for ramp down period.
      rampDownMinimumHostsPct:
        type: integer
        format: int32
        minimum: 0
        maximum: 100
        description: Minimum host percentage for ramp down period.
      rampDownCapacityThresholdPct:
        type: integer
        format: int32
        minimum: 1
        maximum: 100
        description: Capacity threshold for ramp down period.
      rampDownForceLogoffUsers:
        type: boolean
        description: Should users be logged off forcefully from hosts.
      rampDownStopHostsWhen:
        enum:
        - ZeroSessions
        - ZeroActiveSessions
        x-ms-enum:
          name: StopHostsWhen
          modelAsString: true
        type: string
        description: Specifies when to stop hosts during ramp down period.
      rampDownWaitTimeMinutes:
        type: integer
        format: int32
        description: Number of minutes to wait to stop hosts during ramp down period.
      rampDownNotificationMessage:
        type: string
        description: Notification message for users during ramp down period.
      offPeakStartTime:
        $ref: '#/definitions/Time'
        description: Starting time for off-peak period.
      offPeakLoadBalancingAlgorithm:
        enum:
        - BreadthFirst
        - DepthFirst
        x-ms-enum:
          name: SessionHostLoadBalancingAlgorithm
          modelAsString: true
        type: string
        description: Load balancing algorithm for off-peak period.
  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
  ScalingPlanPatchProperties:
    type: object
    description: Scaling plan properties.
    properties:
      description:
        type: string
        description: Description of scaling plan.
      friendlyName:
        type: string
        description: User friendly name of scaling plan.
      timeZone:
        type: string
        description: Timezone of the scaling plan.
      exclusionTag:
        type: string
        description: Exclusion tag for scaling plan.
      schedules:
        type: array
        description: List of ScalingSchedule definitions.
        items:
          $ref: '#/definitions/ScalingSchedule'
      hostPoolReferences:
        type: array
        description: List of ScalingHostPoolReference definitions.
        items:
          $ref: '#/definitions/ScalingHostPoolReference'
  ScalingPlan:
    type: object
    title: ScalingPlan
    description: Represents a scaling plan definition.
    required:
    - properties
    allOf:
    - $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/ResourceModelWithAllowedPropertySet
    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 scaling plan.
        x-ms-client-flatten: true
        $ref: '#/definitions/ScalingPlanProperties'
        x-nullable: false
parameters:
  ScalingPlanNameParameter:
    name: scalingPlanName
    in: path
    required: true
    type: string
    description: The name of the scaling plan.
    maxLength: 64
    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
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'