Skip to content

Commit 8aa5dbf

Browse files
michbrown-pngmichbrown-png
authored
Adding missing documentation for the TeamsWorkload Policy
1 parent 9ae2d9b commit 8aa5dbf

File tree

5 files changed

+949
-0
lines changed

5 files changed

+949
-0
lines changed

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

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
---
2+
external help file: MicrosoftTeams-help.xml
3+
Module Name: MicrosoftTeams
4+
online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy
5+
schema: 2.0.0
6+
---
7+
8+
# Get-CsTeamsWorkLoadPolicy
9+
10+
## SYNOPSIS
11+
12+
This cmdlet applies an instance of the Teams Workload policy to users or groups in a tenant.
13+
14+
## SYNTAX
15+
16+
### Identity (Default)
17+
18+
```powershell
19+
Get-CsTeamsWorkLoadPolicy [[-Identity] <String>] [-MsftInternalProcessingMode <String>] [<CommonParameters>]
20+
```
21+
22+
### Filter
23+
24+
```powershell
25+
Get-CsTeamsWorkLoadPolicy [-MsftInternalProcessingMode <String>] [-Filter <String>] [<CommonParameters>]
26+
```
27+
28+
## DESCRIPTION
29+
30+
The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user.
31+
32+
## EXAMPLES
33+
34+
### Example 1
35+
36+
```powershell
37+
PS C:\> Get-CsTeamsWorkLoadPolicy
38+
```
39+
40+
Retrieves the Teams Workload Policy instances and shows assigned values.
41+
42+
## PARAMETERS
43+
44+
### -Filter
45+
46+
Enables you to use wildcard characters when indicating the policy (or policies) to be returned.
47+
48+
```yaml
49+
Type: String
50+
Parameter Sets: Filter
51+
Aliases:
52+
53+
Required: False
54+
Position: Named
55+
Default value: None
56+
Accept pipeline input: False
57+
Accept wildcard characters: False
58+
```
59+
60+
### -Identity
61+
62+
Identity of the Teams Workload Policy.
63+
64+
```yaml
65+
Type: String
66+
Parameter Sets: Identity
67+
Aliases:
68+
69+
Required: False
70+
Position: 1
71+
Default value: None
72+
Accept pipeline input: False
73+
Accept wildcard characters: False
74+
```
75+
76+
### -MsftInternalProcessingMode
77+
78+
For Microsoft internal use only.
79+
80+
```yaml
81+
Type: String
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+
### CommonParameters
93+
94+
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).
95+
96+
## INPUTS
97+
98+
### None
99+
100+
## OUTPUTS
101+
102+
### System.Object
103+
104+
## NOTES
105+
106+
## RELATED LINKS
107+
108+
[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy)
109+
[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy)
110+
[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy)
111+
[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy)

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

Lines changed: 247 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,247 @@
1+
---
2+
external help file: MicrosoftTeams-help.xml
3+
Module Name: MicrosoftTeams
4+
online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy
5+
schema: 2.0.0
6+
---
7+
8+
# Grant-CsTeamsWorkLoadPolicy
9+
10+
## SYNOPSIS
11+
12+
This cmdlet applies an instance of the Teams Workload policy to users or groups in a tenant.
13+
14+
## SYNTAX
15+
16+
### Identity (Default)
17+
18+
```powershell
19+
Grant-CsTeamsWorkLoadPolicy [[-Identity] <String>] [-PassThru] [[-PolicyName] <String>]
20+
[-MsftInternalProcessingMode <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
21+
```
22+
23+
### GrantToTenant
24+
25+
```powershell
26+
Grant-CsTeamsWorkLoadPolicy [-PassThru] [[-PolicyName] <String>] [-MsftInternalProcessingMode <String>]
27+
[-Global] [-WhatIf] [-Confirm] [<CommonParameters>]
28+
```
29+
30+
### GrantToGroup
31+
32+
```powershell
33+
Grant-CsTeamsWorkLoadPolicy [-PassThru] [[-PolicyName] <String>] [-MsftInternalProcessingMode <String>]
34+
[-Group] <String> [-Rank <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>]
35+
```
36+
37+
## DESCRIPTION
38+
39+
The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user.
40+
41+
## EXAMPLES
42+
43+
### Example 1
44+
45+
```powershell
46+
PS C:\> Grant-CsTeamsWorkLoadPolicy -PolicyName Test -Identity [email protected]
47+
```
48+
49+
Assigns a given policy to a user.
50+
51+
### Example 2
52+
53+
```powershell
54+
PS C:\> Grant-CsTeamsWorkLoadPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test
55+
```
56+
57+
Assigns a given policy to a group.
58+
59+
### Example 3
60+
61+
```powershell
62+
PS C:\> Grant-CsTeamsWorkLoadPolicy -Global -PolicyName Test
63+
```
64+
65+
Assigns a given policy to the tenant.
66+
67+
### Example 4
68+
69+
```powershell
70+
PS C:\> Grant-CsTeamsWorkLoadPolicy -Global -PolicyName Test
71+
```
72+
73+
Note: _Using $null in place of a policy name can be used to unassigned a policy instance._
74+
75+
## PARAMETERS
76+
77+
### -Confirm
78+
79+
Prompts you for confirmation before running the cmdlet.
80+
81+
```yaml
82+
Type: SwitchParameter
83+
Parameter Sets: (All)
84+
Aliases: cf
85+
86+
Required: False
87+
Position: Named
88+
Default value: None
89+
Accept pipeline input: False
90+
Accept wildcard characters: False
91+
```
92+
93+
### -Global
94+
95+
This is the equivalent to `-Identity Global`.
96+
97+
```yaml
98+
Type: SwitchParameter
99+
Parameter Sets: GrantToTenant
100+
Aliases:
101+
102+
Required: False
103+
Position: Named
104+
Default value: None
105+
Accept pipeline input: False
106+
Accept wildcard characters: False
107+
```
108+
109+
### -Group
110+
111+
This is the identifier of the group that the policy should be assigned to.
112+
113+
```yaml
114+
Type: String
115+
Parameter Sets: GrantToGroup
116+
Aliases:
117+
118+
Required: True
119+
Position: 0
120+
Default value: None
121+
Accept pipeline input: False
122+
Accept wildcard characters: False
123+
```
124+
125+
### -Identity
126+
127+
Specifies the identity of the target user.
128+
129+
Example: <[email protected]>
130+
131+
Example: 98403f08-577c-46dd-851a-f0460a13b03d
132+
133+
Use the "Global" Identity if you wish to set the policy for the entire tenant.
134+
135+
```yaml
136+
Type: String
137+
Parameter Sets: Identity
138+
Aliases:
139+
140+
Required: False
141+
Position: 0
142+
Default value: None
143+
Accept pipeline input: True (ByPropertyName, ByValue)
144+
Accept wildcard characters: False
145+
```
146+
147+
### -MsftInternalProcessingMode
148+
149+
For Microsoft internal use only.
150+
151+
```yaml
152+
Type: String
153+
Parameter Sets: (All)
154+
Aliases:
155+
156+
Required: False
157+
Position: Named
158+
Default value: None
159+
Accept pipeline input: False
160+
Accept wildcard characters: False
161+
```
162+
163+
### -PassThru
164+
165+
Enables you to pass a user object through the pipeline that represents the user being assigned the policy.
166+
167+
```yaml
168+
Type: SwitchParameter
169+
Parameter Sets: (All)
170+
Aliases:
171+
172+
Required: False
173+
Position: Named
174+
Default value: None
175+
Accept pipeline input: False
176+
Accept wildcard characters: False
177+
```
178+
179+
### -PolicyName
180+
181+
Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), for example, a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled".
182+
183+
```yaml
184+
Type: String
185+
Parameter Sets: (All)
186+
Aliases:
187+
188+
Required: False
189+
Position: 1
190+
Default value: None
191+
Accept pipeline input: False
192+
Accept wildcard characters: False
193+
```
194+
195+
### -Rank
196+
197+
The rank of the policy assignment, relative to other group policy assignments for the same policy type.
198+
199+
```yaml
200+
Type: Int32
201+
Parameter Sets: GrantToGroup
202+
Aliases:
203+
204+
Required: False
205+
Position: Named
206+
Default value: None
207+
Accept pipeline input: False
208+
Accept wildcard characters: False
209+
```
210+
211+
### -WhatIf
212+
213+
Shows what would happen if the cmdlet runs.
214+
The cmdlet is not run.
215+
216+
```yaml
217+
Type: SwitchParameter
218+
Parameter Sets: (All)
219+
Aliases: wi
220+
221+
Required: False
222+
Position: Named
223+
Default value: None
224+
Accept pipeline input: False
225+
Accept wildcard characters: False
226+
```
227+
228+
### CommonParameters
229+
230+
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).
231+
232+
## INPUTS
233+
234+
### System.String
235+
236+
## OUTPUTS
237+
238+
### System.Object
239+
240+
## NOTES
241+
242+
## RELATED LINKS
243+
244+
[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy)
245+
[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy)
246+
[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy)
247+
[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy)

0 commit comments

Comments
 (0)