Get-RASAVDCustomHost

NAME

SYNOPSIS

The cmdlet returns a list of Azure Virtual Desktop Custom Hosts.

SYNTAX

Get-RASAVDCustomHost -ProviderId (uint) [ShowHostsInHostPool (SwitchParameter)] [(CommonParameters)]

DESCRIPTION

The cmdlet returns a list of Azure Virtual Desktop Custom Hosts.

PARAMETERS

ProviderId (uint)

Provider ID from which to retrieve the Azure Virtual Desktop Custom Host information.

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

ShowHostsInHostPool (SwitchParameter)

Show Hosts in existing host pools.

        Required?                    false

        Position?                    named

        Default value                False

        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

AVDCustomHost

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASAVDCustomHost -ProviderId 2 | Format-List

Retrieves all the Custom Hosts under the Provider with ID 2.

The Format-List cmdlet formats the display output to include all available properties.