Skip to content

Commit 5c686f7

Browse files
kenwithkenwith
authored
Merge pull request MicrosoftDocs#4741 from icchan8/master
Add documentation for two new teams cmdlets
2 parents cdfc01d + 435e936 commit 5c686f7

File tree

2 files changed

+191
-0
lines changed

2 files changed

+191
-0
lines changed

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

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
---
2+
external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml
3+
Module Name: MicrosoftTeams
4+
title: Grant-CsGroupPolicyPackageAssignment
5+
author: icchan
6+
ms.author: icchan
7+
manager: amitar
8+
online version: https://docs.microsoft.com/powershell/module/teams/grant-csgrouppolicypackageassignment
9+
schema: 2.0.0
10+
---
11+
12+
# Grant-CsGroupPolicyPackageAssignment
13+
14+
## SYNOPSIS
15+
16+
This cmdlet applies a policy package to a group in a tenant.
17+
18+
## SYNTAX
19+
20+
```
21+
Grant-CsUserPolicyPackage -Identity <String> -PackageName <String> [-Priority <String>] [<CommonParameters>]
22+
```
23+
24+
## DESCRIPTION
25+
26+
This cmdlet applies a policy package to a group in a tenant. Provide a group identity to assign the package with all the associated policies. The available policy packages and their definitions can be found by running Get-CsPolicyPackage. Priority can be optionally specified to determine which policies in a package will be applied to the user in case they belong to two or more groups. If priority is not specified, the group's package assignment will be ranked last in priority. If a user was directly assigned a package, direct assignment takes precedence over group assignment. For more information on priority and group policy assignments, please review [this section](New-CsGroupPolicyAssignment.md#description). For more information on policy packages, please review https://docs.microsoft.com/en-us/MicrosoftTeams/manage-policy-packages
27+
28+
## EXAMPLES
29+
30+
### Example 1
31+
```powershell
32+
PS C:\> Grant-CsGroupPolicyPackageAssignment -Identity 1bc0b35f-095a-4a37-a24c-c4b6049816ab -PackageName Education_PrimaryStudent
33+
```
34+
35+
Applies the Education_PrimaryStudent policy package to the group in the tenant.
36+
37+
### Example 2
38+
```powershell
39+
PS C:\> Grant-CsGroupPolicyPackageAssignment -Identity 1bc0b35f-095a-4a37-a24c-c4b6049816ab -PackageName Education_Teacher -Priority 2
40+
```
41+
42+
Applies the Education_Teacher policy package to the group in the tenant with a priority of 2, which means each policy in the package will be assigned to the group with a priority of 2.
43+
44+
## PARAMETERS
45+
46+
### -Identity
47+
48+
A group id in the tenant. It can either be a group's object id or a group's email address.
49+
50+
```yaml
51+
Type: String
52+
Parameter Sets: (All)
53+
Aliases:
54+
Applicable: Microsoft Teams
55+
Required: True
56+
Position: 0
57+
Default value: None
58+
Accept pipeline input: False
59+
Accept wildcard characters: False
60+
```
61+
62+
### -PackageName
63+
64+
The name of a specific policy package to apply. All possible policy package names can be found by running Get-CsPolicyPackage.
65+
66+
```yaml
67+
Type: String
68+
Parameter Sets: (All)
69+
Aliases:
70+
Applicable: Microsoft Teams
71+
Required: True
72+
Position: 1
73+
Default value: None
74+
Accept pipeline input: False
75+
Accept wildcard characters: False
76+
```
77+
78+
### -Priority
79+
80+
The priority of the package assignment, relative to other group package assignments that contain one or more of the same policy types.
81+
82+
```yaml
83+
Type: String
84+
Parameter Sets: (All)
85+
Aliases:
86+
Applicable: Microsoft Teams
87+
Required: False
88+
Position: 2
89+
Default value: None
90+
Accept pipeline input: False
91+
Accept wildcard characters: False
92+
```
93+
94+
### CommonParameters
95+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
96+
97+
## INPUTS
98+
99+
## OUTPUTS
100+
101+
## NOTES
102+
103+
## RELATED LINKS
104+
105+
[Get-CsPolicyPackage](Get-CsPolicyPackage.md)
106+
107+
[New-CsGroupPolicyAssignment](New-CsGroupPolicyAssignment.md)

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

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
---
2+
external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml
3+
Module Name: MicrosoftTeams
4+
title: New-CsBatchPolicyPackageAssignmentOperation
5+
author: ruguan
6+
ms.author: ruguan
7+
manager: amitar
8+
online version: https://docs.microsoft.com/powershell/module/teams/new-csbatchpolicypackageassignmentoperation
9+
schema: 2.0.0
10+
---
11+
12+
# New-CsBatchPolicyPackageAssignmentOperation
13+
14+
## SYNOPSIS
15+
16+
This cmdlet submits an operation that applies a policy package to a batch of users in a tenant.
17+
18+
## SYNTAX
19+
20+
```
21+
New-CsBatchPolicyPackageAssignmentOperation -Identity <String[]> -PackageName <String> [<CommonParameters>]
22+
```
23+
24+
## DESCRIPTION
25+
26+
This cmdlet submits an operation that applies a policy package to a batch of users in a tenant. Provide one or more user identities to assign the package with all the associated policies. The available policy packages and their definitions can be found by running Get-CsPolicyPackage. The recommended policy package for each user can be found by running Get-CsUserPolicyPackageRecommendation. For more information on policy packages, please review https://docs.microsoft.com/en-us/MicrosoftTeams/manage-policy-packages
27+
28+
## EXAMPLES
29+
30+
### Example 1
31+
```powershell
32+
PS C:\> New-CsBatchPolicyPackageAssignmentOperation -Identity 1bc0b35f-095a-4a37-a24c-c4b6049816ab,[email protected],[email protected] -PackageName Education_PrimaryStudent
33+
```
34+
35+
Applies the Education_PrimaryStudent policy package to three users in the tenant.
36+
37+
## PARAMETERS
38+
39+
### -Identity
40+
41+
A list of one or more users in the tenant. A user identity can either be a user's object id or email address.
42+
43+
```yaml
44+
Type: String[]
45+
Parameter Sets: (All)
46+
Aliases:
47+
Applicable: Microsoft Teams
48+
Required: True
49+
Position: 0
50+
Default value: None
51+
Accept pipeline input: False
52+
Accept wildcard characters: False
53+
```
54+
55+
### -PackageName
56+
57+
The name of a specific policy package to apply. All policy package names can be found by running Get-CsPolicyPackage.
58+
59+
```yaml
60+
Type: String
61+
Parameter Sets: (All)
62+
Aliases:
63+
Applicable: Microsoft Teams
64+
Required: True
65+
Position: 1
66+
Default value: None
67+
Accept pipeline input: False
68+
Accept wildcard characters: False
69+
```
70+
71+
### CommonParameters
72+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
73+
74+
## INPUTS
75+
76+
## OUTPUTS
77+
78+
## NOTES
79+
80+
## RELATED LINKS
81+
82+
[Get-CsPolicyPackage](Get-CsPolicyPackage.md)
83+
84+
[Get-CsUserPolicyPackageRecommendation](Get-CsUserPolicyPackageRecommendation.md)

0 commit comments

Comments
 (0)