Share via

ScalingSchedule interface

Package:
@azure/arm-desktopvirtualization

A ScalingPlanPooledSchedule.

Properties

daysOfWeek

Set of days of the week on which this schedule is active.
name

Name of the ScalingPlanPooledSchedule.
offPeakLoadBalancingAlgorithm

Load balancing algorithm for off-peak period.
offPeakStartTime

Starting time for off-peak period.
peakLoadBalancingAlgorithm

Load balancing algorithm for peak period.
peakStartTime

Starting time for peak period.
rampDownCapacityThresholdPct

Capacity threshold for ramp down period.
rampDownForceLogoffUsers

Should users be logged off forcefully from hosts.
rampDownLoadBalancingAlgorithm

Load balancing algorithm for ramp down period.
rampDownMinimumHostsPct

Minimum host percentage for ramp down period.
rampDownNotificationMessage

Notification message for users during ramp down period.
rampDownStartTime

Starting time for ramp down period.
rampDownStopHostsWhen

Specifies when to stop hosts during ramp down period.
rampDownWaitTimeMinutes

Number of minutes to wait to stop hosts during ramp down period.
rampUpCapacityThresholdPct

Capacity threshold for ramp up period.
rampUpLoadBalancingAlgorithm

Load balancing algorithm for ramp up period.
rampUpMinimumHostsPct

Minimum host percentage for ramp up period.
rampUpStartTime

Starting time for ramp up period.

Property Details

daysOfWeek

Set of days of the week on which this schedule is active.

daysOfWeek?: string[]

Property Value

string[]

name

Name of the ScalingPlanPooledSchedule.

name?: string

Property Value

string

offPeakLoadBalancingAlgorithm

Load balancing algorithm for off-peak period.

offPeakLoadBalancingAlgorithm?: string

Property Value

string

offPeakStartTime

Starting time for off-peak period.

offPeakStartTime?: Time

Property Value

Time

peakLoadBalancingAlgorithm

Load balancing algorithm for peak period.

peakLoadBalancingAlgorithm?: string

Property Value

string

peakStartTime

Starting time for peak period.

peakStartTime?: Time

Property Value

Time

rampDownCapacityThresholdPct

Capacity threshold for ramp down period.

rampDownCapacityThresholdPct?: number

Property Value

number

rampDownForceLogoffUsers

Should users be logged off forcefully from hosts.

rampDownForceLogoffUsers?: boolean

Property Value

boolean

rampDownLoadBalancingAlgorithm

Load balancing algorithm for ramp down period.

rampDownLoadBalancingAlgorithm?: string

Property Value

string

rampDownMinimumHostsPct

Minimum host percentage for ramp down period.

rampDownMinimumHostsPct?: number

Property Value

number

rampDownNotificationMessage

Notification message for users during ramp down period.

rampDownNotificationMessage?: string

Property Value

string

rampDownStartTime

Starting time for ramp down period.

rampDownStartTime?: Time

Property Value

Time

rampDownStopHostsWhen

Specifies when to stop hosts during ramp down period.

rampDownStopHostsWhen?: string

Property Value

string

rampDownWaitTimeMinutes

Number of minutes to wait to stop hosts during ramp down period.

rampDownWaitTimeMinutes?: number

Property Value

number

rampUpCapacityThresholdPct

Capacity threshold for ramp up period.

rampUpCapacityThresholdPct?: number

Property Value

number

rampUpLoadBalancingAlgorithm

Load balancing algorithm for ramp up period.

rampUpLoadBalancingAlgorithm?: string

Property Value

string

rampUpMinimumHostsPct

Minimum host percentage for ramp up period.

rampUpMinimumHostsPct?: number

Property Value

number

rampUpStartTime

Starting time for ramp up period.

rampUpStartTime?: Time

Property Value

Time