Skip to content

Commit 52a40c8

Browse files
Add TeamsMediaConnectivityPolicy cmdlets public docs
1 parent 4f4727d commit 52a40c8

File tree

4 files changed

+269
-0
lines changed

4 files changed

+269
-0
lines changed
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
Module Name: microsoftteams
3+
applicable: Microsoft Teams
4+
title: Get-CsTeamsMediaConnectivityPolicy
5+
online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsMediaConnectivityPolicy
6+
schema: 2.0.0
7+
author: lirunping_MSFT
8+
ms.author: runli
9+
---
10+
11+
# Get-CsTeamsMediaConnectivityPolicy
12+
13+
## SYNOPSIS
14+
15+
This cmdlet retrieves all Teams media connectivity policy for current tenant.
16+
17+
## SYNTAX
18+
19+
```
20+
Get-CsTeamsMediaConnectivityPolicy
21+
```
22+
23+
## DESCRIPTION
24+
25+
This cmdlet retrieves all Teams media connectivity policy for current tenant.
26+
27+
## EXAMPLES
28+
29+
### Example 1
30+
```powershell
31+
PS C:\> Get-CsTeamsMediaConnectivityPolicy
32+
Identity DirectConnection
33+
-------- ----------------
34+
Tag:Test Enabled
35+
```
36+
37+
retrieves Teams media connectivity policy, show the result as identity tag and "DirectConnection" value.
38+
39+
## PARAMETERS
40+
41+
### CommonParameters
42+
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).
43+
44+
## INPUTS
45+
46+
## OUTPUTS
47+
48+
## RELATED LINKS
49+
50+
[New-CsTeamsMediaConnectivityPolicy](New-CsTeamsMediaConnectivityPolicy.md)
51+
52+
[Remove-CsTeamsMediaConnectivityPolicy](Remove-CsTeamsMediaConnectivityPolicy.yml)
53+
54+
[Set-CsTeamsMediaConnectivityPolicy](Set-CsTeamsMediaConnectivityPolicy.yml)
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
Module Name: microsoftteams
3+
applicable: Microsoft Teams
4+
title: New-CsTeamsMediaConnectivityPolicy
5+
online version: https://learn.microsoft.com/powershell/module/teams/New-CsTeamsMediaConnectivityPolicy
6+
schema: 2.0.0
7+
author: lirunping_MSFT
8+
ms.author: runli
9+
---
10+
11+
12+
# New-CsTeamsMediaConnectivityPolicy
13+
14+
## SYNOPSIS
15+
This cmdlet creates an Teams media connectivity policy.
16+
17+
## SYNTAX
18+
19+
```powershell
20+
New-CsTeamsMediaConnectivityPolicy -Identity <String>
21+
```
22+
23+
## DESCRIPTION
24+
This cmdlet creates an Teams media connectivity policy. If you get an error that the policy already exists, it means that the policy already exists for your tenant. In this case, run Get-CsTeamsMediaConnectivityPolicy.
25+
26+
## EXAMPLES
27+
28+
### Example 1
29+
```powershell
30+
PS C:\> New-CsTeamsMediaConnectivityPolicy -Identity Test
31+
32+
Identity DirectConnection
33+
-------------------------
34+
Tag:Test Enabled
35+
```
36+
37+
Returns the current value of "DirectConnection" policy with identity of "Test".
38+
39+
40+
## PARAMETERS
41+
42+
### -Identity
43+
Identity of the Teams media connectivity policy.
44+
45+
```yaml
46+
Type: String
47+
Parameter Sets: (All)
48+
Aliases:
49+
50+
Required: True
51+
Position: Named
52+
Default value: None
53+
Accept pipeline input: False
54+
Accept wildcard characters: False
55+
```
56+
57+
### CommonParameters
58+
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).
59+
60+
61+
## RELATED LINKS
62+
[Remove-CsTeamsMediaConnectivityPolicy](Remove-CsTeamsMediaConnectivityPolicy.yml)
63+
64+
[Get-CsTeamsMediaConnectivityPolicy](Get-CsTeamsMediaConnectivityPolicy.yml)
65+
66+
[Set-CsTeamsMediaConnectivityPolicy](Set-CsTeamsMediaConnectivityPolicy.yml)
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
Module Name: microsoftteams
3+
applicable: Microsoft Teams
4+
title: Remove-CsTeamsMediaConnectivityPolicy
5+
online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsTeamsMediaConnectivityPolicy
6+
schema: 2.0.0
7+
author: lirunping_MSFT
8+
ms.author: runli
9+
---
10+
11+
# Remove-CsTeamsMediaConnectivityPolicy
12+
13+
## SYNOPSIS
14+
15+
This cmdlet deletes a Teams media connectivity policy.
16+
17+
## SYNTAX
18+
19+
```
20+
Remove-CsTeamsMediaConnectivityPolicy -Identity <String>
21+
```
22+
23+
## DESCRIPTION
24+
25+
This cmdlet deletes a Teams media connectivity policy with the specified identity string.
26+
27+
## EXAMPLES
28+
29+
### Example 1
30+
```powershell
31+
PS C:\> Remove-CsTeamsMediaConnectivityPolicy -Identity "Test"
32+
```
33+
34+
Deletes a Teams media connectivity policy with the identify of "Test".
35+
36+
## PARAMETERS
37+
38+
### -Identity
39+
Identity of the Teams media connectivity policy.
40+
41+
```yaml
42+
Type: String
43+
Parameter Sets: (All)
44+
Aliases:
45+
46+
Required: True
47+
Position: Named
48+
Default value: None
49+
Accept pipeline input: False
50+
Accept wildcard characters: False
51+
```
52+
53+
### CommonParameters
54+
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).
55+
56+
## INPUTS
57+
58+
## OUTPUTS
59+
60+
## RELATED LINKS
61+
62+
[New-CsTeamsMediaConnectivityPolicy](New-CsTeamsMediaConnectivityPolicy.md)
63+
64+
[Get-CsTeamsMediaConnectivityPolicy](Get-CsTeamsMediaConnectivityPolicy.yml)
65+
66+
[Set-CsTeamsMediaConnectivityPolicy](Set-CsTeamsMediaConnectivityPolicy.yml)
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
Module Name: microsoftteams
3+
applicable: Microsoft Teams
4+
title: Set-CsTeamsMediaConnectivityPolicy
5+
online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsMediaConnectivityPolicy
6+
schema: 2.0.0
7+
author: lirunping_MSFT
8+
ms.author: runli
9+
---
10+
11+
# Set-CsTeamsMediaConnectivityPolicy
12+
13+
## SYNOPSIS
14+
15+
This cmdlet Set Teams media connectivity policy value for current tenant.
16+
17+
## SYNTAX
18+
19+
```
20+
Set-CsTeamsMediaConnectivityPolicy -Identity <string> -DirectConnection <Enabled/Disabled>
21+
```
22+
23+
## DESCRIPTION
24+
25+
This cmdlet Set Teams media connectivity policy DirectConnection value for current tenant. The value can be "Enabled" or "Disabled"
26+
27+
## EXAMPLES
28+
29+
### Example 1
30+
```powershell
31+
PS C:\> Set-CsTeamsMediaConnectivityPolicy -Identity Test -DirectConnection Disabled
32+
Identity DirectConnection
33+
-------- ----------------
34+
Global Enabled
35+
Tag:Test Disabled
36+
```
37+
38+
Set Teams media connectivity policy "DirectConnection" value to "Disabled" for identity "Test".
39+
40+
## PARAMETERS
41+
### -Identity
42+
Identity of the Teams media connectivity policy.
43+
44+
```yaml
45+
Type: String
46+
Parameter Sets: (All)
47+
Aliases:
48+
49+
Required: True
50+
Position: Named
51+
Default value: None
52+
Accept pipeline input: False
53+
Accept wildcard characters: False
54+
```
55+
### -DirectConnection
56+
Policy value of the Teams media connectivity DirectConnection policy.
57+
58+
```yaml
59+
Type: Boolean
60+
Parameter Sets: ("Enabled","Disabled")
61+
Aliases:
62+
63+
Required: True
64+
Position: Named
65+
Default value: Enabled
66+
Accept pipeline input: False
67+
Accept wildcard characters: False
68+
```
69+
70+
### CommonParameters
71+
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).
72+
73+
## INPUTS
74+
75+
## OUTPUTS
76+
77+
## RELATED LINKS
78+
79+
[New-CsTeamsMediaConnectivityPolicy](New-CsTeamsMediaConnectivityPolicy.md)
80+
81+
[Remove-CsTeamsMediaConnectivityPolicy](Remove-CsTeamsMediaConnectivityPolicy.yml)
82+
83+
[Get-CsTeamsMediaConnectivityPolicy](Get-CsTeamsMediaConnectivityPolicy.yml)

0 commit comments

Comments
 (0)