Commands › Microsoft Teams

Set-TeamArchivedState

Microsoft Teams MicrosoftTeams Set-*

This cmdlet is used to freeze all of the team activity, but Teams Administrators and team owners will still be able to add or remove members and update roles. You can unarchive the team anytime.

Quick start script

# Set-TeamArchivedState — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-MicrosoftTeams -CertificateThumbprint $thumb -ApplicationId $appId -TenantId $tenantId

# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-TeamArchivedState
$before | Format-List

# 3. Make the change
Set-TeamArchivedState -Archived <Boolean> -GroupId <String>

# 4. Verify and diff
$after = Get-TeamArchivedState
Compare-Object ($before | Out-String) ($after | Out-String)

Syntax

Set-TeamArchivedState -GroupId <String> -Archived <Boolean> [-SetSpoSiteReadOnlyForMembers <Boolean>]
 [<CommonParameters>]

Parameters (3)

Parameter	Type	Required	What it controls
-Archived	Boolean	yes	Boolean value that determines whether or not the Team is archived.
-GroupId	String	yes	GroupId of the team
-SetSpoSiteReadOnlyForMembers	Boolean		Use this parameter switch to make the SharePoint site read-only for team members.

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.