Set-TeamArchivedState

Module:

MicrosoftTeamsPowerShell

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.

Syntax

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

Description

This cmdlet is used to freeze all of the team activity and also specify whether SharePoint site should be marked as Read-Only. Teams administrators and team owners will still be able to add or remove members and update roles. You can unarchive the team anytime.

Examples

Example 1

PS C:\> Set-TeamArchivedState -GroupId 105b16e2-dc55-4f37-a922-97551e9e862d -Archived:$true

This example sets the group with id 105b16e2-dc55-4f37-a922-97551e9e862d as archived

Example 2

PS C:\> Set-TeamArchivedState -GroupId 105b16e2-dc55-4f37-a922-97551e9e862d -Archived:$true -SetSpoSiteReadOnlyForMembers:$true

This example sets the group with id 105b16e2-dc55-4f37-a922-97551e9e862d as archived and makes the SharePoint site read-only for team members.

Example 3

PS C:\> Set-TeamArchivedState -GroupId 105b16e2-dc55-4f37-a922-97551e9e862d -Archived:$false

This example unarchives the group with id 105b16e2-dc55-4f37-a922-97551e9e862d.

Parameters

-Archived

Boolean value that determines whether or not the Team is archived.

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

-GroupId

GroupId of the team

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

-SetSpoSiteReadOnlyForMembers

Use this parameter switch to make the SharePoint site read-only for team members.

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

Inputs

System.String

Outputs

System.Object