New-AzWvdScalingPlanPersonalSchedule

Module:

Az.DesktopVirtualization

Create or update a ScalingPlanPersonalSchedule.

Syntax

New-AzWvdScalingPlanPersonalSchedule
   -ResourceGroupName <String>
   -ScalingPlanName <String>
   -ScalingPlanScheduleName <String>
   [-SubscriptionId <String>]
   [-DaysOfWeek <DayOfWeek[]>]
   [-OffPeakActionOnDisconnect <SessionHandlingOperation>]
   [-OffPeakActionOnLogoff <SessionHandlingOperation>]
   [-OffPeakMinutesToWaitOnDisconnect <Int32>]
   [-OffPeakMinutesToWaitOnLogoff <Int32>]
   [-OffPeakStartTimeHour <Int32>]
   [-OffPeakStartTimeMinute <Int32>]
   [-OffPeakStartVMOnConnect <SetStartVMOnConnect>]
   [-PeakActionOnDisconnect <SessionHandlingOperation>]
   [-PeakActionOnLogoff <SessionHandlingOperation>]
   [-PeakMinutesToWaitOnDisconnect <Int32>]
   [-PeakMinutesToWaitOnLogoff <Int32>]
   [-PeakStartTimeHour <Int32>]
   [-PeakStartTimeMinute <Int32>]
   [-PeakStartVMOnConnect <SetStartVMOnConnect>]
   [-RampDownActionOnDisconnect <SessionHandlingOperation>]
   [-RampDownActionOnLogoff <SessionHandlingOperation>]
   [-RampDownMinutesToWaitOnDisconnect <Int32>]
   [-RampDownMinutesToWaitOnLogoff <Int32>]
   [-RampDownStartTimeHour <Int32>]
   [-RampDownStartTimeMinute <Int32>]
   [-RampDownStartVMOnConnect <SetStartVMOnConnect>]
   [-RampUpActionOnDisconnect <SessionHandlingOperation>]
   [-RampUpActionOnLogoff <SessionHandlingOperation>]
   [-RampUpAutoStartHost <StartupBehavior>]
   [-RampUpMinutesToWaitOnDisconnect <Int32>]
   [-RampUpMinutesToWaitOnLogoff <Int32>]
   [-RampUpStartTimeHour <Int32>]
   [-RampUpStartTimeMinute <Int32>]
   [-RampUpStartVMOnConnect <SetStartVMOnConnect>]
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Create or update a ScalingPlanPersonalSchedule.

Examples

Example 1: Create a Scaling Plan Personal Schedule

New-AzWvdScalingPlanPersonalSchedule -ResourceGroupName rgName `
                                        -ScalingPlanName spName `
                                        -ScalingPlanScheduleName scheduleName `
                                        -DaysOfWeek @('Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday') `
                                        -RampUpStartTimeHour 6 `
                                        -RampUpStartTimeMinute 30 `
                                        -RampUpAutoStartHost "None" `
                                        -RampUpStartVMOnConnect Enable `
                                        -RampUpActionOnDisconnect None `
                                        -RampUpMinutesToWaitOnDisconnect 10 `
                                        -RampUpActionOnLogoff None `
                                        -RampUpMinutesToWaitOnLogoff 10 `
                                        -peakStartTimeHour 8 `
                                        -PeakStartTimeMinute 30 `
                                        -PeakStartVMOnConnect Enable `
                                        -PeakActionOnDisconnect None `
                                        -PeakMinutesToWaitOnDisconnect 10 `
                                        -PeakMinutesToWaitOnLogoff 10 `
                                        -RampDownStartTimeHour 16 `
                                        -RampDownStartTimeMinute 0 `
                                        -RampDownStartVMOnConnect Enable `
                                        -RampDownActionOnDisconnect None `
                                        -RampDownMinutesToWaitOnDisconnect 10 `
                                        -RampDownMinutesToWaitOnLogoff 10 `
                                        -RampDownActionOnLogoff None `
                                        -OffPeakStartTimeHour 22 `
                                        -OffPeakStartTimeMinute 45 `
                                        -OffPeakStartVMOnConnect Enable `
                                        -OffPeakActionOnDisconnect None `
                                        -OffPeakMinutesToWaitOnDisconnect 10 `
                                        -OffPeakActionOnLogoff Deallocate `
                                        -OffPeakMinutesToWaitOnLogoff 10

Name
----
scalingplan1/PersonalSchedule1

Add a Scaling Plan Personal Schedule to an existing Scaling Plan.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DaysOfWeek

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

Type:	DayOfWeek[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-OffPeakActionOnDisconnect

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

Type:	SessionHandlingOperation
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-OffPeakActionOnLogoff

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

Type:	SessionHandlingOperation
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-OffPeakMinutesToWaitOnDisconnect

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

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-OffPeakMinutesToWaitOnLogoff

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

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-OffPeakStartTimeHour

The hour.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-OffPeakStartTimeMinute

The minute.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-OffPeakStartVMOnConnect

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

Type:	SetStartVMOnConnect
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PeakActionOnDisconnect

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

Type:	SessionHandlingOperation
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PeakActionOnLogoff

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

Type:	SessionHandlingOperation
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PeakMinutesToWaitOnDisconnect

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

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PeakMinutesToWaitOnLogoff

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

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PeakStartTimeHour

The hour.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PeakStartTimeMinute

The minute.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PeakStartVMOnConnect

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

Type:	SetStartVMOnConnect
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RampDownActionOnDisconnect

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

Type:	SessionHandlingOperation
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RampDownActionOnLogoff

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

Type:	SessionHandlingOperation
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RampDownMinutesToWaitOnDisconnect

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

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RampDownMinutesToWaitOnLogoff

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

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RampDownStartTimeHour

The hour.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RampDownStartTimeMinute

The minute.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RampDownStartVMOnConnect

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

Type:	SetStartVMOnConnect
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RampUpActionOnDisconnect

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

Type:	SessionHandlingOperation
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RampUpActionOnLogoff

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

Type:	SessionHandlingOperation
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RampUpAutoStartHost

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

Type:	StartupBehavior
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RampUpMinutesToWaitOnDisconnect

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

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RampUpMinutesToWaitOnLogoff

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

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RampUpStartTimeHour

The hour.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RampUpStartTimeMinute

The minute.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

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

Type:	SetStartVMOnConnect
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ScalingPlanName

The name of the scaling plan.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ScalingPlanScheduleName

The name of the ScalingPlanSchedule

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

The ID of the target subscription.

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Outputs

Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20231004Preview.IScalingPlanPersonalSchedule