Update-AzWvdScalingPlanPersonalSchedule
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
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
UpdateViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-JsonFilePath
Path of Json file supplied to the Update operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-JsonString
Json string supplied to the Update operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-OffPeakStartTimeHour
The hour.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-OffPeakStartTimeMinute
The minute.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PeakStartTimeHour
The hour.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PeakStartTimeMinute
The minute.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-RampDownStartTimeHour
The hour.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-RampDownStartTimeMinute
The minute.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-RampUpStartTimeHour
The hour.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-RampUpStartTimeMinute
The minute.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
UpdateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlan
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-ScalingPlanName
The name of the scaling plan.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ScalingPlanSchedule
ScalingPlanPersonalSchedule properties that can be patched.
Parameter properties
Parameter sets
UpdateViaIdentityScalingPlan
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-ScalingPlanScheduleName
The name of the ScalingPlanSchedule
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlanExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityScalingPlan
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaJsonString
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaJsonFilePath
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
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 .
Outputs