| external help file | Module Name | online version | schema |
|---|---|---|---|
SPClientCore.dll-Help.xml |
SPClientCore |
2.0.0 |
Retrieves one or more active site collections.
Get-KshTenantSiteCollection [-Identity] <TenantSiteCollection> [<CommonParameters>]
Get-KshTenantSiteCollection [-SiteCollectionUrl] <Uri> [<CommonParameters>]
Get-KshTenantSiteCollection [-GroupIdDefined] [-IncludePersonalSite] [-Template <String>] [-NoEnumerate]
[<CommonParameters>]
The Get-KshTenantSiteCollection cmdlet retrieves active site collections. This cmdlet can be used only when connected to the SharePoint admin center.
PS C:\> Get-KshTenantSiteCollection -SiteCollectionUrl 'https://example.sharepoint.com/sites/hub'Retrieves a site collection by site collection URL.
PS C:\> Get-KshTenantSiteCollectionRetrieves site collections excludes personal site collections.
PS C:\> Get-KshTenantSiteCollection -GroupIdDefinedRetrieves Office 365 Groups site collections.
PS C:\> Get-KshTenantSiteCollection -IncludePersonalSiteRetrieves site collections includes personal sites.
PS C:\> Get-KshTenantSiteCollection -Template 'STS#0'Retrieves team site (classic experience) site collections.
If specified, returns only Office 365 Groups site collections.
Type: SwitchParameter
Parameter Sets: ParamSet3
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the site collection.
Type: TenantSiteCollection
Parameter Sets: ParamSet1
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseIf specified, returns personal sites.
Type: SwitchParameter
Parameter Sets: ParamSet3
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIf specified, suppresses to enumerate objects.
Type: SwitchParameter
Parameter Sets: ParamSet3
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the site collection URL.
Type: Uri
Parameter Sets: ParamSet2
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the site template ID.
Type: String
Parameter Sets: ParamSet3
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.