Set-SPOSiteArchiveState

Reference

Module:: Microsoft.Online.SharePoint.PowerShell

Applies to:: SharePoint Online

Sets the archived state of the site. Can be used to archive and reactivate sites.

Syntax

Set-SPOSiteArchiveState
   [-Identity] <SpoHubSitePipeBind>
   -ArchiveState <String>
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]

Description

Use this cmdlet to change the archive status of the site. You must be at least a SharePoint Online administrator and be a site collection administrator to run the cmdlet. Microsoft 365 Archive needs to be enabled for the organization to be able to use the feature.

Examples

Example 1

Set-SPOSiteArchiveState https://contoso.sharepoint.com/sites/Marketing -ArchiveState Archived

This example marks the site as Archived. For seven days after the operation, the site will remain in a "RecentlyArchived" state, where any reactivations will be free and instantaneous. If a site is reactivated after seven days, any reactivations will be charged and will take time.

Example 2

Set-SPOSiteArchiveState https://contoso.sharepoint.com/sites/Marketing -ArchiveState Active

This example triggers the reactivation of a site. If the site is reactivated from the "RecentlyArchived" state, it will become available instantaneously. If the site is reactivated from the "FullyArchived" state, it may take time for it to be reactivated.

Parameters

-ArchiveState

Sets the archived state of the site. Valid values are Archived, Active.

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

Share via