Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Update-AzWvdScalingPlanPersonalSchedule
- Module:
- Az.DesktopVirtualization Module
Update a ScalingPlanPersonalSchedule.
Syntax
UpdateExpanded (Default)
Update-AzWvdScalingPlanPersonalSchedule
-ResourceGroupName <String>
-ScalingPlanName <String>
-ScalingPlanScheduleName <String>
[-SubscriptionId <String>]
[-DaysOfWeek <String[]>]
[-OffPeakActionOnDisconnect <String>]
[-OffPeakActionOnLogoff <String>]
[-OffPeakMinutesToWaitOnDisconnect <Int32>]
[-OffPeakMinutesToWaitOnLogoff <Int32>]
[-OffPeakStartTimeHour <Int32>]
[-OffPeakStartTimeMinute <Int32>]
[-OffPeakStartVMOnConnect <String>]
[-PeakActionOnDisconnect <String>]
[-PeakActionOnLogoff <String>]
[-PeakMinutesToWaitOnDisconnect <Int32>]
[-PeakMinutesToWaitOnLogoff <Int32>]
[-PeakStartTimeHour <Int32>]
[-PeakStartTimeMinute <Int32>]
[-PeakStartVMOnConnect <String>]
[-RampDownActionOnDisconnect <String>]
[-RampDownActionOnLogoff <String>]
[-RampDownMinutesToWaitOnDisconnect <Int32>]
[-RampDownMinutesToWaitOnLogoff <Int32>]
[-RampDownStartTimeHour <Int32>]
[-RampDownStartTimeMinute <Int32>]
[-RampDownStartVMOnConnect <String>]
[-RampUpActionOnDisconnect <String>]
[-RampUpActionOnLogoff <String>]
[-RampUpAutoStartHost <String>]
[-RampUpMinutesToWaitOnDisconnect <Int32>]
[-RampUpMinutesToWaitOnLogoff <Int32>]
[-RampUpStartTimeHour <Int32>]
[-RampUpStartTimeMinute <Int32>]
[-RampUpStartVMOnConnect <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaJsonString
Update-AzWvdScalingPlanPersonalSchedule
-ResourceGroupName <String>
-ScalingPlanName <String>
-ScalingPlanScheduleName <String>
-JsonString <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaJsonFilePath
Update-AzWvdScalingPlanPersonalSchedule
-ResourceGroupName <String>
-ScalingPlanName <String>
-ScalingPlanScheduleName <String>
-JsonFilePath <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityScalingPlanExpanded
Update-AzWvdScalingPlanPersonalSchedule
-ScalingPlanScheduleName <String>
-ScalingPlanInputObject <IDesktopVirtualizationIdentity>
[-DaysOfWeek <String[]>]
[-OffPeakActionOnDisconnect <String>]
[-OffPeakActionOnLogoff <String>]
[-OffPeakMinutesToWaitOnDisconnect <Int32>]
[-OffPeakMinutesToWaitOnLogoff <Int32>]
[-OffPeakStartTimeHour <Int32>]
[-OffPeakStartTimeMinute <Int32>]
[-OffPeakStartVMOnConnect <String>]
[-PeakActionOnDisconnect <String>]
[-PeakActionOnLogoff <String>]
[-PeakMinutesToWaitOnDisconnect <Int32>]
[-PeakMinutesToWaitOnLogoff <Int32>]
[-PeakStartTimeHour <Int32>]
[-PeakStartTimeMinute <Int32>]
[-PeakStartVMOnConnect <String>]
[-RampDownActionOnDisconnect <String>]
[-RampDownActionOnLogoff <String>]
[-RampDownMinutesToWaitOnDisconnect <Int32>]
[-RampDownMinutesToWaitOnLogoff <Int32>]
[-RampDownStartTimeHour <Int32>]
[-RampDownStartTimeMinute <Int32>]
[-RampDownStartVMOnConnect <String>]
[-RampUpActionOnDisconnect <String>]
[-RampUpActionOnLogoff <String>]
[-RampUpAutoStartHost <String>]
[-RampUpMinutesToWaitOnDisconnect <Int32>]
[-RampUpMinutesToWaitOnLogoff <Int32>]
[-RampUpStartTimeHour <Int32>]
[-RampUpStartTimeMinute <Int32>]
[-RampUpStartVMOnConnect <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityScalingPlan
Update-AzWvdScalingPlanPersonalSchedule
-ScalingPlanScheduleName <String>
-ScalingPlanInputObject <IDesktopVirtualizationIdentity>
-ScalingPlanSchedule <IScalingPlanPersonalSchedulePatch>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityExpanded
Update-AzWvdScalingPlanPersonalSchedule
-InputObject <IDesktopVirtualizationIdentity>
[-DaysOfWeek <String[]>]
[-OffPeakActionOnDisconnect <String>]
[-OffPeakActionOnLogoff <String>]
[-OffPeakMinutesToWaitOnDisconnect <Int32>]
[-OffPeakMinutesToWaitOnLogoff <Int32>]
[-OffPeakStartTimeHour <Int32>]
[-OffPeakStartTimeMinute <Int32>]
[-OffPeakStartVMOnConnect <String>]
[-PeakActionOnDisconnect <String>]
[-PeakActionOnLogoff <String>]
[-PeakMinutesToWaitOnDisconnect <Int32>]
[-PeakMinutesToWaitOnLogoff <Int32>]
[-PeakStartTimeHour <Int32>]
[-PeakStartTimeMinute <Int32>]
[-PeakStartVMOnConnect <String>]
[-RampDownActionOnDisconnect <String>]
[-RampDownActionOnLogoff <String>]
[-RampDownMinutesToWaitOnDisconnect <Int32>]
[-RampDownMinutesToWaitOnLogoff <Int32>]
[-RampDownStartTimeHour <Int32>]
[-RampDownStartTimeMinute <Int32>]
[-RampDownStartVMOnConnect <String>]
[-RampUpActionOnDisconnect <String>]
[-RampUpActionOnLogoff <String>]
[-RampUpAutoStartHost <String>]
[-RampUpMinutesToWaitOnDisconnect <Int32>]
[-RampUpMinutesToWaitOnLogoff <Int32>]
[-RampUpStartTimeHour <Int32>]
[-RampUpStartTimeMinute <Int32>]
[-RampUpStartVMOnConnect <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Update a ScalingPlanPersonalSchedule.
Examples
Example 1: Update a ScalingPlanPersonalSchedule
Update-AzWvdScalingPlanPersonalSchedule -ResourceGroupName rgName `
-ScalingPlanName spName `
-ScalingPlanScheduleName scheduleName `
-DaysOfWeek @('Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday') `
-RampUpStartTimeHour 6 `
-RampUpStartTimeMinute 30 `
-RampUpAutoStartHost All `
-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
----
spName/scheduleName
Updates an existing PersonalSchedule in a Scaling Plan.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-DaysOfWeek
Set of days of the week on which this schedule is active.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Parameter properties
| Type: | PSObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzureRMContext, AzureCredential |
Parameter sets
-InputObject
Identity Parameter
Parameter properties
| Type: | IDesktopVirtualizationIdentity |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-JsonFilePath
Path of Json file supplied to the Update operation
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-JsonString
Json string supplied to the Update operation
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-OffPeakActionOnDisconnect
Action to be taken after a user disconnect during the off-peak period.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-OffPeakActionOnLogoff
Action to be taken after a logoff during the off-peak period.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-OffPeakMinutesToWaitOnDisconnect
The time in minutes to wait before performing the desired session handling action when a user disconnects during the off-peak period.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-OffPeakMinutesToWaitOnLogoff
The time in minutes to wait before performing the desired session handling action when a user logs off during the off-peak period.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-OffPeakStartTimeHour
The hour.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-OffPeakStartTimeMinute
The minute.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-OffPeakStartVMOnConnect
The desired configuration of Start VM On Connect for the hostpool during the off-peak phase.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PeakActionOnDisconnect
Action to be taken after a user disconnect during the peak period.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PeakActionOnLogoff
Action to be taken after a logoff during the peak period.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PeakMinutesToWaitOnDisconnect
The time in minutes to wait before performing the desired session handling action when a user disconnects during the peak period.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PeakMinutesToWaitOnLogoff
The time in minutes to wait before performing the desired session handling action when a user logs off during the peak period.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PeakStartTimeHour
The hour.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PeakStartTimeMinute
The minute.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PeakStartVMOnConnect
The desired configuration of Start VM On Connect for the hostpool during the peak phase.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-RampDownActionOnDisconnect
Action to be taken after a user disconnect during the ramp down period.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-RampDownActionOnLogoff
Action to be taken after a logoff during the ramp down period.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-RampDownMinutesToWaitOnDisconnect
The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp down period.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-RampDownMinutesToWaitOnLogoff
The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp down period.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-RampDownStartTimeHour
The hour.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-RampDownStartTimeMinute
The minute.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-RampDownStartVMOnConnect
The desired configuration of Start VM On Connect for the hostpool during the ramp down phase.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-RampUpActionOnDisconnect
Action to be taken after a user disconnect during the ramp up period.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-RampUpActionOnLogoff
Action to be taken after a logoff during the ramp up period.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-RampUpAutoStartHost
The desired startup behavior during the ramp up period for personal vms in the hostpool.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-RampUpMinutesToWaitOnDisconnect
The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp up period.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-RampUpMinutesToWaitOnLogoff
The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp up period.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-RampUpStartTimeHour
The hour.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-RampUpStartTimeMinute
The minute.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResourceGroupName
The name of the resource group. The name is case insensitive.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ScalingPlanInputObject
Identity Parameter
Parameter properties
| Type: | IDesktopVirtualizationIdentity |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ScalingPlanName
The name of the scaling plan.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ScalingPlanSchedule
ScalingPlanPersonalSchedule properties that can be patched.
Parameter properties
| Type: | IScalingPlanPersonalSchedulePatch |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ScalingPlanScheduleName
The name of the ScalingPlanSchedule
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SubscriptionId
The ID of the target subscription. The value must be an UUID.
Parameter properties
| Type: | String |
| Default value: | (Get-AzContext).Subscription.Id |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
IDesktopVirtualizationIdentity
IScalingPlanPersonalSchedulePatch
Outputs
IScalingPlanPersonalSchedule
Azure PowerShell
Feedback
Was this page helpful?