Get-RASAVDHostPoolStatus
NAME
Get-RASAVDHostPoolStatus
SYNOPSIS
Retrieves the status of one or multiple Azure Virtual Desktop Host Pools.
SYNTAX
Get-RASAVDHostPoolStatus [[-Id] <uint>] [<CommonParameters>]
Get-RASAVDHostPoolStatus [[-InputObject] <AVDHostPool>] [<CommonParameters>]
Get-RASAVDHostPoolStatus [[-Name] <string>] [[-SiteId] <uint>] [<CommonParameters>]
DESCRIPTION
Retrieves information about the status of one or multiple Azure Virtual Desktop Host Pools.
The cmdlet returns an object of type AVDHostPoolStatus.
To see the complete list of object properties, use the Format-List cmdlet (see examples).
The result set contains only the major properties of a group; it does not include the complete list of settings supported in RAS.
PARAMETERS
-Name <string> The name of the AVD Host Pool for which to retrieve the status.
-SiteId <uint> Site ID from which to retrieve the specified RDS Host Pool Name.
If the parameter is omitted, the site ID of the Licensing Server will be used.
-Id <uint> The ID of the AVD Host Pool. To obtain the ID, use the Get-RASAVDHostPool cmdlet.
-InputObject <AVDHostPool> An object of type AVDHostPool representing the AVD Host Pool.
To obtain the object, use the Get-RASAVDHostPool cmdlet.
<CommonParameters>
INPUTS
OUTPUTS
EXAMPLES
---------- EXAMPLE 1 ----------
Get-RASAVDHostPoolStatus "My AVD Host Pool" | Format-List
Retrieves the status of the AVD Host Pool specified by name from the Licensing Server site.
To retrieve the info from a specific site, specify the -SiteId parameter.
The Format-List cmdlet formats the display output to include all available pool properties. ---------- EXAMPLE 2 ----------
Get-RASAVDHostPoolStatus -Id 10
Retrieves the status information about the AVD Host Pool specified by Id from the Licensing Server site.
RELATED LINKS
Last updated