Skip to content

Commit 460b820

Browse files
michbrown-pngmichbrown-png
authored
Creating documentation for existing TeamsRoomVideTeleConferencingPolicy cmdlets
1 parent f9a45bf commit 460b820

5 files changed

+855
-0
lines changed

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

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
---
2+
external help file: MicrosoftTeams-help.xml
3+
Module Name: MicrosoftTeams
4+
online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsroomvideoteleconferencingpolicy
5+
schema: 2.0.0
6+
---
7+
8+
# Get-CsTeamsRoomVideoTeleConferencingPolicy
9+
10+
## SYNOPSIS
11+
12+
Use this cmdlet to retrieve the current Teams Room Video TeleConferencing policies.
13+
14+
## SYNTAX
15+
16+
### Identity (Default)
17+
18+
```powershell
19+
Get-CsTeamsRoomVideoTeleConferencingPolicy [[-Identity] <String>] [-MsftInternalProcessingMode <String>]
20+
[<CommonParameters>]
21+
```
22+
23+
### Filter
24+
25+
```powershell
26+
Get-CsTeamsRoomVideoTeleConferencingPolicy [-MsftInternalProcessingMode <String>] [-Filter <String>]
27+
[<CommonParameters>]
28+
```
29+
30+
## DESCRIPTION
31+
32+
The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices).
33+
34+
## PARAMETERS
35+
36+
### -Filter
37+
38+
Enables you to use wildcard characters when indicating the policy (or policies) to be returned.
39+
40+
```yaml
41+
Type: String
42+
Parameter Sets: Filter
43+
Aliases:
44+
45+
Required: False
46+
Position: Named
47+
Default value: None
48+
Accept pipeline input: False
49+
Accept wildcard characters: False
50+
```
51+
52+
### -Identity
53+
54+
The name the tenant admin gave to the Policy.
55+
56+
```yaml
57+
Type: String
58+
Parameter Sets: Identity
59+
Aliases:
60+
61+
Required: False
62+
Position: 1
63+
Default value: None
64+
Accept pipeline input: False
65+
Accept wildcard characters: False
66+
```
67+
68+
### -MsftInternalProcessingMode
69+
70+
For internal use only.
71+
72+
```yaml
73+
Type: String
74+
Parameter Sets: (All)
75+
Aliases:
76+
77+
Required: False
78+
Position: Named
79+
Default value: None
80+
Accept pipeline input: False
81+
Accept wildcard characters: False
82+
```
83+
84+
### CommonParameters
85+
86+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
87+
88+
## INPUTS
89+
90+
### None
91+
92+
## OUTPUTS
93+
94+
### System.Object
95+
96+
## NOTES
97+
98+
## RELATED LINKS

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

Lines changed: 203 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,203 @@
1+
---
2+
external help file: MicrosoftTeams-help.xml
3+
Module Name: MicrosoftTeams
4+
online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsroomvideoteleconferencingpolicy
5+
schema: 2.0.0
6+
---
7+
8+
# Grant-CsTeamsRoomVideoTeleConferencingPolicy
9+
10+
## SYNOPSIS
11+
12+
Assigns a TeamsRoomVideoTeleConferencingPolicy to a Teams Room Alias on a per-room or per-Group basis.
13+
14+
## SYNTAX
15+
16+
### Identity (Default)
17+
18+
```powershell
19+
Grant-CsTeamsRoomVideoTeleConferencingPolicy [[-Identity] <String>] [-PassThru] [[-PolicyName] <String>]
20+
[-MsftInternalProcessingMode <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
21+
```
22+
23+
### GrantToTenant
24+
25+
```powershell
26+
Grant-CsTeamsRoomVideoTeleConferencingPolicy [-PassThru] [[-PolicyName] <String>]
27+
[-MsftInternalProcessingMode <String>] [-Global] [-WhatIf] [-Confirm] [<CommonParameters>]
28+
```
29+
30+
### GrantToGroup
31+
32+
```powershell
33+
Grant-CsTeamsRoomVideoTeleConferencingPolicy [-PassThru] [[-PolicyName] <String>]
34+
[-MsftInternalProcessingMode <String>] [-Group] <String> [-Rank <Int32>] [-WhatIf] [-Confirm]
35+
[<CommonParameters>]
36+
```
37+
38+
## DESCRIPTION
39+
40+
The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices).
41+
42+
## PARAMETERS
43+
44+
### -Confirm
45+
46+
Prompts you for confirmation before running the cmdlet.
47+
48+
```yaml
49+
Type: SwitchParameter
50+
Parameter Sets: (All)
51+
Aliases: cf
52+
53+
Required: False
54+
Position: Named
55+
Default value: None
56+
Accept pipeline input: False
57+
Accept wildcard characters: False
58+
```
59+
60+
### -Global
61+
62+
When you use this cmdlet without specifying a identity, the policy applies to all rooms in your tenant, except any that have an explicit policy assignment.
63+
64+
```yaml
65+
Type: SwitchParameter
66+
Parameter Sets: GrantToTenant
67+
Aliases:
68+
69+
Required: False
70+
Position: Named
71+
Default value: None
72+
Accept pipeline input: False
73+
Accept wildcard characters: False
74+
```
75+
76+
### -Group
77+
78+
Specifies the group used for the group policy assignment.
79+
80+
```yaml
81+
Type: String
82+
Parameter Sets: GrantToGroup
83+
Aliases:
84+
85+
Required: True
86+
Position: 0
87+
Default value: None
88+
Accept pipeline input: False
89+
Accept wildcard characters: False
90+
```
91+
92+
### -Identity
93+
94+
The alias of the Teams room that the IT admin is granting this PolicyName to.
95+
96+
```yaml
97+
Type: String
98+
Parameter Sets: Identity
99+
Aliases:
100+
101+
Required: False
102+
Position: 0
103+
Default value: None
104+
Accept pipeline input: True (ByPropertyName, ByValue)
105+
Accept wildcard characters: False
106+
```
107+
108+
### -MsftInternalProcessingMode
109+
110+
For internal use only.
111+
112+
```yaml
113+
Type: String
114+
Parameter Sets: (All)
115+
Aliases:
116+
117+
Required: False
118+
Position: Named
119+
Default value: None
120+
Accept pipeline input: False
121+
Accept wildcard characters: False
122+
```
123+
124+
### -PassThru
125+
126+
Allows the user to indicate whether the cmdlet passes an output object through the pipeline, in this case, after a process is stopped.
127+
128+
```yaml
129+
Type: SwitchParameter
130+
Parameter Sets: (All)
131+
Aliases:
132+
133+
Required: False
134+
Position: Named
135+
Default value: None
136+
Accept pipeline input: False
137+
Accept wildcard characters: False
138+
```
139+
140+
### -PolicyName
141+
142+
Corresponds to the name of the policy under -Identity from the cmdlet.
143+
144+
```yaml
145+
Type: String
146+
Parameter Sets: (All)
147+
Aliases:
148+
149+
Required: False
150+
Position: 1
151+
Default value: None
152+
Accept pipeline input: False
153+
Accept wildcard characters: False
154+
```
155+
156+
### -Rank
157+
158+
The rank of the policy assignment, relative to other group policy assignments for the same policy type.
159+
160+
```yaml
161+
Type: Int32
162+
Parameter Sets: GrantToGroup
163+
Aliases:
164+
165+
Required: False
166+
Position: Named
167+
Default value: None
168+
Accept pipeline input: False
169+
Accept wildcard characters: False
170+
```
171+
172+
### -WhatIf
173+
174+
Shows what would happen if the cmdlet runs.
175+
The cmdlet is not run.
176+
177+
```yaml
178+
Type: SwitchParameter
179+
Parameter Sets: (All)
180+
Aliases: wi
181+
182+
Required: False
183+
Position: Named
184+
Default value: None
185+
Accept pipeline input: False
186+
Accept wildcard characters: False
187+
```
188+
189+
### CommonParameters
190+
191+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
192+
193+
## INPUTS
194+
195+
### System.String
196+
197+
## OUTPUTS
198+
199+
### System.Object
200+
201+
## NOTES
202+
203+
## RELATED LINKS

0 commit comments

Comments
 (0)