Skip to content

Commit 2c98b8f

Browse files
vargasj-msvargasj-ms
committed
Add docs for TeamsUpdateManagementPolicy
1 parent 03a1792 commit 2c98b8f

5 files changed

+626
-0
lines changed

‎teams/teams-ps/teams/Get-CsTeamsUpdateManagementPolicy.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml
3+
Module Name: MicrosoftTeams
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Get-CsTeamsUpdateManagementPolicy
9+
10+
## SYNOPSIS
11+
Use this cmdlet to retrieve the current Teams Update Management policies in the organization.
12+
13+
## SYNTAX
14+
15+
### Identity (Default)
16+
```
17+
Get-CsTeamsUpdateManagementPolicy [[-Identity] <String>] [-ProgressAction <ActionPreference>]
18+
[<CommonParameters>]
19+
```
20+
21+
### Filter
22+
```
23+
Get-CsTeamsUpdateManagementPolicy [-Filter <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
24+
```
25+
26+
## DESCRIPTION
27+
Retrieves the current Teams Update Management policies in the organization.
28+
29+
## EXAMPLES
30+
31+
### Example 1
32+
```powershell
33+
PS C:\> Get-CsTeamsUpdateManagementPolicy
34+
```
35+
36+
In this example, we retrieve all the existing Teams Update Management policies in the organization.
37+
38+
## PARAMETERS
39+
40+
### -Identity
41+
The unique identifier of the policy.
42+
43+
```yaml
44+
Type: String
45+
Parameter Sets: Identity
46+
Aliases:
47+
48+
Required: False
49+
Position: 1
50+
Default value: None
51+
Accept pipeline input: False
52+
Accept wildcard characters: False
53+
```
54+
55+
### CommonParameters
56+
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).
57+
58+
## INPUTS
59+
60+
### None
61+
62+
## OUTPUTS
63+
64+
### TeamsUpdateManagementPolicy.Cmdlets.TeamsUpdateManagementPolicy
65+
66+
## NOTES
67+
68+
## RELATED LINKS

‎teams/teams-ps/teams/Grant-CsTeamsUpdateManagementPolicy.md

Lines changed: 182 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,182 @@
1+
---
2+
external help file: MicrosoftTeams-help.xml
3+
Module Name: MicrosoftTeams
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Grant-CsTeamsUpdateManagementPolicy
9+
10+
## SYNOPSIS
11+
Use this cmdlet to grant a specific Teams Update Management policy to a user.
12+
13+
## SYNTAX
14+
15+
### Identity (Default)
16+
```
17+
Grant-CsTeamsUpdateManagementPolicy [[-Identity] <String>] [-PassThru] [[-PolicyName] <String>]
18+
[-MsftInternalProcessingMode <String>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
19+
[<CommonParameters>]
20+
```
21+
22+
### GrantToTenant
23+
```
24+
Grant-CsTeamsUpdateManagementPolicy [-PassThru] [[-PolicyName] <String>] [-MsftInternalProcessingMode <String>]
25+
[-Global] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
26+
```
27+
28+
### GrantToGroup
29+
```
30+
Grant-CsTeamsUpdateManagementPolicy [-PassThru] [[-PolicyName] <String>] [-MsftInternalProcessingMode <String>]
31+
[-Group] <String> [-Rank <Int32>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
32+
[<CommonParameters>]
33+
```
34+
35+
## DESCRIPTION
36+
Grants a specific Teams Update Management policy to a user or to sets a specific Teams Update Management policy as the new effective global policy.
37+
38+
## EXAMPLES
39+
40+
### Example 1
41+
```powershell
42+
PS C:\> Grant-CsTeamsUpdateManagementPolicy -PolicyName "Campaign Policy" -Identity [email protected]
43+
```
44+
45+
In this example, the policy "Campaign Policy" is granted to the user [email protected].
46+
47+
## PARAMETERS
48+
49+
### -Confirm
50+
Prompts you for confirmation before running the cmdlet.
51+
52+
```yaml
53+
Type: SwitchParameter
54+
Parameter Sets: (All)
55+
Aliases: cf
56+
57+
Required: False
58+
Position: Named
59+
Default value: None
60+
Accept pipeline input: False
61+
Accept wildcard characters: False
62+
```
63+
64+
### -Global
65+
Use this parameter to make the specified policy in -PolicyName the new effective global policy.
66+
67+
```yaml
68+
Type: SwitchParameter
69+
Parameter Sets: GrantToTenant
70+
Aliases:
71+
72+
Required: False
73+
Position: Named
74+
Default value: None
75+
Accept pipeline input: False
76+
Accept wildcard characters: False
77+
```
78+
79+
### -Group
80+
Specifies the group used for the group policy assignment.
81+
82+
```yaml
83+
Type: String
84+
Parameter Sets: GrantToGroup
85+
Aliases:
86+
87+
Required: True
88+
Position: 0
89+
Default value: None
90+
Accept pipeline input: False
91+
Accept wildcard characters: False
92+
```
93+
94+
### -Identity
95+
Indicates the identity of the user account the policy should be assigned to.
96+
97+
```yaml
98+
Type: String
99+
Parameter Sets: Identity
100+
Aliases:
101+
102+
Required: False
103+
Position: 0
104+
Default value: None
105+
Accept pipeline input: True (ByPropertyName, ByValue)
106+
Accept wildcard characters: False
107+
```
108+
109+
### -PassThru
110+
Including this parameter (which does not take a value) displays the user information when the cmdlet completes. Normally there is no output when this cmdlet is run.
111+
112+
```yaml
113+
Type: SwitchParameter
114+
Parameter Sets: (All)
115+
Aliases:
116+
117+
Required: False
118+
Position: Named
119+
Default value: None
120+
Accept pipeline input: False
121+
Accept wildcard characters: False
122+
```
123+
124+
### -PolicyName
125+
The identity of the policy to be granted.
126+
127+
```yaml
128+
Type: String
129+
Parameter Sets: (All)
130+
Aliases:
131+
132+
Required: False
133+
Position: 1
134+
Default value: None
135+
Accept pipeline input: False
136+
Accept wildcard characters: False
137+
```
138+
139+
### -Rank
140+
The rank of the policy assignment, relative to other group policy assignments for the same policy type.
141+
142+
```yaml
143+
Type: Int32
144+
Parameter Sets: GrantToGroup
145+
Aliases:
146+
147+
Required: False
148+
Position: Named
149+
Default value: None
150+
Accept pipeline input: False
151+
Accept wildcard characters: False
152+
```
153+
154+
### -WhatIf
155+
Shows what would happen if the cmdlet runs.
156+
The cmdlet is not run.
157+
158+
```yaml
159+
Type: SwitchParameter
160+
Parameter Sets: (All)
161+
Aliases: wi
162+
163+
Required: False
164+
Position: Named
165+
Default value: None
166+
Accept pipeline input: False
167+
Accept wildcard characters: False
168+
```
169+
170+
### CommonParameters
171+
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).
172+
173+
## INPUTS
174+
175+
### System.String
176+
177+
## OUTPUTS
178+
179+
### System.Object
180+
## NOTES
181+
182+
## RELATED LINKS

‎teams/teams-ps/teams/New-CsTeamsUpdateManagementPolicy.md

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
---
2+
external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml
3+
Module Name: MicrosoftTeams
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# New-CsTeamsUpdateManagementPolicy
9+
10+
## SYNOPSIS
11+
12+
Use this cmdlet to create Teams Update Management policy.
13+
14+
## SYNTAX
15+
16+
```
17+
New-CsTeamsUpdateManagementPolicy
18+
[-DisabledInProductMessages <System.Management.Automation.PSListModifier`1[System.String]>]
19+
[-Description <String>] [-AllowManagedUpdates <Boolean>] [-AllowPreview <Boolean>] [-UpdateDayOfWeek <Int64>]
20+
[-UpdateTime <String>] [-UpdateTimeOfDay <DateTime>] [-AllowPublicPreview <String>]
21+
[-UseNewTeamsClient <String>] [-BlockLegacyAuthorization <Boolean>] [-Identity] <String> [-Force]
22+
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
23+
```
24+
25+
## DESCRIPTION
26+
27+
Create a Teams Update Management policy.
28+
29+
This cmdlet can be used to create a new policity to manage the visibility of some Teams in-product messages. Executing the cmdlet will suppress the corresponding category of messages from appearing for the specified user group.
30+
31+
## EXAMPLES
32+
33+
### Example 1
34+
```powershell
35+
PS C:\> New-CsTeamsUpdateManagementPolicy -Identity "Campaign Policy" -DisabledInProductMessages @("91382d07-8b89-444c-bbcb-cfe43133af33")
36+
```
37+
38+
Disable the in-product messages with the category "What’s New".
39+
40+
## PARAMETERS
41+
42+
### -Confirm
43+
Prompts you for confirmation before running the cmdlet.
44+
45+
```yaml
46+
Type: SwitchParameter
47+
Parameter Sets: (All)
48+
Aliases: cf
49+
50+
Required: False
51+
Position: Named
52+
Default value: None
53+
Accept pipeline input: False
54+
Accept wildcard characters: False
55+
```
56+
57+
### -DisabledInProductMessages
58+
List of IDs of the categories of the in-product messages that will be disabled. You can choose one of the categories from this table:
59+
60+
| ID | Campaign Category |
61+
| -- | -- |
62+
| 91382d07-8b89-444c-bbcb-cfe43133af33 | What’s New |
63+
| edf2633e-9827-44de-b34c-8b8b9717e84c | Conferences |
64+
65+
```yaml
66+
Type: System.Management.Automation.PSListModifier`1[System.String]
67+
Parameter Sets: (All)
68+
Aliases:
69+
70+
Required: False
71+
Position: Named
72+
Default value: None
73+
Accept pipeline input: False
74+
Accept wildcard characters: False
75+
```
76+
77+
### -Force
78+
Suppress all non-fatal errors.
79+
80+
```yaml
81+
Type: SwitchParameter
82+
Parameter Sets: (All)
83+
Aliases:
84+
85+
Required: False
86+
Position: Named
87+
Default value: None
88+
Accept pipeline input: False
89+
Accept wildcard characters: False
90+
```
91+
92+
### -Identity
93+
A unique identifier.
94+
95+
```yaml
96+
Type: String
97+
Parameter Sets: (All)
98+
Aliases:
99+
100+
Required: True
101+
Position: 1
102+
Default value: None
103+
Accept pipeline input: False
104+
Accept wildcard characters: False
105+
```
106+
107+
### -WhatIf
108+
Shows what would happen if the cmdlet runs.
109+
The cmdlet is not run.
110+
111+
```yaml
112+
Type: SwitchParameter
113+
Parameter Sets: (All)
114+
Aliases: wi
115+
116+
Required: False
117+
Position: Named
118+
Default value: None
119+
Accept pipeline input: False
120+
Accept wildcard characters: False
121+
```
122+
123+
### CommonParameters
124+
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).
125+
126+
## INPUTS
127+
128+
### None
129+
130+
## OUTPUTS
131+
132+
### TeamsUpdateManagementPolicy.Cmdlets.TeamsUpdateManagementPolicy
133+
134+
## NOTES
135+
136+
## RELATED LINKS

0 commit comments

Comments
 (0)