Skip to content

Commit 0ee0e06

Browse files
KateyanneKateyanne
authored
Merge pull request MicrosoftDocs#6451 from sunguchuan/master
Add docs for creating, updating and removing custom packages
2 parents 048babb + 03697b3 commit 0ee0e06

File tree

3 files changed

+276
-0
lines changed

3 files changed

+276
-0
lines changed

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

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
---
2+
external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml
3+
Module Name: MicrosoftTeams
4+
title: New-CsCustomPolicyPackage
5+
author: sunguchuan
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, description and a list of policies.
16+
17+
## SYNTAX
18+
19+
```
20+
New-CsCustomPolicyPackage -Identity <String> -PolicyList <String[]> [-Description <String>] [<CommonParameters>]
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 -Identity myCustomPackage -PolicyList "TeamsMeetingPolicy, Education_Teacher" , "TeamsMessagingPolicy, Firstline_Manager" -Description "My first custom package"
32+
```
33+
34+
Creates a custom package named "myCustomPackage" with description "My first custom package" and two policies included: TeamsMeeting policy named "Education_Teacher" and TeamsMessaging policy named "Firstline_Manager".
35+
36+
### Example 2
37+
```powershell
38+
PS C:\> New-CsCustomPolicyPackage -Identity myCustomPackage -PolicyList "TeamsMeetingPolicy, Education_Teacher" , "TeamsMessagingPolicy, Firstline_Manager"
39+
```
40+
41+
Creates a custom package named "myCustomPackage" with two policies included: TeamsMeeting policy named "Education_Teacher" and TeamsMessaging policy named "Firstline_Manager".
42+
43+
## PARAMETERS
44+
45+
### -Identity
46+
47+
The name of the custom package.
48+
49+
```yaml
50+
Type: String
51+
Parameter Sets: (All)
52+
Aliases:
53+
Applicable: Microsoft Teams
54+
Required: True
55+
Position: 0
56+
Default value: None
57+
Accept pipeline input: False
58+
Accept wildcard characters: False
59+
```
60+
61+
### -PolicyList
62+
63+
A list of one or more policies included in the package. For each policy in the list, the form is "\<PolicyType\>, \<PolicyName\>". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed in this [link](https://docs.microsoft.com/en-us/MicrosoftTeams/manage-policy-packages#supported-policy-types). To get the full list of available policy names, please refer to cmdlets such as [Get-CsTeamsMeetingPolicy](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/Get-CsTeamsMeetingPolicy.md) and [Get-CsTeamsMessagingPolicy](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/Get-CsTeamsMessagingPolicy.md)
64+
65+
```yaml
66+
Type: String[]
67+
Parameter Sets: (All)
68+
Aliases:
69+
Applicable: Microsoft Teams
70+
Required: True
71+
Position: 1
72+
Default value: None
73+
Accept pipeline input: False
74+
Accept wildcard characters: False
75+
```
76+
77+
### -Description
78+
79+
The description of the custom package.
80+
81+
```yaml
82+
Type: String
83+
Parameter Sets: (All)
84+
Aliases:
85+
Applicable: Microsoft Teams
86+
Required: False
87+
Position: 2
88+
Default value: None
89+
Accept pipeline input: False
90+
Accept wildcard characters: False
91+
```
92+
93+
### CommonParameters
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](https://go.microsoft.com/fwlink/?LinkID=113216).
95+
96+
## INPUTS
97+
98+
## OUTPUTS
99+
100+
## NOTES
101+
102+
## RELATED LINKS
103+
104+
[Get-CsPolicyPackage](Get-CsPolicyPackage.md)
105+
106+
[Get-CsTeamsMeetingPolicy](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/Get-CsTeamsMeetingPolicy.md)
107+
108+
[Get-CsTeamsMessagingPolicy](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/Get-CsTeamsMessagingPolicy.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: sunguchuan
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-CsCustomPolicyPackage -Identity <String>
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 -Identity myCustomPackage
32+
```
33+
34+
Deletes a custom package named "myCustomPackage".
35+
36+
## PARAMETERS
37+
38+
### -Identity
39+
40+
The name of the custom package.
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 default package created by Microsoft.
63+
64+
## RELATED LINKS
65+
66+
[Get-CsPolicyPackage](Get-CsPolicyPackage.md)

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

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
---
2+
external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml
3+
Module Name: MicrosoftTeams
4+
title: Update-CsCustomPolicyPackage
5+
author: sunguchuan
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 new package settings.
16+
17+
## SYNTAX
18+
19+
```
20+
Update-CsCustomPolicyPackage -Identity <String> -PolicyList <String[]> [-Description <String>] [<CommonParameters>]
21+
```
22+
23+
## DESCRIPTION
24+
25+
This cmdlet submits an operation that updates a custom policy package with new package settings. For more information on available policy packages, please review https://docs.microsoft.com/MicrosoftTeams/manage-policy-packages.
26+
27+
## EXAMPLES
28+
29+
### Example 1
30+
```powershell
31+
PS C:\> Update-CsCustomPolicyPackage -Identity myCustomPackage -PolicyList "TeamsMeetingPolicy, Education_Teacher" , "TeamsMessagingPolicy, Firstline_Manager"
32+
```
33+
34+
Updates the custom package named "myCustomPackage" with a new list of policies: TeamsMeeting policy named "Education_Teacher" and TeamsMessaging policy named "Firstline_Manager".
35+
36+
## PARAMETERS
37+
38+
### -Identity
39+
40+
The name of the custom package that the user wants to update.
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 "\<PolicyType\>, \<PolicyName\>". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed in this [link](https://docs.microsoft.com/en-us/MicrosoftTeams/manage-policy-packages#supported-policy-types). To get the full list of available policy names, please refer to cmdlets such as [Get-CsTeamsMeetingPolicy](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/Get-CsTeamsMeetingPolicy.md) and [Get-CsTeamsMessagingPolicy](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/Get-CsTeamsMessagingPolicy.md)
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+
### -Description
71+
72+
The description of the custom package.
73+
74+
```yaml
75+
Type: String
76+
Parameter Sets: (All)
77+
Aliases:
78+
Applicable: Microsoft Teams
79+
Required: False
80+
Position: 2
81+
Default value: None
82+
Accept pipeline input: False
83+
Accept wildcard characters: False
84+
```
85+
86+
### CommonParameters
87+
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).
88+
89+
## INPUTS
90+
91+
## OUTPUTS
92+
93+
## NOTES
94+
As a result, the policy list of the custom package will be REPLACED by the new one instead of a union. The user is not allowed to update the default packages created by Microsoft.
95+
96+
## RELATED LINKS
97+
98+
[Get-CsPolicyPackage](Get-CsPolicyPackage.md)
99+
100+
[Get-CsTeamsMeetingPolicy](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/Get-CsTeamsMeetingPolicy.md)
101+
102+
[Get-CsTeamsMessagingPolicy](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/Get-CsTeamsMessagingPolicy.md)

0 commit comments

Comments
 (0)