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.
To create a Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules resource, add the following JSON to your template.
{
"type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules",
"apiVersion": "2023-11-01-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"
}
}
}
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules' |
apiVersion | The resource api version | '2023-11-01-preview' |
name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
properties | Detailed properties for ScalingPlanPooledSchedule | ScalingPlanPooledScheduleProperties (required) |
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 |
Name | Description | Value |
---|---|---|
hour | The hour. | int (required) Constraints: Min value = 0 Max value = 23 |
minute | The minute. | int (required) Constraints: Min value = 0 Max value = 59 |