Get-RASAVDHostPool

NAME

Get-RASAVDHostPool

SYNOPSIS

Retrieves information about one or multiple Azure Virtual Desktop HostPool properties.

SYNTAX

Get-RASAVDHostPool [[-Id] <uint>] [<CommonParameters>]

Get-RASAVDHostPool [[-Name] <string>] [[-SiteId] <uint>] [<CommonParameters>]

DESCRIPTION

The cmdlet returns an object of type Azure Virtual Desktop HostPool properties.

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 pool; it does not include the complete list of settings supported in RAS.

This is an Experimental feature which is subject to slight changes.

PARAMETERS


-Name <string>
The name of the Azure Virtual Desktop Host Pool for which to retrieve the information.

This must be the actual AVD Host Pool name used in the RAS farm. 

        Required?                    false
        Position?                    0
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-SiteId <uint>
Site ID from which to retrieve the AVD Host Pool information.

If the parameter is omitted, the Licensing Server site ID will be used. 

        Required?                    false
        Position?                    1
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Id <uint>
The ID of a Azure Virtual Desktop Host Pool for which to retrieve the information. 

        Required?                    false
        Position?                    0
        Default value                0
        Accept pipeline input?       false
        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

-none-

OUTPUTS

AVDHostPool

EXAMPLES


---------- EXAMPLE 1 ----------

Get-RASAVDHostPool -Name "My AVDHostPool" | Format-List

Retrieves information about the AVDHostPool properties specified by name from the Licensing Server site.
---------- EXAMPLE 2 ----------

Get-RASAVDHostPool -Id 10

Retrieves information about the AVDHostPool specified by ID from the Licensing Server site.

RELATED LINKS