Skip to content

Commit 7a21015

Browse files
authored
Merge pull request #10950 from bkalyan976/main
Updated Documentation format for teams cmdlets
2 parents e0109d7 + a45b85b commit 7a21015

File tree

3 files changed

+31
-33
lines changed

3 files changed

+31
-33
lines changed

teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,8 @@ Identity : Global
3434
TeamsMeetingTemplates : {default, customtemplate_1cb7073a-8b19-4b5d-a3a6-14737d006969,
3535
customtemplate_21ecf22c-eb1a-4f05-93e0-555b994ebeb5,
3636
customtemplate_0b9c1f57-01ec-4b8a-b4c2-08bd1c01e6ba...}
37-
Description :
38-
```
39-
40-
The `TeamsMeetingTemplates` property contains the meeting template details:
37+
Description : The `TeamsMeetingTemplates` property contains the meeting template details:
4138
42-
```output
4339
TeamsMeetingOptions : {SelectedSensitivityLabel, AutoAdmittedUsers, AllowPstnUsersToBypassLobby,
4440
EntryExitAnnouncementsEnabled...}
4541
Description : Custom Template 1
@@ -79,4 +75,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
7975
8076
8177
## RELATED LINKS
82-
[Get-CsTeamsFirstPartyMeetingTemplateConfiguration](Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md)
78+
[Get-CsTeamsFirstPartyMeetingTemplateConfiguration](Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md)

teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,21 +27,22 @@ Creates a new instance of the policy with a name and a list of hidden meeting te
2727

2828
Assuming there are two valid templates with IDs `firstparty_e514e598-fba6-4e1f-b8b3-138dd3bca748` and `customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056`, we will first create the `HiddenMeetingTemplate` objects.
2929

30-
```powershell
31-
PS> $hiddentemplate_1 = New-CsTeamsHiddenMeetingTemplate -Id customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056
32-
PS> $hiddentemplate_2 = New-CsTeamsHiddenMeetingTemplate -Id firstparty_e514e598-fba6-4e1f-b8b3-138dd3bca748
33-
```
34-
3530
The next step would be to create the policy instance.
36-
3731
```powershell
38-
PS> New-CsTeamsMeetingTemplatePermissionPolicy -Identity Test_Policy -HiddenMeetingTemplates @($hiddentemplate_1, $hiddentemplate_2) -Description "This is a test policy"
32+
$hiddentemplate_1 = New-CsTeamsHiddenMeetingTemplate -Id customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056
33+
$hiddentemplate_2 = New-CsTeamsHiddenMeetingTemplate -Id firstparty_e514e598-fba6-4e1f-b8b3-138dd3bca748
3934
35+
New-CsTeamsMeetingTemplatePermissionPolicy -Identity Test_Policy -HiddenMeetingTemplates @($hiddentemplate_1, $hiddentemplate_2) -Description "This is a test policy"
36+
```
37+
38+
```output
4039
Identity : Tag:Test_Policy
4140
HiddenMeetingTemplates : {customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056, firstparty_e514e598-fba6-4e1f-b8b3-138dd3bca748}
4241
Description : This is a test policy
4342
```
4443

44+
45+
4546
## PARAMETERS
4647

4748
### -Identity
@@ -105,4 +106,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
105106
106107
[Remove-CsTeamsMeetingTemplatePermissionPolicy](Remove-CsTeamsMeetingTemplatePermissionPolicy.md)
107108
108-
[Grant-CsTeamsMeetingTemplatePermissionPolicy](Grant-CsTeamsMeetingTemplatePermissionPolicy.md)
109+
[Grant-CsTeamsMeetingTemplatePermissionPolicy](Grant-CsTeamsMeetingTemplatePermissionPolicy.md)

teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,29 @@ Deletes an instance of TeamsMeetingTemplatePermissionPolicy. The `Identity` para
2626
### Example 1
2727

2828
```powershell
29-
PS> Remove-CsTeamsMeetingTemplatePermissionPolicy -Identity Test_Policy
29+
Remove-CsTeamsMeetingTemplatePermissionPolicy -Identity Test_Policy
3030
```
3131

3232
Deletes a policy instance with the Identity *Test_Policy*.
3333

34+
### Example 2
35+
36+
Attempting to delete a policy instance that is currently assigned to users will result in an error. Remove the assignment before attempting to delete it.
37+
38+
```powershell
39+
Remove-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar
40+
```
41+
42+
```output
43+
Remove-CsTeamsMeetingTemplatePermissionPolicy : The policy "Foobar" is currently assigned to one or more users. Assign a different policy to the users before removing
44+
this one. Please refer to documentation. CorrelationId: 8698472b-f441-423b-8ee3-0469c7e07528
45+
At line:1 char:1
46+
+ Remove-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar
47+
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
48+
+ CategoryInfo : NotSpecified: (:) [Remove-CsTeamsM...ermissionPolicy], PolicyRpException
49+
+ FullyQualifiedErrorId : ClientError,Microsoft.Teams.Policy.Administration.Cmdlets.Core.RemoveTeamsMeetingTemplatePermissionPolicyCmdlet
50+
```
51+
3452
## PARAMETERS
3553

3654
### -Identity
@@ -52,23 +70,6 @@ Accept wildcard characters: False
5270
### CommonParameters
5371
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).
5472
55-
## NOTES
56-
57-
Attempting to delete a policy instance that is currently assigned to users will result in an error. Remove the assignment before attempting to delete it.
58-
59-
```powershell
60-
PS> Remove-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar
61-
```
62-
63-
```output
64-
Remove-CsTeamsMeetingTemplatePermissionPolicy : The policy "Foobar" is currently assigned to one or more users. Assign a different policy to the users before removing
65-
this one. Please refer to documentation. CorrelationId: 8698472b-f441-423b-8ee3-0469c7e07528
66-
At line:1 char:1
67-
+ Remove-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar
68-
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
69-
+ CategoryInfo : NotSpecified: (:) [Remove-CsTeamsM...ermissionPolicy], PolicyRpException
70-
+ FullyQualifiedErrorId : ClientError,Microsoft.Teams.Policy.Administration.Cmdlets.Core.RemoveTeamsMeetingTemplatePermissionPolicyCmdlet
71-
```
7273
7374
## RELATED LINKS
7475
[Set-CsTeamsMeetingTemplatePermissionPolicy](Set-CsTeamsMeetingTemplatePermissionPolicy.md)
@@ -77,4 +78,4 @@ At line:1 char:1
7778
7879
[New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.md)
7980
80-
[Grant-CsTeamsMeetingTemplatePermissionPolicy](Grant-CsTeamsMeetingTemplatePermissionPolicy.md)
81+
[Grant-CsTeamsMeetingTemplatePermissionPolicy](Grant-CsTeamsMeetingTemplatePermissionPolicy.md)

0 commit comments

Comments
 (0)