Skip to content

Commit 686367b

Browse files
tiburdtiburd
authored
Merge pull request #10855 from boboPD/pradas_templates
TeamsMeetingTemplatePermissionPolicy cmdlet docs
2 parents 62957d2 + e51244d commit 686367b

8 files changed

+800
-0
lines changed

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

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
Module Name: MicrosoftTeams
3+
title: Get-CsTeamsFirstPartyMeetingTemplateConfiguration
4+
author: boboPD
5+
ms.author: pradas
6+
online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration
7+
schema: 2.0.0
8+
---
9+
10+
# Get-CsTeamsFirstPartyMeetingTemplateConfiguration
11+
12+
## SYNOPSIS
13+
This cmdlet fetches the first-party meeting templates stored on the tenant.
14+
15+
## SYNTAX
16+
17+
```powershell
18+
Get-CsTeamsFirstPartyMeetingTemplateConfiguration [[-Identity] <string>] [<CommonParameters>]
19+
```
20+
21+
## DESCRIPTION
22+
Fetches the list of first-party templates on the tenant. Each template object contains its list of meeting options, the name of the template, and its ID.
23+
24+
This is a read-only configuration.
25+
26+
## EXAMPLES
27+
28+
### Example 1
29+
30+
```powershell
31+
Get-CsTeamsFirstPartyMeetingTemplateConfiguration
32+
```
33+
34+
```output
35+
Identity : Global
36+
TeamsMeetingTemplates : {default, firstparty_30d773c0-1b4e-4bf6-970b-73f544c054bb,
37+
firstparty_399f69a3-c482-41bf-9cf7-fcdefe269ce6,
38+
firstparty_64c92390-c8a2-471e-96d9-4ee8f6080155...}
39+
Description :
40+
```
41+
42+
The `TeamsMeetingTemplates` property contains the meeting template details:
43+
44+
```output
45+
TeamsMeetingOptions : {SelectedSensitivityLabel, AutoAdmittedUsers, AllowPstnUsersToBypassLobby,
46+
EntryExitAnnouncementsEnabled...}
47+
Description : Townhall
48+
Name : firstparty_21f91ef7-6265-4064-b78b-41ab66889d90
49+
Category :
50+
51+
TeamsMeetingOptions : {AutoRecordingEnabled, AllowMeetingChat, PresenterOption}
52+
Description : Virtual appointment
53+
Name : firstparty_e514e598-fba6-4e1f-b8b3-138dd3bca748
54+
Category :
55+
```
56+
57+
Fetches all the first-party templates on the tenant.
58+
59+
## PARAMETERS
60+
61+
### -Identity
62+
63+
This parameter can be used to fetch a specific instance of the configuration.
64+
65+
Note: This configuration is read only and will only have the Global instance.
66+
67+
```yaml
68+
Type: String
69+
Parameter Sets: (All)
70+
Aliases:
71+
Applicable: Microsoft Teams
72+
Required: False
73+
Position: Named
74+
Default value: None
75+
Accept pipeline input: False
76+
Accept wildcard characters: False
77+
```
78+
79+
### CommonParameters
80+
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).
81+
82+
## RELATED LINKS
83+
[Get-CsTeamsMeetingTemplateConfiguration](Get-CsTeamsMeetingTemplateConfiguration.md)

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

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
Module Name: MicrosoftTeams
3+
title: Get-CsTeamsMeetingTemplateConfiguration
4+
author: boboPD
5+
ms.author: pradas
6+
online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsMeetingTemplateConfiguration
7+
schema: 2.0.0
8+
---
9+
10+
# Get-CsTeamsMeetingTemplateConfiguration
11+
12+
## SYNOPSIS
13+
This cmdlet fetches the custom meeting templates stored on the tenant.
14+
15+
## SYNTAX
16+
17+
```powershell
18+
Get-CsTeamsMeetingTemplateConfiguration [[-Identity] <string>] [<CommonParameters>]
19+
```
20+
21+
## DESCRIPTION
22+
Fetches the list of custom templates on the tenant. Each template object contains its list of meeting options, the name of the template, and its ID.
23+
24+
## EXAMPLES
25+
26+
### Example 1
27+
28+
```powershell
29+
Get-CsTeamsMeetingTemplateConfiguration
30+
```
31+
32+
```output
33+
Identity : Global
34+
TeamsMeetingTemplates : {default, customtemplate_1cb7073a-8b19-4b5d-a3a6-14737d006969,
35+
customtemplate_21ecf22c-eb1a-4f05-93e0-555b994ebeb5,
36+
customtemplate_0b9c1f57-01ec-4b8a-b4c2-08bd1c01e6ba...}
37+
Description :
38+
```
39+
40+
The `TeamsMeetingTemplates` property contains the meeting template details:
41+
42+
```output
43+
TeamsMeetingOptions : {SelectedSensitivityLabel, AutoAdmittedUsers, AllowPstnUsersToBypassLobby,
44+
EntryExitAnnouncementsEnabled...}
45+
Description : Custom Template 1
46+
Name : customtemplate_1cb7073a-8b19-4b5d-a3a6-14737d006969
47+
Category :
48+
49+
TeamsMeetingOptions : {AutoRecordingEnabled, AllowMeetingChat, PresenterOption}
50+
Description : Custom Template 2
51+
Name : customtemplate_21ecf22c-eb1a-4f05-93e0-555b994ebeb5
52+
Category :
53+
```
54+
55+
Fetches all the custom templates on the tenant.
56+
57+
## PARAMETERS
58+
59+
### -Identity
60+
61+
This parameter can be used to fetch a specific instance of the configuration.
62+
63+
Note: This configuration is read only and will only have the Global instance.
64+
65+
```yaml
66+
Type: String
67+
Parameter Sets: (All)
68+
Aliases:
69+
Applicable: Microsoft Teams
70+
Required: False
71+
Position: Named
72+
Default value: None
73+
Accept pipeline input: False
74+
Accept wildcard characters: False
75+
```
76+
77+
### CommonParameters
78+
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).
79+
80+
81+
## RELATED LINKS
82+
[Get-CsTeamsFirstPartyMeetingTemplateConfiguration](Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md)

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

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
---
2+
Module Name: MicrosoftTeams
3+
title: Get-CsTeamsMeetingTemplatePermissionPolicy
4+
author: boboPD
5+
ms.author: pradas
6+
online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsMeetingTemplatePermissionPolicy
7+
schema: 2.0.0
8+
---
9+
10+
# Get-CsTeamsMeetingTemplatePermissionPolicy
11+
12+
## SYNOPSIS
13+
Fetches the TeamsMeetingTemplatePermissionPolicy. This policy can be used to hide meeting templates from users and groups.
14+
15+
## SYNTAX
16+
17+
### Identity
18+
```powershell
19+
Get-CsTeamsMeetingTemplatePermissionPolicy [[-Identity] <string>] [<CommonParameters>]
20+
```
21+
22+
### Filter
23+
```powershell
24+
Get-CsTeamsMeetingTemplatePermissionPolicy [-Filter <string>] [<CommonParameters>]
25+
```
26+
27+
## DESCRIPTION
28+
Fetches the instances of the policy. Each policy object contains a property called `HiddenMeetingTemplates`.This array contains the list of meeting template IDs that will be hidden by that instance of the policy.
29+
30+
## EXAMPLES
31+
32+
### Example 1
33+
34+
```powershell
35+
Get-CsTeamsMeetingTemplatePermissionPolicy
36+
```
37+
```output
38+
Identity : Global
39+
HiddenMeetingTemplates : {}
40+
Description :
41+
42+
Identity : Tag:Foobar
43+
HiddenMeetingTemplates : {customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056}
44+
Description :
45+
46+
Identity : Tag:dashbrd test
47+
HiddenMeetingTemplates : {customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056}
48+
Description : test
49+
50+
Identity : Tag:Default
51+
HiddenMeetingTemplates : {}
52+
Description :
53+
```
54+
55+
Fetches all the policy instances currently available.
56+
57+
### Example 2
58+
59+
```powershell
60+
PS> Get-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar
61+
```
62+
```output
63+
Identity : Tag:Foobar
64+
HiddenMeetingTemplates : {customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056}
65+
Description :
66+
```
67+
68+
Fetches an instance of a policy with known identity.
69+
70+
### Example 3
71+
72+
```powershell
73+
PS> Get-CsTeamsMeetingTemplatePermissionPolicy -Filter *Foo*
74+
```
75+
```output
76+
Identity : Tag:Foobar
77+
HiddenMeetingTemplates : {customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056}
78+
Description :
79+
```
80+
81+
The `Filter` parameter can be used to fetch policy instances based on partial matches on Identity.
82+
83+
Note: _The "Tag:" prefix can be ignored when specifying the identity._
84+
85+
## PARAMETERS
86+
87+
### -Identity
88+
89+
This parameter can be used to fetch a specific instance of the policy.
90+
91+
```yaml
92+
Type: String
93+
Parameter Sets: (All)
94+
Aliases:
95+
Applicable: Microsoft Teams
96+
Required: False
97+
Position: Named
98+
Default value: None
99+
Accept pipeline input: False
100+
Accept wildcard characters: False
101+
```
102+
103+
### -Filter
104+
105+
This parameter can be used to fetch policy instances based on partial matches on the `Identity` field.
106+
107+
```yaml
108+
Type: String
109+
Parameter Sets: (All)
110+
Aliases:
111+
Applicable: Microsoft Teams
112+
Required: False
113+
Position: Named
114+
Default value: None
115+
Accept pipeline input: False
116+
Accept wildcard characters: True
117+
```
118+
119+
### CommonParameters
120+
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).
121+
122+
## RELATED LINKS
123+
[Set-CsTeamsMeetingTemplatePermissionPolicy](Set-CsTeamsMeetingTemplatePermissionPolicy.md)
124+
125+
[New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.md)
126+
127+
[Remove-CsTeamsMeetingTemplatePermissionPolicy](Remove-CsTeamsMeetingTemplatePermissionPolicy.md)
128+
129+
[Grant-CsTeamsMeetingTemplatePermissionPolicy](Grant-CsTeamsMeetingTemplatePermissionPolicy.md)

0 commit comments

Comments
 (0)