Update-AzWvdScalingPlanPooledSchedule

Reference

Module:: Az.DesktopVirtualization

update a ScalingPlanPooledSchedule.

Syntax

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

Update-AzWvdScalingPlanPooledSchedule
      -ResourceGroupName <String>
      -ScalingPlanName <String>
      -ScalingPlanScheduleName <String>
      [-SubscriptionId <String>]
      -JsonString <String>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzWvdScalingPlanPooledSchedule
      -ResourceGroupName <String>
      -ScalingPlanName <String>
      -ScalingPlanScheduleName <String>
      [-SubscriptionId <String>]
      -JsonFilePath <String>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzWvdScalingPlanPooledSchedule
      -ScalingPlanScheduleName <String>
      -ScalingPlanInputObject <IDesktopVirtualizationIdentity>
      [-DaysOfWeek <String[]>]
      [-OffPeakLoadBalancingAlgorithm <String>]
      [-OffPeakStartTimeHour <Int32>]
      [-OffPeakStartTimeMinute <Int32>]
      [-PeakLoadBalancingAlgorithm <String>]
      [-PeakStartTimeHour <Int32>]
      [-PeakStartTimeMinute <Int32>]
      [-RampDownCapacityThresholdPct <Int32>]
      [-RampDownForceLogoffUser]
      [-RampDownLoadBalancingAlgorithm <String>]
      [-RampDownMinimumHostsPct <Int32>]
      [-RampDownNotificationMessage <String>]
      [-RampDownStartTimeHour <Int32>]
      [-RampDownStartTimeMinute <Int32>]
      [-RampDownStopHostsWhen <String>]
      [-RampDownWaitTimeMinute <Int32>]
      [-RampUpCapacityThresholdPct <Int32>]
      [-RampUpLoadBalancingAlgorithm <String>]
      [-RampUpMinimumHostsPct <Int32>]
      [-RampUpStartTimeHour <Int32>]
      [-RampUpStartTimeMinute <Int32>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzWvdScalingPlanPooledSchedule
      -ScalingPlanScheduleName <String>
      -ScalingPlanInputObject <IDesktopVirtualizationIdentity>
      -ScalingPlanSchedule <IScalingPlanPooledSchedulePatch>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzWvdScalingPlanPooledSchedule
      -InputObject <IDesktopVirtualizationIdentity>
      [-DaysOfWeek <String[]>]
      [-OffPeakLoadBalancingAlgorithm <String>]
      [-OffPeakStartTimeHour <Int32>]
      [-OffPeakStartTimeMinute <Int32>]
      [-PeakLoadBalancingAlgorithm <String>]
      [-PeakStartTimeHour <Int32>]
      [-PeakStartTimeMinute <Int32>]
      [-RampDownCapacityThresholdPct <Int32>]
      [-RampDownForceLogoffUser]
      [-RampDownLoadBalancingAlgorithm <String>]
      [-RampDownMinimumHostsPct <Int32>]
      [-RampDownNotificationMessage <String>]
      [-RampDownStartTimeHour <Int32>]
      [-RampDownStartTimeMinute <Int32>]
      [-RampDownStopHostsWhen <String>]
      [-RampDownWaitTimeMinute <Int32>]
      [-RampUpCapacityThresholdPct <Int32>]
      [-RampUpLoadBalancingAlgorithm <String>]
      [-RampUpMinimumHostsPct <Int32>]
      [-RampUpStartTimeHour <Int32>]
      [-RampUpStartTimeMinute <Int32>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

update a ScalingPlanPooledSchedule.

Examples

Example 1: Update a ScalingPlanPooledSchedule

Update-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
----
spName/scheduleName

Updates an existing PooledSchedule in a 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:	String[]
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

-InputObject

Identity Parameter

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

-JsonFilePath

Path of Json file supplied to the Update operation

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

-JsonString

Json string supplied to the Update operation

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

-OffPeakLoadBalancingAlgorithm

Load balancing algorithm for off-peak period.

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

-ScalingPlanInputObject

Identity Parameter

Type:	IDesktopVirtualizationIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
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

-ScalingPlanSchedule

ScalingPlanPooledSchedule properties that can be patched.

Type:	IScalingPlanPooledSchedulePatch
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
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. The value must be an UUID.

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

Inputs

IDesktopVirtualizationIdentity

IScalingPlanPooledSchedulePatch

Outputs

IScalingPlanPooledSchedule

Share via

Update-AzWvdScalingPlanPooledSchedule

Syntax

Description

Examples

Example 1: Update a ScalingPlanPooledSchedule

Parameters

-Confirm

-DaysOfWeek

-DefaultProfile

-InputObject

-JsonFilePath

-JsonString

-OffPeakLoadBalancingAlgorithm

-OffPeakStartTimeHour

-OffPeakStartTimeMinute

-PeakLoadBalancingAlgorithm

-PeakStartTimeHour

-PeakStartTimeMinute

-RampDownCapacityThresholdPct

-RampDownForceLogoffUser

-RampDownLoadBalancingAlgorithm

-RampDownMinimumHostsPct

-RampDownNotificationMessage

-RampDownStartTimeHour

-RampDownStartTimeMinute

-RampDownStopHostsWhen

-RampDownWaitTimeMinute

-RampUpCapacityThresholdPct

-RampUpLoadBalancingAlgorithm

-RampUpMinimumHostsPct

-RampUpStartTimeHour

-RampUpStartTimeMinute

-ResourceGroupName

-ScalingPlanInputObject

-ScalingPlanName

-ScalingPlanSchedule

-ScalingPlanScheduleName

-SubscriptionId

-WhatIf

Inputs

Outputs

Additional resources