Get-SPODeletedSite
Returns all deleted site collections from the Recycle Bin.
Syntax
ParameterSetAllSites (Default)
Get-SPODeletedSite
[[-Identity] <SpoSitePipeBind>]
[-Limit <String>]
[-IncludePersonalSite]
[<CommonParameters>]
ParameterSetPersonalSitesOnly
Get-SPODeletedSite
[[-Identity] <SpoSitePipeBind>]
[-Limit <String>]
[-IncludeOnlyPersonalSite]
[<CommonParameters>]
Description
The Get-SPODeletedSite cmdlet returns all deleted site collections that match the given criteria from the Recycle Bin.
By default the cmdlet only returns site and site collections that are not Personal Sites (My Sites). To include personal sites, use the IncludePersonalSite parameter. To return only Personal Sites, use the IncludeOnlyPersonalSite parameter.
These two Switch Parameters are in different parameter sets, so you can only use either one of them but not both.
This action does not restore these returned sites or site collection.
It only returns their properties so that you can see what sites or site collections have been deleted.
To restore the site or site collections, forward the results to the Restore-SPODeletedSite cmdlet in the pipeline.
You must be a SharePoint Online administrator and be a site collection administrator for the deleted site collections to run the cmdlet.
For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at Intro to SharePoint Online Management Shell.
Examples
Example 1
Get-SPODeletedSite -IncludePersonalSite
The command in this example returns all deleted site collections from the Recycle Bin including Personal Sites.
Parameters
-Identity
Applicable: SharePoint Online
Specifies the URL of the deleted site collection to be returned.
Parameter properties
| Type: | Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-IncludeOnlyPersonalSite
Applicable: SharePoint Online
Use this switch parameter to only include Personal Sites in the returned results.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ParameterSetPersonalSitesOnly
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-IncludePersonalSite
Applicable: SharePoint Online
Use this switch parameter to include Personal Sites with the returned results.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ParameterSetAllSites
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Limit
Applicable: SharePoint Online
Specifies the maximum number of site collections to return. It can be any number. To retrieve all site collections, use ALL. The default value is 200.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.