ScalingPlanPersonalSchedule Interface

Package:

com.azure.resourcemanager.desktopvirtualization.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-desktopvirtualization:1.2.0

public interface ScalingPlanPersonalSchedule

An immutable client-side representation of ScalingPlanPersonalSchedule.

Method Summary

Modifier and Type	Method and Description
abstract List<DayOfWeek>	daysOfWeek() Gets the daysOfWeek property: Set of days of the week on which this schedule is active.
abstract String	id() Gets the id property: Fully qualified resource Id for the resource.
abstract ScalingPlanPersonalScheduleInner	innerModel() Gets the inner com.azure.resourcemanager.desktopvirtualization.fluent.models.ScalingPlanPersonalScheduleInner object.
abstract String	name() Gets the name property: The name of the resource.
abstract SessionHandlingOperation	offPeakActionOnDisconnect() Gets the offPeakActionOnDisconnect property: Action to be taken after a user disconnect during the off-peak period.
abstract SessionHandlingOperation	offPeakActionOnLogoff() Gets the offPeakActionOnLogoff property: Action to be taken after a logoff during the off-peak period.
abstract Integer	offPeakMinutesToWaitOnDisconnect() Gets the offPeakMinutesToWaitOnDisconnect property: The time in minutes to wait before performing the desired session handling action when a user disconnects during the off-peak period.
abstract Integer	offPeakMinutesToWaitOnLogoff() Gets the offPeakMinutesToWaitOnLogoff property: The time in minutes to wait before performing the desired session handling action when a user logs off during the off-peak period.
abstract Time	offPeakStartTime() Gets the offPeakStartTime property: Starting time for off-peak period.
abstract SetStartVMOnConnect	offPeakStartVMOnConnect() Gets the offPeakStartVMOnConnect property: The desired configuration of Start VM On Connect for the hostpool during the off-peak phase.
abstract SessionHandlingOperation	peakActionOnDisconnect() Gets the peakActionOnDisconnect property: Action to be taken after a user disconnect during the peak period.
abstract SessionHandlingOperation	peakActionOnLogoff() Gets the peakActionOnLogoff property: Action to be taken after a logoff during the peak period.
abstract Integer	peakMinutesToWaitOnDisconnect() Gets the peakMinutesToWaitOnDisconnect property: The time in minutes to wait before performing the desired session handling action when a user disconnects during the peak period.
abstract Integer	peakMinutesToWaitOnLogoff() Gets the peakMinutesToWaitOnLogoff property: The time in minutes to wait before performing the desired session handling action when a user logs off during the peak period.
abstract Time	peakStartTime() Gets the peakStartTime property: Starting time for peak period.
abstract SetStartVMOnConnect	peakStartVMOnConnect() Gets the peakStartVMOnConnect property: The desired configuration of Start VM On Connect for the hostpool during the peak phase.
abstract SessionHandlingOperation	rampDownActionOnDisconnect() Gets the rampDownActionOnDisconnect property: Action to be taken after a user disconnect during the ramp down period.
abstract SessionHandlingOperation	rampDownActionOnLogoff() Gets the rampDownActionOnLogoff property: Action to be taken after a logoff during the ramp down period.
abstract Integer	rampDownMinutesToWaitOnDisconnect() Gets the rampDownMinutesToWaitOnDisconnect property: The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp down period.
abstract Integer	rampDownMinutesToWaitOnLogoff() Gets the rampDownMinutesToWaitOnLogoff property: The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp down period.
abstract Time	rampDownStartTime() Gets the rampDownStartTime property: Starting time for ramp down period.
abstract SetStartVMOnConnect	rampDownStartVMOnConnect() Gets the rampDownStartVMOnConnect property: The desired configuration of Start VM On Connect for the hostpool during the ramp down phase.
abstract SessionHandlingOperation	rampUpActionOnDisconnect() Gets the rampUpActionOnDisconnect property: Action to be taken after a user disconnect during the ramp up period.
abstract SessionHandlingOperation	rampUpActionOnLogoff() Gets the rampUpActionOnLogoff property: Action to be taken after a logoff during the ramp up period.
abstract StartupBehavior	rampUpAutoStartHosts() Gets the rampUpAutoStartHosts property: The desired startup behavior during the ramp up period for personal vms in the hostpool.
abstract Integer	rampUpMinutesToWaitOnDisconnect() Gets the rampUpMinutesToWaitOnDisconnect property: The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp up period.
abstract Integer	rampUpMinutesToWaitOnLogoff() Gets the rampUpMinutesToWaitOnLogoff property: The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp up period.
abstract Time	rampUpStartTime() Gets the rampUpStartTime property: Starting time for ramp up period.
abstract SetStartVMOnConnect	rampUpStartVMOnConnect() Gets the rampUpStartVMOnConnect property: The desired configuration of Start VM On Connect for the hostpool during the ramp up phase.
abstract ScalingPlanPersonalSchedule	refresh() Refreshes the resource to sync with Azure.
abstract ScalingPlanPersonalSchedule	refresh(Context context) Refreshes the resource to sync with Azure.
abstract String	resourceGroupName() Gets the name of the resource group.
abstract SystemData	systemData() Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
abstract String	type() Gets the type property: The type of the resource.
abstract Update	update() Begins update for the ScalingPlanPersonalSchedule resource.

Method Details

daysOfWeek

public abstract List<DayOfWeek> daysOfWeek()

Gets the daysOfWeek property: Set of days of the week on which this schedule is active.

Returns:

the daysOfWeek value.

id

public abstract String id()

Gets the id property: Fully qualified resource Id for the resource.

Returns:

the id value.

innerModel

public abstract ScalingPlanPersonalScheduleInner innerModel()

Gets the inner com.azure.resourcemanager.desktopvirtualization.fluent.models.ScalingPlanPersonalScheduleInner object.

Returns:

the inner object.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

offPeakActionOnDisconnect

public abstract SessionHandlingOperation offPeakActionOnDisconnect()

Gets the offPeakActionOnDisconnect property: Action to be taken after a user disconnect during the off-peak period.

Returns:

the offPeakActionOnDisconnect value.

offPeakActionOnLogoff

public abstract SessionHandlingOperation offPeakActionOnLogoff()

Gets the offPeakActionOnLogoff property: Action to be taken after a logoff during the off-peak period.

Returns:

the offPeakActionOnLogoff value.

offPeakMinutesToWaitOnDisconnect

public abstract Integer offPeakMinutesToWaitOnDisconnect()

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

Returns:

the offPeakMinutesToWaitOnDisconnect value.

offPeakMinutesToWaitOnLogoff

public abstract Integer offPeakMinutesToWaitOnLogoff()

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

Returns:

the offPeakMinutesToWaitOnLogoff value.

offPeakStartTime

public abstract Time offPeakStartTime()

Gets the offPeakStartTime property: Starting time for off-peak period.

Returns:

the offPeakStartTime value.

offPeakStartVMOnConnect

public abstract SetStartVMOnConnect offPeakStartVMOnConnect()

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

Returns:

the offPeakStartVMOnConnect value.

peakActionOnDisconnect

public abstract SessionHandlingOperation peakActionOnDisconnect()

Gets the peakActionOnDisconnect property: Action to be taken after a user disconnect during the peak period.

Returns:

the peakActionOnDisconnect value.

peakActionOnLogoff

public abstract SessionHandlingOperation peakActionOnLogoff()

Gets the peakActionOnLogoff property: Action to be taken after a logoff during the peak period.

Returns:

the peakActionOnLogoff value.

peakMinutesToWaitOnDisconnect

public abstract Integer peakMinutesToWaitOnDisconnect()

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

Returns:

the peakMinutesToWaitOnDisconnect value.

peakMinutesToWaitOnLogoff

public abstract Integer peakMinutesToWaitOnLogoff()

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

Returns:

the peakMinutesToWaitOnLogoff value.

peakStartTime

public abstract Time peakStartTime()

Gets the peakStartTime property: Starting time for peak period.

Returns:

the peakStartTime value.

peakStartVMOnConnect

public abstract SetStartVMOnConnect peakStartVMOnConnect()

Gets the peakStartVMOnConnect property: The desired configuration of Start VM On Connect for the hostpool during the peak phase.

Returns:

the peakStartVMOnConnect value.

rampDownActionOnDisconnect

public abstract SessionHandlingOperation rampDownActionOnDisconnect()

Gets the rampDownActionOnDisconnect property: Action to be taken after a user disconnect during the ramp down period.

Returns:

the rampDownActionOnDisconnect value.

rampDownActionOnLogoff

public abstract SessionHandlingOperation rampDownActionOnLogoff()

Gets the rampDownActionOnLogoff property: Action to be taken after a logoff during the ramp down period.

Returns:

the rampDownActionOnLogoff value.

rampDownMinutesToWaitOnDisconnect

public abstract Integer rampDownMinutesToWaitOnDisconnect()

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

Returns:

the rampDownMinutesToWaitOnDisconnect value.

rampDownMinutesToWaitOnLogoff

public abstract Integer rampDownMinutesToWaitOnLogoff()

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

Returns:

the rampDownMinutesToWaitOnLogoff value.

rampDownStartTime

public abstract Time rampDownStartTime()

Gets the rampDownStartTime property: Starting time for ramp down period.

Returns:

the rampDownStartTime value.

rampDownStartVMOnConnect

public abstract SetStartVMOnConnect rampDownStartVMOnConnect()

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

Returns:

the rampDownStartVMOnConnect value.

rampUpActionOnDisconnect

public abstract SessionHandlingOperation rampUpActionOnDisconnect()

Gets the rampUpActionOnDisconnect property: Action to be taken after a user disconnect during the ramp up period.

Returns:

the rampUpActionOnDisconnect value.

rampUpActionOnLogoff

public abstract SessionHandlingOperation rampUpActionOnLogoff()

Gets the rampUpActionOnLogoff property: Action to be taken after a logoff during the ramp up period.

Returns:

the rampUpActionOnLogoff value.

rampUpAutoStartHosts

public abstract StartupBehavior rampUpAutoStartHosts()

Gets the rampUpAutoStartHosts property: The desired startup behavior during the ramp up period for personal vms in the hostpool.

Returns:

the rampUpAutoStartHosts value.

rampUpMinutesToWaitOnDisconnect

public abstract Integer rampUpMinutesToWaitOnDisconnect()

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

Returns:

the rampUpMinutesToWaitOnDisconnect value.

rampUpMinutesToWaitOnLogoff

public abstract Integer rampUpMinutesToWaitOnLogoff()

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

Returns:

the rampUpMinutesToWaitOnLogoff value.

rampUpStartTime

public abstract Time rampUpStartTime()

Gets the rampUpStartTime property: Starting time for ramp up period.

Returns:

the rampUpStartTime value.

rampUpStartVMOnConnect

public abstract SetStartVMOnConnect rampUpStartVMOnConnect()

Gets the rampUpStartVMOnConnect property: 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.

Returns:

the rampUpStartVMOnConnect value.

refresh

public abstract ScalingPlanPersonalSchedule refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract ScalingPlanPersonalSchedule refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

systemData

public abstract SystemData systemData()

Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

Returns:

the systemData value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

update

public abstract ScalingPlanPersonalSchedule.Update update()

Begins update for the ScalingPlanPersonalSchedule resource.

Returns:

the stage of resource update.