Share via

Microsoft.DesktopVirtualization scalingPlans/pooledSchedules 2024-03-06-preview

Bicep resource definition

The scalingPlans/pooledSchedules resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules@2024-03-06-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    daysOfWeek: [
      'string'
    ]
    offPeakLoadBalancingAlgorithm: 'string'
    offPeakStartTime: {
      hour: int
      minute: int
    }
    peakLoadBalancingAlgorithm: 'string'
    peakStartTime: {
      hour: int
      minute: int
    }
    rampDownCapacityThresholdPct: int
    rampDownForceLogoffUsers: bool
    rampDownLoadBalancingAlgorithm: 'string'
    rampDownMinimumHostsPct: int
    rampDownNotificationMessage: 'string'
    rampDownStartTime: {
      hour: int
      minute: int
    }
    rampDownStopHostsWhen: 'string'
    rampDownWaitTimeMinutes: int
    rampUpCapacityThresholdPct: int
    rampUpLoadBalancingAlgorithm: 'string'
    rampUpMinimumHostsPct: int
    rampUpStartTime: {
      hour: int
      minute: int
    }
  }
}

Property Values

Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 64 (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: scalingPlans
properties Detailed properties for ScalingPlanPooledSchedule ScalingPlanPooledScheduleProperties (required)

ScalingPlanPooledScheduleProperties

Name Description Value
daysOfWeek Set of days of the week on which this schedule is active. String array containing any of:
'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
offPeakLoadBalancingAlgorithm Load balancing algorithm for off-peak period. 'BreadthFirst'
'DepthFirst'
offPeakStartTime Starting time for off-peak period. Time
peakLoadBalancingAlgorithm Load balancing algorithm for peak period. 'BreadthFirst'
'DepthFirst'
peakStartTime Starting time for peak period. Time
rampDownCapacityThresholdPct Capacity threshold for ramp down period. int

Constraints:
Min value = 1
Max value = 100
rampDownForceLogoffUsers Should users be logged off forcefully from hosts. bool
rampDownLoadBalancingAlgorithm Load balancing algorithm for ramp down period. 'BreadthFirst'
'DepthFirst'
rampDownMinimumHostsPct Minimum host percentage for ramp down period. int

Constraints:
Min value = 0
Max value = 100
rampDownNotificationMessage Notification message for users during ramp down period. string
rampDownStartTime Starting time for ramp down period. Time
rampDownStopHostsWhen Specifies when to stop hosts during ramp down period. 'ZeroActiveSessions'
'ZeroSessions'
rampDownWaitTimeMinutes Number of minutes to wait to stop hosts during ramp down period. int
rampUpCapacityThresholdPct Capacity threshold for ramp up period. int

Constraints:
Min value = 1
Max value = 100
rampUpLoadBalancingAlgorithm Load balancing algorithm for ramp up period. 'BreadthFirst'
'DepthFirst'
rampUpMinimumHostsPct Minimum host percentage for ramp up period. int

Constraints:
Min value = 0
Max value = 100
rampUpStartTime Starting time for ramp up period. Time

Time

Name Description Value
hour The hour. int

Constraints:
Min value = 0
Max value = 23 (required)
minute The minute. int

Constraints:
Min value = 0
Max value = 59 (required)

ARM template resource definition

The scalingPlans/pooledSchedules resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules resource, add the following JSON to your template.

{
  "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules",
  "apiVersion": "2024-03-06-preview",
  "name": "string",
  "properties": {
    "daysOfWeek": [ "string" ],
    "offPeakLoadBalancingAlgorithm": "string",
    "offPeakStartTime": {
      "hour": "int",
      "minute": "int"
    },
    "peakLoadBalancingAlgorithm": "string",
    "peakStartTime": {
      "hour": "int",
      "minute": "int"
    },
    "rampDownCapacityThresholdPct": "int",
    "rampDownForceLogoffUsers": "bool",
    "rampDownLoadBalancingAlgorithm": "string",
    "rampDownMinimumHostsPct": "int",
    "rampDownNotificationMessage": "string",
    "rampDownStartTime": {
      "hour": "int",
      "minute": "int"
    },
    "rampDownStopHostsWhen": "string",
    "rampDownWaitTimeMinutes": "int",
    "rampUpCapacityThresholdPct": "int",
    "rampUpLoadBalancingAlgorithm": "string",
    "rampUpMinimumHostsPct": "int",
    "rampUpStartTime": {
      "hour": "int",
      "minute": "int"
    }
  }
}

Property Values

Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules

Name Description Value
apiVersion The api version '2024-03-06-preview'
name The resource name string

Constraints:
Min length = 1
Max length = 64 (required)
properties Detailed properties for ScalingPlanPooledSchedule ScalingPlanPooledScheduleProperties (required)
type The resource type 'Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules'

ScalingPlanPooledScheduleProperties

Name Description Value
daysOfWeek Set of days of the week on which this schedule is active. String array containing any of:
'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
offPeakLoadBalancingAlgorithm Load balancing algorithm for off-peak period. 'BreadthFirst'
'DepthFirst'
offPeakStartTime Starting time for off-peak period. Time
peakLoadBalancingAlgorithm Load balancing algorithm for peak period. 'BreadthFirst'
'DepthFirst'
peakStartTime Starting time for peak period. Time
rampDownCapacityThresholdPct Capacity threshold for ramp down period. int

Constraints:
Min value = 1
Max value = 100
rampDownForceLogoffUsers Should users be logged off forcefully from hosts. bool
rampDownLoadBalancingAlgorithm Load balancing algorithm for ramp down period. 'BreadthFirst'
'DepthFirst'
rampDownMinimumHostsPct Minimum host percentage for ramp down period. int

Constraints:
Min value = 0
Max value = 100
rampDownNotificationMessage Notification message for users during ramp down period. string
rampDownStartTime Starting time for ramp down period. Time
rampDownStopHostsWhen Specifies when to stop hosts during ramp down period. 'ZeroActiveSessions'
'ZeroSessions'
rampDownWaitTimeMinutes Number of minutes to wait to stop hosts during ramp down period. int
rampUpCapacityThresholdPct Capacity threshold for ramp up period. int

Constraints:
Min value = 1
Max value = 100
rampUpLoadBalancingAlgorithm Load balancing algorithm for ramp up period. 'BreadthFirst'
'DepthFirst'
rampUpMinimumHostsPct Minimum host percentage for ramp up period. int

Constraints:
Min value = 0
Max value = 100
rampUpStartTime Starting time for ramp up period. Time

Time

Name Description Value
hour The hour. int

Constraints:
Min value = 0
Max value = 23 (required)
minute The minute. int

Constraints:
Min value = 0
Max value = 59 (required)

Usage Examples

Terraform (AzAPI provider) resource definition

The scalingPlans/pooledSchedules resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules@2024-03-06-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      daysOfWeek = [
        "string"
      ]
      offPeakLoadBalancingAlgorithm = "string"
      offPeakStartTime = {
        hour = int
        minute = int
      }
      peakLoadBalancingAlgorithm = "string"
      peakStartTime = {
        hour = int
        minute = int
      }
      rampDownCapacityThresholdPct = int
      rampDownForceLogoffUsers = bool
      rampDownLoadBalancingAlgorithm = "string"
      rampDownMinimumHostsPct = int
      rampDownNotificationMessage = "string"
      rampDownStartTime = {
        hour = int
        minute = int
      }
      rampDownStopHostsWhen = "string"
      rampDownWaitTimeMinutes = int
      rampUpCapacityThresholdPct = int
      rampUpLoadBalancingAlgorithm = "string"
      rampUpMinimumHostsPct = int
      rampUpStartTime = {
        hour = int
        minute = int
      }
    }
  }
}

Property Values

Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 64 (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: scalingPlans
properties Detailed properties for ScalingPlanPooledSchedule ScalingPlanPooledScheduleProperties (required)
type The resource type "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules@2024-03-06-preview"

ScalingPlanPooledScheduleProperties

Name Description Value
daysOfWeek Set of days of the week on which this schedule is active. String array containing any of:
'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
offPeakLoadBalancingAlgorithm Load balancing algorithm for off-peak period. 'BreadthFirst'
'DepthFirst'
offPeakStartTime Starting time for off-peak period. Time
peakLoadBalancingAlgorithm Load balancing algorithm for peak period. 'BreadthFirst'
'DepthFirst'
peakStartTime Starting time for peak period. Time
rampDownCapacityThresholdPct Capacity threshold for ramp down period. int

Constraints:
Min value = 1
Max value = 100
rampDownForceLogoffUsers Should users be logged off forcefully from hosts. bool
rampDownLoadBalancingAlgorithm Load balancing algorithm for ramp down period. 'BreadthFirst'
'DepthFirst'
rampDownMinimumHostsPct Minimum host percentage for ramp down period. int

Constraints:
Min value = 0
Max value = 100
rampDownNotificationMessage Notification message for users during ramp down period. string
rampDownStartTime Starting time for ramp down period. Time
rampDownStopHostsWhen Specifies when to stop hosts during ramp down period. 'ZeroActiveSessions'
'ZeroSessions'
rampDownWaitTimeMinutes Number of minutes to wait to stop hosts during ramp down period. int
rampUpCapacityThresholdPct Capacity threshold for ramp up period. int

Constraints:
Min value = 1
Max value = 100
rampUpLoadBalancingAlgorithm Load balancing algorithm for ramp up period. 'BreadthFirst'
'DepthFirst'
rampUpMinimumHostsPct Minimum host percentage for ramp up period. int

Constraints:
Min value = 0
Max value = 100
rampUpStartTime Starting time for ramp up period. Time

Time

Name Description Value
hour The hour. int

Constraints:
Min value = 0
Max value = 23 (required)
minute The minute. int

Constraints:
Min value = 0
Max value = 59 (required)