Skip to content

Commit 3b47a61

Browse files
sunguchuansunguchuan
authored
Merge pull request #1 from sunguchuan/sunguchuan-customPackage
Docs for custom package features in cmdlet
2 parents 29773e7 + c409b0e commit 3b47a61

File tree

3 files changed

+229
-0
lines changed

3 files changed

+229
-0
lines changed

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

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml
3+
Module Name: MicrosoftTeams
4+
title: New-CsCustomPolicyPackage
5+
author: gucsun
6+
ms.author: gucsun
7+
manager: amitar
8+
online version: https://docs.microsoft.com/powershell/module/teams/new-CsCustomPolicyPackage
9+
schema: 2.0.0
10+
---
11+
12+
# New-CsCustomPolicyPackage
13+
14+
## SYNOPSIS
15+
This cmdlet submits an operation that creates a custom policy package with custom package name and a list of policies.
16+
17+
## SYNTAX
18+
19+
```
20+
New-CsBatchPolicyPackageAssignmentOperation -PackageName -PolicyList []
21+
```
22+
23+
## DESCRIPTION
24+
25+
This cmdlet submits an operation that creates a custom policy package. It allows the user to create their own policy package. For more information on policy packages and the policy types available, please review https://docs.microsoft.com/MicrosoftTeams/manage-policy-packages.
26+
27+
## EXAMPLES
28+
29+
### Example 1
30+
```powershell
31+
PS C:\> New-CsCustomPolicyPackage -PackageName myCustomPackage -PolicyList "TeamsMeeting, Education_Teacher" , "TeamsMessaging, Firstline_Manager"
32+
```
33+
34+
Creates a custom package with name "myCustomPackage" with two policies included: TeamsMeeting policy named "Education_Teacher" and TeamsMessaging policy named "Firstline_Manager".
35+
36+
## PARAMETERS
37+
38+
### -PackageName
39+
40+
The name of the custom package. It cannot be empty or only contain spaces.
41+
42+
```yaml
43+
Type: String
44+
Parameter Sets: (All)
45+
Aliases:
46+
Applicable: Microsoft Teams
47+
Required: True
48+
Position: 0
49+
Default value: None
50+
Accept pipeline input: False
51+
Accept wildcard characters: False
52+
```
53+
54+
### -PolicyList
55+
56+
A list of one or more policies included in the package. For each policy in the list, the form is ", ". delimiters of ' ', '.', ':', '\t' are also acceptable.
57+
58+
```yaml
59+
Type: String[]
60+
Parameter Sets: (All)
61+
Aliases:
62+
Applicable: Microsoft Teams
63+
Required: True
64+
Position: 1
65+
Default value: None
66+
Accept pipeline input: False
67+
Accept wildcard characters: False
68+
```
69+
70+
### CommonParameters
71+
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).
72+
73+
## INPUTS
74+
75+
## OUTPUTS
76+
77+
## NOTES
78+
79+
## RELATED LINKS
80+
81+
[Get-CsPolicyPackage](Get-CsPolicyPackage.md)

‎teams/teams-ps/teams/Remove-CsCustomPolicyPackage.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml
3+
Module Name: MicrosoftTeams
4+
title: Remove-CsCustomPolicyPackage
5+
author: gucsun
6+
ms.author: gucsun
7+
manager: amitar
8+
online version: https://docs.microsoft.com/powershell/module/teams/remove-CsCustomPolicyPackage
9+
schema: 2.0.0
10+
---
11+
12+
# Remove-CsCustomPolicyPackage
13+
14+
## SYNOPSIS
15+
This cmdlet submits an operation that deletes a custom policy package with the given package name.
16+
17+
## SYNTAX
18+
19+
```
20+
Remove-CsBatchPolicyPackageAssignmentOperation -PackageName
21+
```
22+
23+
## DESCRIPTION
24+
25+
This cmdlet submits an operation that deletes a custom policy package. It allows the admin user to delete a custom package. The available package names can be found by running Get-CsPolicyPackage.
26+
27+
## EXAMPLES
28+
29+
### Example 1
30+
```powershell
31+
PS C:\> Remove-CsCustomPolicyPackage -PackageName myCustomPackage
32+
```
33+
34+
Deletes a custom package with name "myCustomPackage". If the custom package with the name "myCustomPackage" exists and the admin user is authorized to delete it. The command will return success result.
35+
36+
## PARAMETERS
37+
38+
### -PackageName
39+
40+
The name of the custom package. It cannot be empty or only contain spaces.
41+
42+
```yaml
43+
Type: String
44+
Parameter Sets: (All)
45+
Aliases:
46+
Applicable: Microsoft Teams
47+
Required: True
48+
Position: 0
49+
Default value: None
50+
Accept pipeline input: False
51+
Accept wildcard characters: False
52+
```
53+
54+
### CommonParameters
55+
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).
56+
57+
## INPUTS
58+
59+
## OUTPUTS
60+
61+
## NOTES
62+
The user is not allowed to delete a pre-defined package created by Microsoft.
63+
64+
## RELATED LINKS
65+
66+
[Get-CsPolicyPackage](Get-CsPolicyPackage.md)

‎teams/teams-ps/teams/Update-CsCustomPolicyPackage.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml
3+
Module Name: MicrosoftTeams
4+
title: Update-CsCustomPolicyPackage
5+
author: gucsun
6+
ms.author: gucsun
7+
manager: amitar
8+
online version: https://docs.microsoft.com/powershell/module/teams/update-CsCustomPolicyPackage
9+
schema: 2.0.0
10+
---
11+
12+
# Update-CsCustomPolicyPackage
13+
14+
## SYNOPSIS
15+
This cmdlet submits an operation that updates a custom policy package with a given list of policies.
16+
17+
## SYNTAX
18+
19+
```
20+
Update-CsBatchPolicyPackageAssignmentOperation -PackageName -PolicyList []
21+
```
22+
23+
## DESCRIPTION
24+
25+
This cmdlet submits an operation that updates the policies into a custom policy package. It allows the user to change the policies included in the package. The available policy types can be found here https://docs.microsoft.com/MicrosoftTeams/manage-policy-packages.
26+
27+
## EXAMPLES
28+
29+
### Example 1
30+
```powershell
31+
PS C:\> Update-CsCustomPolicyPackage -PackageName myCustomPackage -PolicyList "TeamsMeeting, Education_Teacher" , "TeamsMessaging, Firstline_Manager"
32+
```
33+
34+
Updates the custom package named "myCustomPackage" by changing the policies to a new list: TeamsMeeting policy named "Education_Teacher" and TeamsMessaging policy named "Firstline_Manager".
35+
36+
## PARAMETERS
37+
38+
### -PackageName
39+
40+
The name of the custom package that the user wants to update. It cannot be empty or only contain spaces.
41+
42+
```yaml
43+
Type: String
44+
Parameter Sets: (All)
45+
Aliases:
46+
Applicable: Microsoft Teams
47+
Required: True
48+
Position: 0
49+
Default value: None
50+
Accept pipeline input: False
51+
Accept wildcard characters: False
52+
```
53+
54+
### -PolicyList
55+
56+
A list of one or more policies included in the new policy list. For each policy in the list, the form is ", ". delimiters of ' ', '.', ':', '\t' are also acceptable.
57+
58+
```yaml
59+
Type: String[]
60+
Parameter Sets: (All)
61+
Aliases:
62+
Applicable: Microsoft Teams
63+
Required: True
64+
Position: 1
65+
Default value: None
66+
Accept pipeline input: False
67+
Accept wildcard characters: False
68+
```
69+
70+
### CommonParameters
71+
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).
72+
73+
## INPUTS
74+
75+
## OUTPUTS
76+
77+
## NOTES
78+
The user is not allowed to update the pre-defined packages created by Microsoft.
79+
80+
## RELATED LINKS
81+
82+
[Get-CsPolicyPackage](Get-CsPolicyPackage.md)

0 commit comments

Comments
 (0)