Share via

ScalingPlanPooledSchedulePatch interface

  • Reference
Package:
@azure/arm-desktopvirtualization

ScalingPlanPooledSchedule properties that can be patched.

Extends
Resource

Properties

daysOfWeek

Set of days of the week on which this schedule is active.
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.

Inherited Properties

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

daysOfWeek

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

daysOfWeek?: DayOfWeek[]

Property Value

DayOfWeek[]

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

Inherited Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From Resource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From Resource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type