Skip to content

Commit fe206b3

Browse files
michbrown-pngmichbrown-png
authored
Adding parameters that are live on TPM, but missing docs
1 parent c55fec3 commit fe206b3

5 files changed

+844
-0
lines changed

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

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
---
2+
external help file: MicrosoftTeams-help.xml
3+
Module Name: MicrosoftTeams
4+
online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineaudioconferencingroutingpolicy
5+
schema: 2.0.0
6+
---
7+
8+
# Get-CsOnlineAudioConferencingRoutingPolicy
9+
10+
## SYNOPSIS
11+
12+
This cmdlet retrieves all online audio conferencing routing policies for the tenant.
13+
14+
## SYNTAX
15+
16+
### Identity (Default)
17+
18+
```powershell
19+
Get-CsOnlineAudioConferencingRoutingPolicy [[-Identity] <String>] [-MsftInternalProcessingMode <String>]
20+
[<CommonParameters>]
21+
```
22+
23+
### Filter
24+
25+
```powershell
26+
Get-CsOnlineAudioConferencingRoutingPolicy [-MsftInternalProcessingMode <String>] [-Filter <String>]
27+
[<CommonParameters>]
28+
```
29+
30+
## DESCRIPTION
31+
32+
Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting.
33+
34+
To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy."
35+
36+
The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing.
37+
38+
Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers.
39+
40+
## EXAMPLES
41+
42+
### Example 1
43+
44+
```powershell
45+
PS C:\> Get-CsOnlineAudioConferencingRoutingPolicy
46+
```
47+
48+
Retrieves all Online Audio Conferencing Routing Policy instances
49+
50+
## PARAMETERS
51+
52+
### -Filter
53+
54+
Enables you to use wildcard characters when indicating the policy (or policies) to be returned. To return a collection of all the per-user policies, use this syntax: -Filter "tag:*".
55+
56+
```yaml
57+
Type: String
58+
Parameter Sets: Filter
59+
Aliases:
60+
61+
Required: False
62+
Position: Named
63+
Default value: None
64+
Accept pipeline input: False
65+
Accept wildcard characters: False
66+
```
67+
68+
### -Identity
69+
70+
The identity of the Online Audio Conferencing Routing Policy.
71+
72+
```yaml
73+
Type: String
74+
Parameter Sets: Identity
75+
Aliases:
76+
77+
Required: False
78+
Position: 1
79+
Default value: None
80+
Accept pipeline input: False
81+
Accept wildcard characters: False
82+
```
83+
84+
### -MsftInternalProcessingMode
85+
86+
For internal use only.
87+
88+
```yaml
89+
Type: String
90+
Parameter Sets: (All)
91+
Aliases:
92+
93+
Required: False
94+
Position: Named
95+
Default value: None
96+
Accept pipeline input: False
97+
Accept wildcard characters: False
98+
```
99+
100+
### CommonParameters
101+
102+
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).
103+
104+
## INPUTS
105+
106+
### None
107+
108+
## OUTPUTS
109+
110+
### System.Object
111+
112+
## NOTES
113+
114+
## RELATED LINKS
115+
116+
[New-CsOnlineAudioConferencingRoutingPolicy](New-CsOnlineAudioConferencingRoutingPolicy.md)
117+
[Remove-CsOnlineAudioConferencingRoutingPolicy](Remove-CsOnlineAudioConferencingRoutingPolicy.md)
118+
[Grant-CsOnlineAudioConferencingRoutingPolicy](Grant-CsOnlineAudioConferencingRoutingPolicy.md)
119+
[Set-CsOnlineAudioConferencingRoutingPolicy](Set-CsOnlineAudioConferencingRoutingPolicy.md)

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

Lines changed: 246 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,246 @@
1+
---
2+
external help file: MicrosoftTeams-help.xml
3+
Module Name: MicrosoftTeams
4+
online version: https://learn.microsoft.com/powershell/module/teams/grant-csonlineaudioconferencingroutingpolicy
5+
schema: 2.0.0
6+
---
7+
8+
# Grant-CsOnlineAudioConferencingRoutingPolicy
9+
10+
## SYNOPSIS
11+
12+
This cmdlet applies an instance of the Online Audio Conferencing Routing policy to users or groups in a tenant.
13+
14+
## SYNTAX
15+
16+
### Identity (Default)
17+
18+
```powershell
19+
Grant-CsOnlineAudioConferencingRoutingPolicy [[-Identity] <String>] [-PassThru] [[-PolicyName] <String>]
20+
[-MsftInternalProcessingMode <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
21+
```
22+
23+
### GrantToTenant
24+
25+
```powershell
26+
Grant-CsOnlineAudioConferencingRoutingPolicy [-PassThru] [[-PolicyName] <String>]
27+
[-MsftInternalProcessingMode <String>] [-Global] [-WhatIf] [-Confirm] [<CommonParameters>]
28+
```
29+
30+
### GrantToGroup
31+
32+
```powershell
33+
Grant-CsOnlineAudioConferencingRoutingPolicy [-PassThru] [[-PolicyName] <String>]
34+
[-MsftInternalProcessingMode <String>] [-Group] <String> [-Rank <Int32>] [-WhatIf] [-Confirm]
35+
[<CommonParameters>]
36+
```
37+
38+
## DESCRIPTION
39+
40+
Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting.
41+
42+
To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy."
43+
44+
The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing.
45+
46+
Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers.
47+
48+
## EXAMPLES
49+
50+
### Example 1
51+
52+
```powershell
53+
PS C:\> Grant-CsOnlineAudioConferencingRoutingPolicy -PolicyName Test -Identity [email protected]
54+
```
55+
56+
Applies the policy "test" to the user "<[email protected]>".
57+
58+
### Example 2
59+
60+
```powershell
61+
PS C:\> Grant-CsOnlineAudioConferencingRoutingPolicy -PolicyName Test -Identity Global
62+
```
63+
64+
Applies the policy "test" to the entire tenant.
65+
66+
### Example 3
67+
68+
```powershell
69+
PS C:\> Grant-CsOnlineAudioConferencingRoutingPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test
70+
```
71+
72+
Applies the policy "test" to the specified group.
73+
74+
## PARAMETERS
75+
76+
### -Confirm
77+
78+
Prompts you for confirmation before running the cmdlet.
79+
80+
```yaml
81+
Type: SwitchParameter
82+
Parameter Sets: (All)
83+
Aliases: cf
84+
85+
Required: False
86+
Position: Named
87+
Default value: None
88+
Accept pipeline input: False
89+
Accept wildcard characters: False
90+
```
91+
92+
### -Global
93+
94+
This can be used to apply the policy to the entire tenant.
95+
96+
```yaml
97+
Type: SwitchParameter
98+
Parameter Sets: GrantToTenant
99+
Aliases:
100+
101+
Required: False
102+
Position: Named
103+
Default value: None
104+
Accept pipeline input: False
105+
Accept wildcard characters: False
106+
```
107+
108+
### -Group
109+
110+
This is the identifier of the group that the policy should be assigned to.
111+
112+
```yaml
113+
Type: String
114+
Parameter Sets: GrantToGroup
115+
Aliases:
116+
117+
Required: True
118+
Position: 0
119+
Default value: None
120+
Accept pipeline input: False
121+
Accept wildcard characters: False
122+
```
123+
124+
### -Identity
125+
126+
Specifies the identity of the target user.
127+
128+
Example: <[email protected]>
129+
130+
Example: 98403f08-577c-46dd-851a-f0460a13b03d
131+
132+
Use the "Global" Identity if you wish to set the policy for the entire tenant.
133+
134+
```yaml
135+
Type: String
136+
Parameter Sets: Identity
137+
Aliases:
138+
139+
Required: False
140+
Position: 0
141+
Default value: None
142+
Accept pipeline input: True (ByPropertyName, ByValue)
143+
Accept wildcard characters: False
144+
```
145+
146+
### -MsftInternalProcessingMode
147+
148+
For internal use only.
149+
150+
```yaml
151+
Type: String
152+
Parameter Sets: (All)
153+
Aliases:
154+
155+
Required: False
156+
Position: Named
157+
Default value: None
158+
Accept pipeline input: False
159+
Accept wildcard characters: False
160+
```
161+
162+
### -PassThru
163+
164+
Enables you to pass a user object through the pipeline that represents the user being assigned the policy.
165+
166+
```yaml
167+
Type: SwitchParameter
168+
Parameter Sets: (All)
169+
Aliases:
170+
171+
Required: False
172+
Position: Named
173+
Default value: None
174+
Accept pipeline input: False
175+
Accept wildcard characters: False
176+
```
177+
178+
### -PolicyName
179+
180+
Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), for example, a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled".
181+
182+
```yaml
183+
Type: String
184+
Parameter Sets: (All)
185+
Aliases:
186+
187+
Required: False
188+
Position: 1
189+
Default value: None
190+
Accept pipeline input: False
191+
Accept wildcard characters: False
192+
```
193+
194+
### -Rank
195+
196+
The rank of the policy assignment, relative to other group policy assignments for the same policy type.
197+
198+
```yaml
199+
Type: Int32
200+
Parameter Sets: GrantToGroup
201+
Aliases:
202+
203+
Required: False
204+
Position: Named
205+
Default value: None
206+
Accept pipeline input: False
207+
Accept wildcard characters: False
208+
```
209+
210+
### -WhatIf
211+
212+
Shows what would happen if the cmdlet runs.
213+
The cmdlet is not run.
214+
215+
```yaml
216+
Type: SwitchParameter
217+
Parameter Sets: (All)
218+
Aliases: wi
219+
220+
Required: False
221+
Position: Named
222+
Default value: None
223+
Accept pipeline input: False
224+
Accept wildcard characters: False
225+
```
226+
227+
### CommonParameters
228+
229+
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).
230+
231+
## INPUTS
232+
233+
### System.String
234+
235+
## OUTPUTS
236+
237+
### System.Object
238+
239+
## NOTES
240+
241+
## RELATED LINKS
242+
243+
[New-CsOnlineAudioConferencingRoutingPolicy](New-CsOnlineAudioConferencingRoutingPolicy.md)
244+
[Remove-CsOnlineAudioConferencingRoutingPolicy](Remove-CsOnlineAudioConferencingRoutingPolicy.md)
245+
[Set-CsOnlineAudioConferencingRoutingPolicy](Set-CsOnlineAudioConferencingRoutingPolicy.md)
246+
[Get-CsOnlineAudioConferencingRoutingPolicy](Get-CsOnlineAudioConferencingRoutingPolicy.md)

0 commit comments

Comments
 (0)