Edit

New-AzWvdScalingPlanPooledSchedule

  • Reference
Module:
Az.DesktopVirtualization

Create or update a ScalingPlanPooledSchedule.

Syntax

New-AzWvdScalingPlanPooledSchedule
   -ResourceGroupName <String>
   -ScalingPlanName <String>
   -ScalingPlanScheduleName <String>
   [-SubscriptionId <String>]
   [-DaysOfWeek <DayOfWeek[]>]
   [-OffPeakLoadBalancingAlgorithm <SessionHostLoadBalancingAlgorithm>]
   [-OffPeakStartTimeHour <Int32>]
   [-OffPeakStartTimeMinute <Int32>]
   [-PeakLoadBalancingAlgorithm <SessionHostLoadBalancingAlgorithm>]
   [-PeakStartTimeHour <Int32>]
   [-PeakStartTimeMinute <Int32>]
   [-RampDownCapacityThresholdPct <Int32>]
   [-RampDownForceLogoffUser]
   [-RampDownLoadBalancingAlgorithm <SessionHostLoadBalancingAlgorithm>]
   [-RampDownMinimumHostsPct <Int32>]
   [-RampDownNotificationMessage <String>]
   [-RampDownStartTimeHour <Int32>]
   [-RampDownStartTimeMinute <Int32>]
   [-RampDownStopHostsWhen <StopHostsWhen>]
   [-RampDownWaitTimeMinute <Int32>]
   [-RampUpCapacityThresholdPct <Int32>]
   [-RampUpLoadBalancingAlgorithm <SessionHostLoadBalancingAlgorithm>]
   [-RampUpMinimumHostsPct <Int32>]
   [-RampUpStartTimeHour <Int32>]
   [-RampUpStartTimeMinute <Int32>]
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Create or update a ScalingPlanPooledSchedule.

Examples

Example 1: Create a Scaling Plan Pooled Schedule

New-AzWvdScalingPlanPooledSchedule -ResourceGroupName rgName `
                                        -ScalingPlanName spName `
                                        -ScalingPlanScheduleName scheduleName `
                                        -DaysOfWeek @('Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday') `
                                        -RampUpStartTimeHour 6 `
                                        -RampUpStartTimeMinute 30 `
                                        -RampUpLoadBalancingAlgorithm BreadthFirst `
                                        -RampUpMinimumHostsPct 20 `
                                        -RampUpCapacityThresholdPct 20 `
                                        -PeakStartTimeHour 8 `
                                        -PeakStartTimeMinute 30 `
                                        -PeakLoadBalancingAlgorithm DepthFirst `
                                        -RampDownStartTimeHour 16 `
                                        -RampDownStartTimeMinute 0 `
                                        -RampDownLoadBalancingAlgorithm BreadthFirst `
                                        -RampDownMinimumHostsPct 20 `
                                        -RampDownCapacityThresholdPct 20 `
                                        -RampDownForceLogoffUser:$true `
                                        -RampDownWaitTimeMinute 30 `
                                        -RampDownNotificationMessage "Log out now, please." `
                                        -RampDownStopHostsWhen ZeroSessions `
                                        -OffPeakStartTimeHour 22 `
                                        -OffPeakStartTimeMinute 45 `
                                        -OffPeakLoadBalancingAlgorithm DepthFirst

Name
----
scalingplan1/PooledSchedule1

Add a Scaling Plan Pooled 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

-OffPeakLoadBalancingAlgorithm

Load balancing algorithm for off-peak period.

Type:SessionHostLoadBalancingAlgorithm
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

-PeakLoadBalancingAlgorithm

Load balancing algorithm for peak period.

Type:SessionHostLoadBalancingAlgorithm
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

-RampDownCapacityThresholdPct

Capacity threshold for ramp down period.

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

-RampDownForceLogoffUser

Should users be logged off forcefully from hosts.

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

-RampDownLoadBalancingAlgorithm

Load balancing algorithm for ramp down period.

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

-RampDownMinimumHostsPct

Minimum host percentage for ramp down period.

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

-RampDownNotificationMessage

Notification message for users during ramp down period.

Type:String
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

-RampDownStopHostsWhen

Specifies when to stop hosts during ramp down period.

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

-RampDownWaitTimeMinute

Number of minutes to wait to stop hosts during ramp down period.

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

-RampUpCapacityThresholdPct

Capacity threshold for ramp up period.

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

-RampUpLoadBalancingAlgorithm

Load balancing algorithm for ramp up period.

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

-RampUpMinimumHostsPct

Minimum host percentage for 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

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