Set-SPOSiteArchiveState.md

external help file	Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
Module Name	Microsoft.Online.SharePoint.PowerShell
online version	https://learn.microsoft.com/powershell/module/microsoft.online.sharepoint.powershell/set-spositearchivestate
applicable	SharePoint Online
title	Set-SPOSiteArchiveState
schema	2.0.0
author	AdiGanMSFT
ms.author	adigan
ms.reviewer

Set-SPOSiteArchiveState

SYNOPSIS

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

SYNTAX

Set-SPOSiteArchiveState [-Identity] <SpoSitePipeBind> [-ArchiveState] <SPOArchiveState> [-NoWait] [-Force]
 [-WhatIf] [-Confirm] [<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

Applicable: SharePoint Online

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

Type: Microsoft.Online.SharePoint.PowerShell.SPOArchiveState
Parameter Sets: (All)
Aliases:
Accepted values: Archived, Active

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Force

Applicable: SharePoint Online

Whether to set the site archived state without prompting for confirmation.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Identity

Applicable: SharePoint Online

Identity of the site to archive or reactivate.

Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-NoWait

Applicable: SharePoint Online

Whether to not wait for the operation to complete.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind

OUTPUTS

System.Object

NOTES

RELATED LINKS