Edit

Share via

Test-SPOSite

  • Reference
Module:
Microsoft.Online.SharePoint.PowerShell
Applies to:
SharePoint Online

Tests a SharePoint Online site collection.

Syntax

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

Specifies the SharePoint Online site collection to test.

Type:SpoSitePipeBind
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Online

-RuleId

Specifies the health check rule to run.

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Online

-RunAlways

Forces a rule to run even if a health check was run.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Online