Get-AzWvdHostPool

Reference

Module:: Az.DesktopVirtualization

Get a host pool.

Syntax

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

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

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

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

Description

Get a host pool.

Examples

Example 1: Get a Windows Virtual Desktop HostPool by name

Get-AzWvdHostPool -ResourceGroupName ResourceGroupName -Name HostPoolName

Location   Name                 Type
--------   ----                 ----
eastus     HostPoolName Microsoft.DesktopVirtualization/hostpools

This command gets a Windows Virtual Desktop HostPool in a Resource Group.

Example 2: List Windows Virtual Desktop HostPools

Get-AzWvdHostPool -ResourceGroupName ResourceGroupName

Location   Name          Type
--------   ----          ----
eastus     HostPoolName1 Microsoft.DesktopVirtualization/hostpools
eastus     HostPoolName2 Microsoft.DesktopVirtualization/hostpools

This command lists a Windows Virtual Desktop HostPools 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.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InitialSkip

Initial number of items to skip.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Identity Parameter

Type:	IDesktopVirtualizationIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-IsDescending

Indicates whether the collection is descending.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

The name of the host pool within the specified resource group

Type:	String
Aliases:	HostPoolName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-PageSize

Number of items per page.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

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

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

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

Type:	String[]
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

IDesktopVirtualizationIdentity

Outputs

IHostPool

Share via