Skip to content

Commit bea1a78

Browse files
CarolynRoweCarolynRowe
authored
Merge pull request #11899 from vargasj-ms/users/vargasj/admincontrols
Add docs for TeamsUpdateManagementPolicy
2 parents 166d3e8 + 3869922 commit bea1a78

6 files changed

+656
-0
lines changed

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

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

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

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

0 commit comments

Comments
 (0)