Edit

Share via


Set-TeamArchivedState

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

Default (Default)

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.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-GroupId

GroupId of the team

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-SetSpoSiteReadOnlyForMembers

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

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

Inputs

System.String

Outputs

System.Object