New-AzWvdScalingPlan

Syntax

CreateExpanded (Default)

New-AzWvdScalingPlan
 -Name <String>
 -ResourceGroupName <String>
 -Location <String>
 -TimeZone <String>
 [-SubscriptionId <String>]
 [-Description <String>]
 [-ExclusionTag <String>]
 [-FriendlyName <String>]
 [-HostPoolReference <IScalingHostPoolReference[]>]
 [-HostPoolType <String>]
 [-IdentityType <String>]
 [-Kind <String>]
 [-ManagedBy <String>]
 [-PlanName <String>]
 [-PlanProduct <String>]
 [-PlanPromotionCode <String>]
 [-PlanPublisher <String>]
 [-PlanVersion <String>]
 [-Schedule <IScalingSchedule[]>]
 [-SkuCapacity <Int32>]
 [-SkuFamily <String>]
 [-SkuName <String>]
 [-SkuSize <String>]
 [-SkuTier <String>]
 [-Tag <Hashtable>]
 [-DefaultProfile <PSObject>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

CreateViaJsonFilePath

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

CreateViaJsonString

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

Description

Examples

Example 1: Create a Windows Virtual Desktop Scaling Plan without a schedule

New-AzWvdScalingPlan `
 -ResourceGroupName ResourceGroupName `
 -Name 'ScalingPlan1' `
 -Location 'westcentralus' `
 -Description 'Description' `
 -FriendlyName 'Friendly Name' `
 -HostPoolType 'Pooled' `
 -TimeZone 'Pacific Standard Time' `
 -Schedule @() `
 -HostPoolReference @(
 @{
 'HostPoolArmPath' = '/subscriptions/SubscriptionId/resourceGroups/ResourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/HostPoolName';
 'ScalingPlanEnabled' = $false;
 }
 )

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

Example 2: Create a Windows Virtual Desktop Scaling Plan with a pooled schedule (Only available for Pooled HostPools)

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

 'PeakStartTime' = @{
 'Hour' = 8
 '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/HostPoolName';
 'ScalingPlanEnabled' = $false;
 }
 )

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

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

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

Parameter sets

-Description

Description of scaling plan.

Parameter properties

Parameter sets

-ExclusionTag

Exclusion tag for scaling plan.

Parameter properties

Parameter sets

-FriendlyName

User friendly name of scaling plan.

Parameter properties

Parameter sets

-HostPoolReference

List of ScalingHostPoolReference definitions.

Parameter properties

Parameter sets

-HostPoolType

HostPool type for desktop.

Parameter properties

Parameter sets

-IdentityType

Type of managed service identity (either system assigned, or none).

Parameter properties

Parameter sets

-JsonFilePath

Path of Json file supplied to the Create operation

Parameter properties

Parameter sets

-JsonString

Json string supplied to the Create operation

Parameter properties

Parameter sets

-Kind

Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

Parameter properties

Parameter sets

-Location

The geo-location where the resource lives

Parameter properties

Parameter sets

-ManagedBy

The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.

Parameter properties

Parameter sets

-Name

The name of the scaling plan.

Parameter properties

Parameter sets

-PlanName

A user defined name of the 3rd Party Artifact that is being procured.

Parameter properties

Parameter sets

-PlanProduct

The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.

Parameter properties

Parameter sets

-PlanPromotionCode

A publisher provided promotion code as provisioned in Data Market for the said product/artifact.

Parameter properties

Parameter sets

-PlanPublisher

The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic

Parameter properties

Parameter sets

-PlanVersion

The version of the desired product/artifact.

Parameter properties

Parameter sets

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Parameter properties

Parameter sets

-Schedule

List of ScalingPlanPooledSchedule definitions.

Parameter properties

Parameter sets

-SkuCapacity

If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

Parameter properties

Parameter sets

-SkuFamily

If the service has different generations of hardware, for the same SKU, then that can be captured here.

Parameter properties

Parameter sets

-SkuName

The name of the SKU. E.g. P3. It is typically a letter+number code

Parameter properties

Parameter sets

-SkuSize

The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

Parameter properties

Parameter sets

-SkuTier

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

Parameter properties

Parameter sets

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

Parameter properties

Parameter sets

-Tag

Resource tags.

Parameter properties

Parameter sets

-TimeZone

Timezone of the scaling plan.

Parameter properties

Parameter sets

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Parameter sets

CommonParameters

Outputs

IScalingPlan