Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Test-SPOSite

Test-SPOSite

microsoft.online.sharepoint.powershell-1.dll, microsoft.online.sharepoint.powershell.dll

Synopsis

Tests a SharePoint Online site collection.

Syntax

Test-SPOSite [-Identity] [-RuleId] [-RunAlways] [<CommonParameters>]

Detailed 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 a SharePoint Online global administrator to run the Test-SPOSite cmdlet.

For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832).

Parameters

-Identity <SpoSitePipeBind>

Specifies the SharePoint Online site collection to test.

Aliases

None

Required?

True

Position

1

Default value

Accept pipeline input?

True

Accept wildcard characters?

False

-RuleId <Guid>

Specifies the health check rule to run.

Aliases

None

Required?

False

Position

Named

Default value

Accept pipeline input?

False

Accept wildcard characters?

False

-RunAlways <SwitchParameter>

Displays a message that states the effect of the command instead of executing the command.

Aliases

None

Required?

False

Position

Named

Default value

Accept pipeline input?

False

Accept wildcard characters?

False

Input Type

Return Type

Notes

None

Examples

--------------EXAMPLE ------------

This example runs all the site collection health checks on the https://contoso.sharepoint.com/sites/marketing site collection.

C:\PS>Test-SPOSite https://contoso.sharepoint.com/sites/marketing

Introduction to the SharePoint Online management shell
Set up the SharePoint Online Management Shell Windows PowerShell environment
Get-SPOAppErrors
Get-SPOSite
New-SPOSite
Repair-SPOSite