Note

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

Access to this page requires authorization. You can try .

Get-AzWvdScalingPlan

Get a scaling plan.

Syntax

List1 (Default) 

Get-AzWvdScalingPlan
 [-SubscriptionId <String[]>]
 [-InitialSkip <Int32>]
 [-IsDescending]
 [-PageSize <Int32>]
 [-DefaultProfile <PSObject>]
 [<CommonParameters>]

Get 

Get-AzWvdScalingPlan
 -Name <String>
 -ResourceGroupName <String>
 [-SubscriptionId <String[]>]
 [-DefaultProfile <PSObject>]
 [<CommonParameters>]

List2 

Get-AzWvdScalingPlan
 -ResourceGroupName <String>
 -HostPoolName <String>
 [-SubscriptionId <String[]>]
 [-InitialSkip <Int32>]
 [-IsDescending]
 [-PageSize <Int32>]
 [-DefaultProfile <PSObject>]
 [<CommonParameters>]

List 

Get-AzWvdScalingPlan
 -ResourceGroupName <String>
 [-SubscriptionId <String[]>]
 [-InitialSkip <Int32>]
 [-IsDescending]
 [-PageSize <Int32>]
 [-DefaultProfile <PSObject>]
 [<CommonParameters>]

GetViaIdentity 

Get-AzWvdScalingPlan
 -InputObject <IDesktopVirtualizationIdentity>
 [-DefaultProfile <PSObject>]
 [<CommonParameters>]

Description

Get a scaling plan.

Examples

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

Get-AzWvdScalingPlan -ResourceGroupName ResourceGroupName -Name scalingPlan1

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

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

Example 2: List Windows Virtual Desktop Scaling Plans

Get-AzWvdScalingPlan -ResourceGroupName ResourceGroupName

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

This command lists all the Windows Virtual Desktop Scaling Plans in a Resource Group.

Parameters

-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

-HostPoolName

The name of the host pool within the specified resource group

Parameter properties

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

Parameter sets

-InitialSkip

Initial number of items to skip.

Parameter properties

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

-IsDescending

Indicates whether the collection is descending.

Parameter properties

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

-PageSize

Number of items per page.

Parameter properties

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

-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

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?