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.

        Required?                    false

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-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.

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Id <uint> The ID of the AVD Host Pool. To obtain the ID, use the Get-RASAVDHostPool cmdlet.

        Required?                    false

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <AVDHostPool> An object of type AVDHostPool representing the AVD Host Pool.

To obtain the object, use the Get-RASAVDHostPool cmdlet.

        Required?                    false

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

<CommonParameters>

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

INPUTS

AVDHostPool

OUTPUTS

AVDHostPoolStatus

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

• New-RASAVDHostPool

• Get-RASAVDHostPool

• Set-RASAVDHostPool

• Remove-RASAVDHostPool