Skip to content

Commit effa5ec

Browse files
authored
Merge branch 'master' into chrisda
2 parents 0f8e0e6 + 9f0f32a commit effa5ec

File tree

2 files changed

+112
-0
lines changed

2 files changed

+112
-0
lines changed
Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml
3+
Module Name: microsoftteams
4+
online version: https://docs.microsoft.com/powershell/module/teams/set-teamarchivedstate
5+
schema: 2.0.0
6+
author: kenwith
7+
ms.author: kenwith
8+
ms.reviewer:
9+
---
10+
11+
# Set-TeamArchivedState
12+
13+
## SYNOPSIS
14+
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.
15+
16+
## SYNTAX
17+
18+
```
19+
Set-TeamArchivedState -GroupId <String> -Archived <Boolean> [-SetSpoSiteReadOnlyForMembers <Boolean>]
20+
[<CommonParameters>]
21+
```
22+
23+
## DESCRIPTION
24+
This cmdlet is used to freeze all of the team activity and also specify whether SharePoint site should be marked as Read-Only.
25+
Teams administrators and team owners will still be able to add or remove members and update roles. You can unarchive the team anytime.
26+
27+
## EXAMPLES
28+
29+
### Example 1
30+
```powershell
31+
PS C:\> Set-TeamArchivedState -GroupId 105b16e2-dc55-4f37-a922-97551e9e862d -Archived:$true
32+
```
33+
34+
This example sets the group with id 105b16e2-dc55-4f37-a922-97551e9e862d as archived
35+
36+
### Example 2
37+
```powershell
38+
PS C:\> Set-TeamArchivedState -GroupId 105b16e2-dc55-4f37-a922-97551e9e862d -Archived:$true -SetSpoSiteReadOnlyForMembers:$true
39+
```
40+
41+
This example sets the group with id 105b16e2-dc55-4f37-a922-97551e9e862d as archived and makes the SharePoint site read-only for team members.
42+
43+
### Example 3
44+
```powershell
45+
PS C:\> Set-TeamArchivedState -GroupId 105b16e2-dc55-4f37-a922-97551e9e862d -Archived:$false
46+
```
47+
48+
This example unarchives the group with id 105b16e2-dc55-4f37-a922-97551e9e862d.
49+
50+
## PARAMETERS
51+
52+
### -Archived
53+
Boolean value that determines whether or not the Team is archived.
54+
55+
```yaml
56+
Type: Boolean
57+
Parameter Sets: (All)
58+
Aliases:
59+
60+
Required: True
61+
Position: Named
62+
Default value: None
63+
Accept pipeline input: False
64+
Accept wildcard characters: False
65+
```
66+
67+
### -GroupId
68+
GroupId of the team
69+
70+
```yaml
71+
Type: String
72+
Parameter Sets: (All)
73+
Aliases:
74+
75+
Required: True
76+
Position: Named
77+
Default value: None
78+
Accept pipeline input: True (ByPropertyName)
79+
Accept wildcard characters: False
80+
```
81+
82+
### -SetSpoSiteReadOnlyForMembers
83+
Use this parameter switch to make the SharePoint site read-only for team members.
84+
85+
```yaml
86+
Type: Boolean
87+
Parameter Sets: (All)
88+
Aliases:
89+
90+
Required: False
91+
Position: Named
92+
Default value: None
93+
Accept pipeline input: False
94+
Accept wildcard characters: False
95+
```
96+
97+
### CommonParameters
98+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
99+
100+
## INPUTS
101+
102+
### System.String
103+
104+
## OUTPUTS
105+
106+
### System.Object
107+
## NOTES
108+
109+
## RELATED LINKS

teams/teams-ps/teams/teams.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,9 @@ The following cmdlet references are for Microsoft Teams.
7979
### [Set-Team](Set-Team.md)
8080
{{Manually Enter Set-Team Description Here}}
8181

82+
### [Set-TeamArchivedState](Set-TeamArchivedState.md)
83+
{{Manually Enter Set-TeamArchivedState Description Here}}
84+
8285
### [Set-TeamChannel](Set-TeamChannel.md)
8386
{{Manually Enter Set-TeamChannel Description Here}}
8487

0 commit comments

Comments
 (0)