Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Update-AzWvdScalingPlan

Update a scaling plan.

Syntax

UpdateExpanded (Default)

Update-AzWvdScalingPlan
 -Name <String>
 -ResourceGroupName <String>
 [-SubscriptionId <String>]
 [-Description <String>]
 [-ExclusionTag <String>]
 [-FriendlyName <String>]
 [-HostPoolReference <IScalingHostPoolReference[]>]
 [-Schedule <IScalingSchedule[]>]
 [-Tag <Hashtable>]
 [-TimeZone <String>]
 [-DefaultProfile <PSObject>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

UpdateViaJsonString

Update-AzWvdScalingPlan
 -Name <String>
 -ResourceGroupName <String>
 -JsonString <String>
 [-SubscriptionId <String>]
 [-DefaultProfile <PSObject>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

UpdateViaJsonFilePath

Update-AzWvdScalingPlan
 -Name <String>
 -ResourceGroupName <String>
 -JsonFilePath <String>
 [-SubscriptionId <String>]
 [-DefaultProfile <PSObject>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

UpdateViaIdentityExpanded

Update-AzWvdScalingPlan
 -InputObject <IDesktopVirtualizationIdentity>
 [-Description <String>]
 [-ExclusionTag <String>]
 [-FriendlyName <String>]
 [-HostPoolReference <IScalingHostPoolReference[]>]
 [-Schedule <IScalingSchedule[]>]
 [-Tag <Hashtable>]
 [-TimeZone <String>]
 [-DefaultProfile <PSObject>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Description

Update a scaling plan.

Examples

Example 1: Update a Windows Virtual Desktop Scaling Plan by name

Update-AzWvdScalingPlan `
 -ResourceGroupName ResourceGroupName `
 -Name 'ScalingPlan1' `
 -Description 'Description' `
 -FriendlyName 'Friendly Name' `
 -TimeZone 'Pacific Standard Time' `
 -Schedule @(
 @{
 'Name' = 'Work Week';
 'DaysOfWeek' = @('Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday');
 'RampUpStartTime' = @{
 'Hour' = 7
 'Minute' = 0
 };
 'RampUpLoadBalancingAlgorithm' = 'BreadthFirst';
 'RampUpMinimumHostsPct' = 20;
 'RampUpCapacityThresholdPct' = 20;

 'PeakStartTime' = @{
 'Hour' = 9
 'Minute' = 30
 };
 'PeakLoadBalancingAlgorithm' = 'DepthFirst';

 'RampDownStartTime' = @{
 'Hour' = 16
 'Minute' = 15
 };
 'RampDownLoadBalancingAlgorithm' = 'BreadthFirst';
 'RampDownMinimumHostsPct' = 20;
 'RampDownCapacityThresholdPct' = 20;
 'RampDownForceLogoffUser' = $true;
 'RampDownWaitTimeMinute' = 30;
 'RampDownNotificationMessage' = 'Log out now, please.';
 'RampDownStopHostsWhen' = 'ZeroSessions';

 'OffPeakStartTime' = @{
 'Hour' = 18
 'Minute' = 0
 };
 'OffPeakLoadBalancingAlgorithm' = 'DepthFirst';
 }
 ) `
 -HostPoolReference @(
 @{
 'HostPoolArmPath' = '/subscriptions/SubscriptionId/resourceGroups/ResourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/HostPoolName1';
 'ScalingPlanEnabled' = $false;
 },
 @{
 'HostPoolArmPath' = '/subscriptions/SubscriptionId/resourceGroups/ResourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/HostPoolName2';
 'ScalingPlanEnabled' = $false;
 }

 )
Location Name Type
-------- ---- ----
westcentralus scalingPlan1 Microsoft.DesktopVirtualization/scalingplans

This command updates a Windows Virtual Desktop Scaling Plan in a Resource Group.

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

-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

-Description

Description of scaling plan.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-ExclusionTag

Exclusion tag for scaling plan.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-FriendlyName

User friendly name of scaling plan.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-HostPoolReference

List of ScalingHostPoolReference definitions.

Parameter properties

Type:

IScalingHostPoolReference[]

Default value:None
Supports wildcards:False
DontShow:False

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

-Name

The name of the scaling plan.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ScalingPlanName

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

-Schedule

List of ScalingSchedule definitions.

Parameter properties

Type:

IScalingSchedule[]

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

-Tag

tags to be updated

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-TimeZone

Timezone of the scaling plan.

Parameter properties

Type:String
Default value:None
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

Outputs

IScalingPlan


Feedback

Was this page helpful?