Get-Site

NAME

Get-Site

SYNOPSIS

Retrieves information about one or multiple sites.

SYNTAX

Get-Site [[-Name] <string>] [<CommonParameters>]

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

DESCRIPTION

Retrieves information about one or multiple sites.

The cmdlet returns an array of objects of type Site.

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

PARAMETERS


-Name <string>
The name of the site for which to retrieve the information. 

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

-Id <uint>
The ID of the site from 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

Site

EXAMPLES


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

Get-Site | Format-List

Retrieves the list of all available sites.

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

---------- EXAMPLE 2 ----------

Get-Site "My-Site"

Retrieves information about the site specified by name.

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

Get-Site -Id 1

Retrieves information about the site specified by ID.

RELATED LINKS