Get-WebSitesSite
Gets configuration information for a website site.
Syntax
Get-WebSitesSite
[[-Name] <String>]
[[-SubscriptionId] <String>]
[[-WebSpaceName] <String>]
[-RawView]
[-HostName <String>]
[-Force]
[-RemoteSettings <RemoteSettings>]
[-SuppressRequestIdLine]
[-WorkerName <String>]
[-OwnerName <String>]
[-VirtualFarmName <String>]
[-VirtualFarmOwnerName <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Get-WebSitesSite cmdlet returns configuration information for a website site. When used without any parameters, Get-WebSitesSite returns information for all your website sites. However, you can use parameters such as Name, OwnerName, or WebSpaceName to return a specified subset of your sites. You can also use the RawView parameter to return detailed configuration information for each site.
Examples
Example 1: Return information about a site
PS C:\> Get-WebSitesSite -SiteName "Site01"This command returns information about the site named Site01.
Example 2: Return information about sites based on subscription and webspace
PS C:\> Get-WebSitesSite -SubscriptionId "eede207d-d263-4212-ad32-fd29b5a1a6ce" -WebSpaceName "WebSpace01"This command returns information for all sites with the subscription ID eede207d-d263-4212-ad32-fd29b5a1a6ceand the web space WebSpace01.
Example 3: Return detailed information about sites
PS C:\> Get-WebSitesSite -RawViewThis command returns detailed information for all your website sites.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
{{Fill Force Description}}
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HostName
Specifies the host name for the site being returned. For example:
-HostName "www.contoso.com"
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Specifies the name of the site being returned. For example:
-Name "ContosoInternal"
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-OwnerName
Specifies the name of a web site owner. For example:
-OwnerName "PattiF"
When this parameter is used Get-WebSitesSite returns information for sites owned by this user.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-RawView
Indicates that detailed information is returned for a site.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RemoteSettings
{{Fill RemoteSettings Description}}
| Type: | RemoteSettings |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionId
Specifies the ID of a subscription. For example:
-SubscriptionId "eede207d-d263-4212-ad32-fd29b5a1a6ce"
When this parameter is used information is only returned for sites associated with the specified subscription ID.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SuppressRequestIdLine
{{Fill SuppressRequestIdLine Description}}
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VirtualFarmName
Specifies the name of a virtual farm. For example:
-VirtualFarmName "ContosoVirtualFarm"
When this parameter is used, information is returned for all the sites associated with the virtual farm.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VirtualFarmOwnerName
Specifies the owner of a virtual farm. For example:
-VirtualFarmOwnerName "PattiF"
When this parameter is used, information is returned only for sites associated with virtual farms owned by the specified user.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WebSpaceName
Specifies a webspace. Default webspaces include:
- EastAsiaWebSpace
- EastUSWebSpace
- NorthCentralUSWebSpace
- NorthEuropeWebSpace
- WestEuropeWebsSpace
- WestUSWebSpace
For example:
-WebSpaceName "EastUSWebSpace"
When this parameter used, information is returned only for sites within the specified webspace.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WorkerName
Specifies the name of a worker (workers perform background processing for websites). For example:
-WorkerName "ContosoWorker1"
When this parameter is used, information is returned for all the sites associated with the specified worker.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |