Get-PubRDSDesktop

NAME

Get-PubRDSDesktop

SYNOPSIS

Retrieves information about one or multiple published desktops.

SYNTAX

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

Get-PubRDSDesktop [[-Id] <uint>] [-SiteId <uint>] [<CommonParameters>]

DESCRIPTION

Retrieves information about one or multiple published desktops.

The cmdlet returns an array of objects of type PubRDSDesktop.

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

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

PSAdmin.PubRDSDesktop

EXAMPLES


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

Get-PubRDSDesktop | 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-PubRDSDesktop "My RDS Desktop"

Retrieves the information about a desktop specified by name.

---------- EXAMPLE 3 ----------

Get-PubRDSDesktop -Id 11

Retrieves the information about a desktop specified by ID.

RELATED LINKS