Get-RASPubAVDDesktop.md

NAME

Get-RASPubAVDDesktop

SYNOPSIS

Retrieves information about one or multiple published desktops.

SYNTAX

Get-RASPubAVDDesktop [[-Id] (uint)] [SiteId (uint)] [(CommonParameters)]

Get-RASPubAVDDesktop [[-Name] (string)] [SiteId (uint)] [(CommonParameters)]

DESCRIPTION

Retrieves information about one or multiple published desktops.

The cmdlet returns an array of objects of type PubAVDDesktop.

To see the complete list of object properties, use the Format-List cmdlet (see examples).

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

PARAMETERS

Name (string)

Published resource name.

        Required?                    false

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Id (uint)

Published resource ID.

        Required?                    false

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

SiteId (uint)

Site ID.

        Required?                    false

        Position?                    named

        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

PubAVDDesktop

EXAMPLES

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

Get-RASPubAVDDesktop | Format-List

Retrieves information about all available published desktops.

The Format-List cmdlet formats the display output to include all available desktop properties. **---------- EXAMPLE 2 ----------

Get-RASPubAVDDesktop "My AVD Desktop"

Retrieves the information about a desktop specified by name. **---------- EXAMPLE 3 ----------

Get-RASPubAVDDesktop -Id 11

Retrieves the information about a desktop specified by ID.

RELATED LINKS

• New-RASPubAVDDesktop

• Set-RASPubAVDDesktop

• Remove-RASPubAVDDesktop