Get-WebSitesSite

Gets a web site and its configuration settings.

Syntax

Parameter Set: Default
Get-WebSitesSite [[-Name] <String> ] [[-SubscriptionId] <String> ] [[-WebSpaceName] <String> ] [-HostName <String> ] [-OwnerName <String> ] [-PipelineVariable <String> ] [-RawView] [-VirtualFarmName <String> ] [-VirtualFarmOwnerName <String> ] [-WorkerName <String> ] [ <CommonParameters>]

Detailed Description

The Get-WebSitesSite cmdlet gets a web site and its configuration settings. By default, all sites are returned. To specify a specific site, use the Name parameter. Specifying the RawView parameter provides detailed information about the site.

Parameters

-HostName<String>

Specifies a host name for the site.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-Name<String>

Specifies a name for the site.

Aliases	none
Required?	false
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-OwnerName<String>

Specifies the name of an owner.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-PipelineVariable<String>

Specifies a variable to be used with the pipeline operator.

Aliases	pv
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-RawView

Indicates that detailed information about the site is provided.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-SubscriptionId<String>

Specifies the ID of a subscription.

Aliases	none
Required?	false
Position?	2
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-VirtualFarmName<String>

Specifies the name of the virtual farm to which the site belongs.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-VirtualFarmOwnerName<String>

Specifies the owner of the virtual farm to which the site belongs.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-WebSpaceName<String>

Specifies the web space to which the site belongs.

Aliases	none
Required?	false
Position?	3
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-WorkerName<String>

Specifies the name of the worker that the site is on.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.

Examples

Example 1: Get a specific site

This command gets the site named Site01 and displays information about this site to the user.

PS C:\> Get-WebSitesSite -SiteName "Site01"

Example 2: Get specific sites by subscription and web space

This command gets all sites with the subscription ID of Subscription01 and web space of WebSpace01, and displays information about the sites to the user.

PS C:\> Get-WebSitesSite -SubscriptionId "Subscription01" -WebSpaceName "WebSpace01"

Example 3: Get detailed information about all sites

This command gets all sites and displays detailed information about each site to the user.

PS C:\> Get-WebSitesSite -RawView

Get-WebSitesSite