pulumi-azure-kotlin/com.pulumi.azure.desktopvirtualization.kotlin.inputs/ScalingPlanScheduleArgs

ScalingPlanScheduleArgs

data class ScalingPlanScheduleArgs(val daysOfWeeks: Output<List<String>>, val name: Output<String>, val offPeakLoadBalancingAlgorithm: Output<String>, val offPeakStartTime: Output<String>, val peakLoadBalancingAlgorithm: Output<String>, val peakStartTime: Output<String>, val rampDownCapacityThresholdPercent: Output<Int>, val rampDownForceLogoffUsers: Output<Boolean>, val rampDownLoadBalancingAlgorithm: Output<String>, val rampDownMinimumHostsPercent: Output<Int>, val rampDownNotificationMessage: Output<String>, val rampDownStartTime: Output<String>, val rampDownStopHostsWhen: Output<String>, val rampDownWaitTimeMinutes: Output<Int>, val rampUpCapacityThresholdPercent: Output<Int>? = null, val rampUpLoadBalancingAlgorithm: Output<String>, val rampUpMinimumHostsPercent: Output<Int>? = null, val rampUpStartTime: Output<String>) : ConvertibleToJava<ScalingPlanScheduleArgs>

Constructors

fun ScalingPlanScheduleArgs(daysOfWeeks: Output<List<String>>, name: Output<String>, offPeakLoadBalancingAlgorithm: Output<String>, offPeakStartTime: Output<String>, peakLoadBalancingAlgorithm: Output<String>, peakStartTime: Output<String>, rampDownCapacityThresholdPercent: Output<Int>, rampDownForceLogoffUsers: Output<Boolean>, rampDownLoadBalancingAlgorithm: Output<String>, rampDownMinimumHostsPercent: Output<Int>, rampDownNotificationMessage: Output<String>, rampDownStartTime: Output<String>, rampDownStopHostsWhen: Output<String>, rampDownWaitTimeMinutes: Output<Int>, rampUpCapacityThresholdPercent: Output<Int>? = null, rampUpLoadBalancingAlgorithm: Output<String>, rampUpMinimumHostsPercent: Output<Int>? = null, rampUpStartTime: Output<String>)

Functions

toJava

open override fun toJava(): ScalingPlanScheduleArgs

Properties

daysOfWeeks

val daysOfWeeks: Output<List<String>>

A list of Days of the Week on which this schedule will be used. Possible values are Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, and Sunday

name

val name: Output<String>

The name of the schedule.

offPeakLoadBalancingAlgorithm

val offPeakLoadBalancingAlgorithm: Output<String>

The load Balancing Algorithm to use during Off-Peak Hours. Possible values are DepthFirst and BreadthFirst.

offPeakStartTime

val offPeakStartTime: Output<String>

The time at which Off-Peak scaling will begin. This is also the end-time for the Ramp-Down period. The time must be specified in "HH:MM" format.

peakLoadBalancingAlgorithm

val peakLoadBalancingAlgorithm: Output<String>

The load Balancing Algorithm to use during Peak Hours. Possible values are DepthFirst and BreadthFirst.

peakStartTime

val peakStartTime: Output<String>

The time at which Peak scaling will begin. This is also the end-time for the Ramp-Up period. The time must be specified in "HH:MM" format.

rampDownCapacityThresholdPercent

val rampDownCapacityThresholdPercent: Output<Int>

This is the value in percentage of used host pool capacity that will be considered to evaluate whether to turn on/off virtual machines during the ramp-down and off-peak hours. For example, if capacity threshold is specified as 60% and your total host pool capacity is 100 sessions, autoscale will turn on additional session hosts once the host pool exceeds a load of 60 sessions.

rampDownForceLogoffUsers

val rampDownForceLogoffUsers: Output<Boolean>

Whether users will be forced to log-off session hosts once the ramp_down_wait_time_minutes value has been exceeded during the Ramp-Down period. Possible

rampDownLoadBalancingAlgorithm

val rampDownLoadBalancingAlgorithm: Output<String>

The load Balancing Algorithm to use during the Ramp-Down period. Possible values are DepthFirst and BreadthFirst.

rampDownMinimumHostsPercent

val rampDownMinimumHostsPercent: Output<Int>

The minimum percentage of session host virtual machines that you would like to get to for ramp-down and off-peak hours. For example, if Minimum percentage of hosts is specified as 10% and total number of session hosts in your host pool is 10, autoscale will ensure a minimum of 1 session host is available to take user connections.

rampDownNotificationMessage

val rampDownNotificationMessage: Output<String>

The notification message to send to users during Ramp-Down period when they are required to log-off.

rampDownStartTime

val rampDownStartTime: Output<String>

The time at which Ramp-Down scaling will begin. This is also the end-time for the Ramp-Up period. The time must be specified in "HH:MM" format.

rampDownStopHostsWhen

val rampDownStopHostsWhen: Output<String>

Controls Session Host shutdown behaviour during Ramp-Down period. Session Hosts can either be shutdown when all sessions on the Session Host have ended, or when there are no Active sessions left on the Session Host. Possible values are ZeroSessions and ZeroActiveSessions.

rampDownWaitTimeMinutes

val rampDownWaitTimeMinutes: Output<Int>

The number of minutes during Ramp-Down period that autoscale will wait after setting the session host VMs to drain mode, notifying any currently signed in users to save their work before forcing the users to logoff. Once all user sessions on the session host VM have been logged off, Autoscale will shut down the VM.

rampUpCapacityThresholdPercent

val rampUpCapacityThresholdPercent: Output<Int>? = null

This is the value of percentage of used host pool capacity that will be considered to evaluate whether to turn on/off virtual machines during the ramp-up and peak hours. For example, if capacity threshold is specified as 60% and your total host pool capacity is 100 sessions, autoscale will turn on additional session hosts once the host pool exceeds a load of 60 sessions.

rampUpLoadBalancingAlgorithm

val rampUpLoadBalancingAlgorithm: Output<String>

The load Balancing Algorithm to use during the Ramp-Up period. Possible values are DepthFirst and BreadthFirst.

rampUpMinimumHostsPercent

val rampUpMinimumHostsPercent: Output<Int>? = null

Specifies the minimum percentage of session host virtual machines to start during ramp-up for peak hours. For example, if Minimum percentage of hosts is specified as 10% and total number of session hosts in your host pool is 10, autoscale will ensure a minimum of 1 session host is available to take user connections.

rampUpStartTime

val rampUpStartTime: Output<String>

The time at which Ramp-Up scaling will begin. This is also the end-time for the Ramp-Up period. The time must be specified in "HH:MM" format.