Test-SPOSite
Tests a SharePoint Online site collection.
Syntax
Default (Default)
Test-SPOSite
-Identity <SpoSitePipeBind>
[-RuleId <Guid>]
[-RunAlways]
[<CommonParameters>]
Description
The Test-SPOSite cmdlet runs one or all site collection health checks on the site collection and its contents.
Tests are intended not to make any changes except in repair mode, which can be initiated by running the Repair-SPOSite cmdlet.
This cmdlet reports the rules together with a summary of the results.
You must be at least a SharePoint administrator 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
Test-SPOSite https://contoso.sharepoint.com/sites/marketing
This example runs all the site collection health checks on the https://contoso.sharepoint.com/sites/marketing site collection.
Parameters
-Identity
Applicable: SharePoint Online
Specifies the SharePoint Online site collection to test.
Parameter properties
| Type: | Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RuleId
Applicable: SharePoint Online
Specifies the health check rule to run.
Parameter properties
| Type: | System.Guid |
| 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 |
-RunAlways
Applicable: SharePoint Online
Forces a rule to run even if a health check was run.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| 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.