Skip to content

Commit 01bbe6c

Browse files
CarolynRoweCarolynRowe
authored
Merge pull request #11639 from lirunping-MSFT/main
Add TeamsMediaConnectivityPolicy cmdlets public docs
2 parents 325e11c + ea3458c commit 01bbe6c

5 files changed

+464
-0
lines changed

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

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
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 policies for current tenant.
16+
17+
## SYNTAX
18+
19+
```
20+
Get-CsTeamsMediaConnectivityPolicy
21+
```
22+
23+
## DESCRIPTION
24+
25+
This cmdlet retrieves all Teams media connectivity policies 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 policies, 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)
55+
56+
[Grant-CsTeamsMediaConnectivityPolicy](Grant-CsTeamsMediaConnectivityPolicy.yml)

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

Lines changed: 189 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,189 @@
1+
---
2+
Module Name: microsoftteams
3+
applicable: Microsoft Teams
4+
title: Grant-CsTeamsMediaConnectivityPolicy
5+
online version: https://learn.microsoft.com/powershell/module/teams/Grant-CsTeamsMediaConnectivityPolicy
6+
schema: 2.0.0
7+
author: lirunping_MSFT
8+
ms.author: runli
9+
---
10+
11+
# Grant-CsTeamsMediaConnectivityPolicy
12+
13+
## SYNOPSIS
14+
This cmdlet applies an instance of the Teams media connectivity policy to users or groups in a tenant.
15+
16+
## SYNTAX
17+
18+
### Identity (Default)
19+
```
20+
Grant-CsTeamsMediaConnectivityPolicy [<CommonParameters>]
21+
```
22+
23+
### GrantToUser
24+
```
25+
Grant-CsTeamsMediaConnectivityPolicy -Identity <String> [[-PolicyName] <String>] [<CommonParameters>]
26+
```
27+
28+
### GrantToGroup
29+
```
30+
Grant-CsTeamsMediaConnectivityPolicy [[-PolicyName] <String>] [-Group] <String> -Rank <Int32>
31+
[<CommonParameters>]
32+
```
33+
34+
### GrantToTenant
35+
```
36+
Grant-CsTeamsMediaConnectivityPolicy [[-PolicyName] <String>] [-Global] [-Force] [<CommonParameters>]
37+
```
38+
39+
## DESCRIPTION
40+
41+
This cmdlet applies an instance of the Teams media connectivity policy to users or groups in a tenant.
42+
43+
Passes in the `Identity` of the policy instance in the `PolicyName` parameter and the user identifier in the `Identity` parameter or the group name in the `Group` parameter. One of either `Identity` or `Group` needs to be passed.
44+
45+
## EXAMPLES
46+
47+
### Example 1
48+
```powershell
49+
PS C:\> Grant-CsTeamsMediaConnectivityPolicy -PolicyName Test -Identity [email protected]
50+
```
51+
52+
Assigns a given policy to a user.
53+
54+
### Example 2
55+
```powershell
56+
PS C:\> Grant-CsTeamsMediaConnectivityPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test
57+
```
58+
59+
Assigns a given policy to a group.
60+
61+
62+
### Example 3
63+
```powershell
64+
PS C:\> Grant-CsTeamsMediaConnectivityPolicy -Global -PolicyName Test
65+
```
66+
67+
Assigns a given policy to the tenant.
68+
69+
### Example 4
70+
```powershell
71+
PS C:\> Grant-CsTeamsMediaConnectivityPolicy -Global -PolicyName Test
72+
```
73+
74+
Note: _Using $null in place of a policy name can be used to unassigned a policy instance._
75+
76+
## PARAMETERS
77+
78+
### -Force
79+
Suppresses the display of any non-fatal error message that might arise when running the command.
80+
81+
```yaml
82+
Type: SwitchParameter
83+
Parameter Sets: GrantToTenant
84+
Aliases:
85+
86+
Required: False
87+
Position: Named
88+
Default value: None
89+
Accept pipeline input: False
90+
Accept wildcard characters: False
91+
```
92+
93+
### -Global
94+
This is the equivalent to `-Identity Global`.
95+
96+
```yaml
97+
Type: SwitchParameter
98+
Parameter Sets: GrantToTenant
99+
Aliases:
100+
101+
Required: True
102+
Position: 0
103+
Default value: None
104+
Accept pipeline input: False
105+
Accept wildcard characters: False
106+
```
107+
108+
### -Group
109+
This is the identifier of the group that the policy should be assigned to.
110+
111+
```yaml
112+
Type: String
113+
Parameter Sets: GrantToGroup
114+
Aliases:
115+
116+
Required: True
117+
Position: 0
118+
Default value: None
119+
Accept pipeline input: False
120+
Accept wildcard characters: False
121+
```
122+
123+
### -Identity
124+
Specifies the identity of the target user.
125+
126+
Example: [email protected]
127+
128+
Example: 98403f08-577c-46dd-851a-f0460a13b03d
129+
130+
Use the "Global" Identity if you wish to set the policy for the entire tenant.
131+
132+
```yaml
133+
Type: String
134+
Parameter Sets: GrantToUser
135+
Aliases:
136+
137+
Required: True
138+
Position: Named
139+
Default value: None
140+
Accept pipeline input: False
141+
Accept wildcard characters: False
142+
```
143+
144+
### -PolicyName
145+
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".
146+
147+
```yaml
148+
Type: String
149+
Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant
150+
Aliases:
151+
152+
Required: False
153+
Position: 1
154+
Default value: None
155+
Accept pipeline input: False
156+
Accept wildcard characters: False
157+
```
158+
159+
### -Rank
160+
The rank of the policy assignment, relative to other group policy assignments for the same policy type.
161+
162+
```yaml
163+
Type: Int32
164+
Parameter Sets: GrantToGroup
165+
Aliases:
166+
167+
Required: True
168+
Position: Named
169+
Default value: None
170+
Accept pipeline input: False
171+
Accept wildcard characters: False
172+
```
173+
174+
### CommonParameters
175+
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).
176+
177+
## INPUTS
178+
179+
## OUTPUTS
180+
181+
## RELATED LINKS
182+
183+
[New-CsTeamsMediaConnectivityPolicy](New-CsTeamsMediaConnectivityPolicy.md)
184+
185+
[Remove-CsTeamsMediaConnectivityPolicy](Remove-CsTeamsMediaConnectivityPolicy.yml)
186+
187+
[Get-CsTeamsMediaConnectivityPolicy](Get-CsTeamsMediaConnectivityPolicy.yml)
188+
189+
[Set-CsTeamsMediaConnectivityPolicy](Set-CsTeamsMediaConnectivityPolicy.yml)

‎teams/teams-ps/teams/New-CsTeamsMediaConnectivityPolicy.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
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 a Teams media connectivity policy.
16+
17+
## SYNTAX
18+
19+
```powershell
20+
New-CsTeamsMediaConnectivityPolicy -Identity <String>
21+
```
22+
23+
## DESCRIPTION
24+
This cmdlet creates a 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+
Creates a new Teams media connectivity policy with the specified identity.
37+
The newly created policy with value will be printed on success.
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)
67+
68+
[Grant-CsTeamsMediaConnectivityPolicy](Grant-CsTeamsMediaConnectivityPolicy.yml)

‎teams/teams-ps/teams/Remove-CsTeamsMediaConnectivityPolicy.md

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)

0 commit comments

Comments
 (0)