Share via

ScalingPlanPersonalSchedule interface

  • Reference
Package:
@azure/arm-desktopvirtualization

Represents a ScalingPlanPersonalSchedule definition.

Extends
ProxyResource

Properties

daysOfWeek

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

Action to be taken after a user disconnect during the off-peak period.
offPeakActionOnLogoff

Action to be taken after a logoff during the off-peak period.
offPeakMinutesToWaitOnDisconnect

The time in minutes to wait before performing the desired session handling action when a user disconnects during the off-peak period.
offPeakMinutesToWaitOnLogoff

The time in minutes to wait before performing the desired session handling action when a user logs off during the off-peak period.
offPeakStartTime

Starting time for off-peak period.
offPeakStartVMOnConnect

The desired configuration of Start VM On Connect for the hostpool during the off-peak phase.
peakActionOnDisconnect

Action to be taken after a user disconnect during the peak period.
peakActionOnLogoff

Action to be taken after a logoff during the peak period.
peakMinutesToWaitOnDisconnect

The time in minutes to wait before performing the desired session handling action when a user disconnects during the peak period.
peakMinutesToWaitOnLogoff

The time in minutes to wait before performing the desired session handling action when a user logs off during the peak period.
peakStartTime

Starting time for peak period.
peakStartVMOnConnect

The desired configuration of Start VM On Connect for the hostpool during the peak phase.
rampDownActionOnDisconnect

Action to be taken after a user disconnect during the ramp down period.
rampDownActionOnLogoff

Action to be taken after a logoff during the ramp down period.
rampDownMinutesToWaitOnDisconnect

The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp down period.
rampDownMinutesToWaitOnLogoff

The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp down period.
rampDownStartTime

Starting time for ramp down period.
rampDownStartVMOnConnect

The desired configuration of Start VM On Connect for the hostpool during the ramp down phase.
rampUpActionOnDisconnect

Action to be taken after a user disconnect during the ramp up period.
rampUpActionOnLogoff

Action to be taken after a logoff during the ramp up period.
rampUpAutoStartHosts

The desired startup behavior during the ramp up period for personal vms in the hostpool.
rampUpMinutesToWaitOnDisconnect

The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp up period.
rampUpMinutesToWaitOnLogoff

The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp up period.
rampUpStartTime

Starting time for ramp up period.
rampUpStartVMOnConnect

The desired configuration of Start VM On Connect for the hostpool during the ramp up phase. If this is disabled, session hosts must be turned on using rampUpAutoStartHosts or by turning them on manually.

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[]

offPeakActionOnDisconnect

Action to be taken after a user disconnect during the off-peak period.

offPeakActionOnDisconnect?: string

Property Value

string

offPeakActionOnLogoff

Action to be taken after a logoff during the off-peak period.

offPeakActionOnLogoff?: string

Property Value

string

offPeakMinutesToWaitOnDisconnect

The time in minutes to wait before performing the desired session handling action when a user disconnects during the off-peak period.

offPeakMinutesToWaitOnDisconnect?: number

Property Value

number

offPeakMinutesToWaitOnLogoff

The time in minutes to wait before performing the desired session handling action when a user logs off during the off-peak period.

offPeakMinutesToWaitOnLogoff?: number

Property Value

number

offPeakStartTime

Starting time for off-peak period.

offPeakStartTime?: Time

Property Value

Time

offPeakStartVMOnConnect

The desired configuration of Start VM On Connect for the hostpool during the off-peak phase.

offPeakStartVMOnConnect?: string

Property Value

string

peakActionOnDisconnect

Action to be taken after a user disconnect during the peak period.

peakActionOnDisconnect?: string

Property Value

string

peakActionOnLogoff

Action to be taken after a logoff during the peak period.

peakActionOnLogoff?: string

Property Value

string

peakMinutesToWaitOnDisconnect

The time in minutes to wait before performing the desired session handling action when a user disconnects during the peak period.

peakMinutesToWaitOnDisconnect?: number

Property Value

number

peakMinutesToWaitOnLogoff

The time in minutes to wait before performing the desired session handling action when a user logs off during the peak period.

peakMinutesToWaitOnLogoff?: number

Property Value

number

peakStartTime

Starting time for peak period.

peakStartTime?: Time

Property Value

Time

peakStartVMOnConnect

The desired configuration of Start VM On Connect for the hostpool during the peak phase.

peakStartVMOnConnect?: string

Property Value

string

rampDownActionOnDisconnect

Action to be taken after a user disconnect during the ramp down period.

rampDownActionOnDisconnect?: string

Property Value

string

rampDownActionOnLogoff

Action to be taken after a logoff during the ramp down period.

rampDownActionOnLogoff?: string

Property Value

string

rampDownMinutesToWaitOnDisconnect

The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp down period.

rampDownMinutesToWaitOnDisconnect?: number

Property Value

number

rampDownMinutesToWaitOnLogoff

The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp down period.

rampDownMinutesToWaitOnLogoff?: number

Property Value

number

rampDownStartTime

Starting time for ramp down period.

rampDownStartTime?: Time

Property Value

Time

rampDownStartVMOnConnect

The desired configuration of Start VM On Connect for the hostpool during the ramp down phase.

rampDownStartVMOnConnect?: string

Property Value

string

rampUpActionOnDisconnect

Action to be taken after a user disconnect during the ramp up period.

rampUpActionOnDisconnect?: string

Property Value

string

rampUpActionOnLogoff

Action to be taken after a logoff during the ramp up period.

rampUpActionOnLogoff?: string

Property Value

string

rampUpAutoStartHosts

The desired startup behavior during the ramp up period for personal vms in the hostpool.

rampUpAutoStartHosts?: string

Property Value

string

rampUpMinutesToWaitOnDisconnect

The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp up period.

rampUpMinutesToWaitOnDisconnect?: number

Property Value

number

rampUpMinutesToWaitOnLogoff

The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp up period.

rampUpMinutesToWaitOnLogoff?: number

Property Value

number

rampUpStartTime

Starting time for ramp up period.

rampUpStartTime?: Time

Property Value

Time

rampUpStartVMOnConnect

The desired configuration of Start VM On Connect for the hostpool during the ramp up phase. If this is disabled, session hosts must be turned on using rampUpAutoStartHosts or by turning them on manually.

rampUpStartVMOnConnect?: string

Property Value

string

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 ProxyResource.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 ProxyResource.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 ProxyResource.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 ProxyResource.type