Get-RASAVDHostStatus.md

NAME

Get-RASAVDHostStatus

SYNOPSIS

Retrieves the list of, or a specific, Azure Virtual Desktop Host status.

SYNTAX

**Get-RASAVDHostStatus [ProviderId] (uint) [[-SiteId] (uint)] -HostId (string) [-StatusLevel {Level1 | Level2 | Level3}] [User (string)] [(CommonParameters)]

**Get-RASAVDHostStatus [-InputObject] (AVDHost) [ProviderId] (uint) [[-SiteId] (uint)] [-StatusLevel {Level1 | Level2 | Level3}] [User (string)] [(CommonParameters)]

**Get-RASAVDHostStatus [[-ProviderId] (uint)] [[-SiteId] (uint)] [-StatusLevel {Level1 | Level2 | Level3}] [User (string)] [(CommonParameters)]

DESCRIPTION

Retrieves the list of, or a specific, Azure Virtual Desktop Host status.

PARAMETERS

ProviderId (uint)

The ID of a Provider server from which to obtain the AVD Host list.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

SiteId (uint)

Site ID from which to retrieve the AVD Host list.

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

HostId (string)

The ID of the AVD Host. To obtain the ID, use the Get-RASAVDHost cmdlet.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

InputObject (AVDHost)

An object of type AVDHost representing a AVD Host for which to retrieve the information.

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

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

User (string)

The username assigned to AVD Host.

If empty square brackets ([]) are passed, the AVD Host list will be filtered with those with an assigned user.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

StatusLevel (StatusLevel)

Specifies the level of detail that should be returned.

Acceptable values: Level1 (AVD Host status information only), Level2 (AVD Host status and Host VM info), Level3 (AVD Host status, Host VMs, Applications).

Possible values: Level1, Level2, Level3

        Required?                    false

        Position?                    named

        Default value                Level1

        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

AVDHost

OUTPUTS

AVDHostSysInfo

EXAMPLES

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

Get-RASAVDHostStatus | Format-List

Retrieves the list of AVD Host statuses **---------- EXAMPLE 2 ----------

Get-RASAVDHostStatus -ProviderId 1

Retrieves the list of AVD Host statuses from the specified Provider server **---------- EXAMPLE 3 ----------

Get-RASAVDHostStatus -ProviderId 1 -SiteId 1

Retrieves the list of AVD Host statuses from the specified Provider server from the specified site. **---------- EXAMPLE 4 ----------

Get-RASAVDHostStatus -ProviderId 1 -SiteId 1 -HostId "1" | Format-List

Retrieves the specified AVD Host status from the specified Provider server from the specified site.

RELATED LINKS

• New-RASAVDHost

• Get-RASAVDHost

• Remove-RASAVDHost