-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Add TeamsMediaConnectivityPolicy cmdlets public docs #11639
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
52a40c8
Add TeamsMediaConnectivityPolicy cmdlets public docs
lirunping-MSFT b052502
Add Grant-CsTeamsMediaConnectivityPolicy doc
lirunping-MSFT fcf2d68
Address review comments
lirunping-MSFT 9a8ba94
Address more comments
lirunping-MSFT ea3458c
Fix file name issue in Remove-CsTeamsMediaConnectivityPolicy.md
lirunping-MSFT File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
56 changes: 56 additions & 0 deletions
56
teams/teams-ps/teams/Get-CsTeamsMediaConnectivityPolicy.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
--- | ||
Module Name: microsoftteams | ||
applicable: Microsoft Teams | ||
title: Get-CsTeamsMediaConnectivityPolicy | ||
online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsMediaConnectivityPolicy | ||
schema: 2.0.0 | ||
author: lirunping_MSFT | ||
ms.author: runli | ||
--- | ||
|
||
# Get-CsTeamsMediaConnectivityPolicy | ||
|
||
## SYNOPSIS | ||
|
||
This cmdlet retrieves all Teams media connectivity policies for current tenant. | ||
|
||
## SYNTAX | ||
|
||
``` | ||
Get-CsTeamsMediaConnectivityPolicy | ||
``` | ||
|
||
## DESCRIPTION | ||
|
||
This cmdlet retrieves all Teams media connectivity policies for current tenant. | ||
|
||
## EXAMPLES | ||
|
||
### Example 1 | ||
```powershell | ||
PS C:\> Get-CsTeamsMediaConnectivityPolicy | ||
Identity DirectConnection | ||
-------- ---------------- | ||
Tag:Test Enabled | ||
``` | ||
|
||
retrieves Teams media connectivity policies, show the result as identity tag and "DirectConnection" value. | ||
|
||
## PARAMETERS | ||
|
||
### CommonParameters | ||
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). | ||
|
||
## INPUTS | ||
|
||
## OUTPUTS | ||
|
||
## RELATED LINKS | ||
|
||
[New-CsTeamsMediaConnectivityPolicy](New-CsTeamsMediaConnectivityPolicy.md) | ||
|
||
[Remove-CsTeamsMediaConnectivityPolicy](Remove-CsTeamsMediaConnectivityPolicy.yml) | ||
|
||
[Set-CsTeamsMediaConnectivityPolicy](Set-CsTeamsMediaConnectivityPolicy.yml) | ||
|
||
[Grant-CsTeamsMediaConnectivityPolicy](Grant-CsTeamsMediaConnectivityPolicy.yml) |
189 changes: 189 additions & 0 deletions
189
teams/teams-ps/teams/Grant-CsTeamsMediaConnectivityPolicy.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,189 @@ | ||
--- | ||
Module Name: microsoftteams | ||
applicable: Microsoft Teams | ||
title: Grant-CsTeamsMediaConnectivityPolicy | ||
online version: https://learn.microsoft.com/powershell/module/teams/Grant-CsTeamsMediaConnectivityPolicy | ||
schema: 2.0.0 | ||
author: lirunping_MSFT | ||
ms.author: runli | ||
--- | ||
|
||
# Grant-CsTeamsMediaConnectivityPolicy | ||
|
||
## SYNOPSIS | ||
This cmdlet applies an instance of the Teams media connectivity policy to users or groups in a tenant. | ||
|
||
## SYNTAX | ||
|
||
### Identity (Default) | ||
``` | ||
Grant-CsTeamsMediaConnectivityPolicy [<CommonParameters>] | ||
``` | ||
|
||
### GrantToUser | ||
``` | ||
Grant-CsTeamsMediaConnectivityPolicy -Identity <String> [[-PolicyName] <String>] [<CommonParameters>] | ||
``` | ||
|
||
### GrantToGroup | ||
``` | ||
Grant-CsTeamsMediaConnectivityPolicy [[-PolicyName] <String>] [-Group] <String> -Rank <Int32> | ||
[<CommonParameters>] | ||
``` | ||
|
||
### GrantToTenant | ||
``` | ||
Grant-CsTeamsMediaConnectivityPolicy [[-PolicyName] <String>] [-Global] [-Force] [<CommonParameters>] | ||
``` | ||
|
||
## DESCRIPTION | ||
|
||
This cmdlet applies an instance of the Teams media connectivity policy to users or groups in a tenant. | ||
|
||
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. | ||
|
||
## EXAMPLES | ||
|
||
### Example 1 | ||
```powershell | ||
PS C:\> Grant-CsTeamsMediaConnectivityPolicy -PolicyName Test -Identity testuser@test.onmicrosoft.com | ||
``` | ||
|
||
Assigns a given policy to a user. | ||
|
||
### Example 2 | ||
```powershell | ||
PS C:\> Grant-CsTeamsMediaConnectivityPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test | ||
``` | ||
|
||
Assigns a given policy to a group. | ||
|
||
|
||
### Example 3 | ||
```powershell | ||
PS C:\> Grant-CsTeamsMediaConnectivityPolicy -Global -PolicyName Test | ||
``` | ||
|
||
Assigns a given policy to the tenant. | ||
|
||
### Example 4 | ||
```powershell | ||
PS C:\> Grant-CsTeamsMediaConnectivityPolicy -Global -PolicyName Test | ||
``` | ||
|
||
Note: _Using $null in place of a policy name can be used to unassigned a policy instance._ | ||
|
||
## PARAMETERS | ||
|
||
### -Force | ||
Suppresses the display of any non-fatal error message that might arise when running the command. | ||
|
||
```yaml | ||
Type: SwitchParameter | ||
Parameter Sets: GrantToTenant | ||
Aliases: | ||
|
||
Required: False | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
|
||
### -Global | ||
This is the equivalent to `-Identity Global`. | ||
|
||
```yaml | ||
Type: SwitchParameter | ||
Parameter Sets: GrantToTenant | ||
Aliases: | ||
|
||
Required: True | ||
Position: 0 | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
|
||
### -Group | ||
This is the identifier of the group that the policy should be assigned to. | ||
|
||
```yaml | ||
Type: String | ||
Parameter Sets: GrantToGroup | ||
Aliases: | ||
|
||
Required: True | ||
Position: 0 | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
|
||
### -Identity | ||
Specifies the identity of the target user. | ||
|
||
Example: testuser@test.onmicrosoft.com | ||
|
||
Example: 98403f08-577c-46dd-851a-f0460a13b03d | ||
|
||
Use the "Global" Identity if you wish to set the policy for the entire tenant. | ||
|
||
```yaml | ||
Type: String | ||
Parameter Sets: GrantToUser | ||
Aliases: | ||
|
||
Required: True | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
|
||
### -PolicyName | ||
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". | ||
|
||
```yaml | ||
Type: String | ||
Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant | ||
Aliases: | ||
|
||
Required: False | ||
Position: 1 | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
|
||
### -Rank | ||
The rank of the policy assignment, relative to other group policy assignments for the same policy type. | ||
|
||
```yaml | ||
Type: Int32 | ||
Parameter Sets: GrantToGroup | ||
Aliases: | ||
|
||
Required: True | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
|
||
### CommonParameters | ||
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). | ||
|
||
## INPUTS | ||
|
||
## OUTPUTS | ||
|
||
## RELATED LINKS | ||
|
||
[New-CsTeamsMediaConnectivityPolicy](New-CsTeamsMediaConnectivityPolicy.md) | ||
|
||
[Remove-CsTeamsMediaConnectivityPolicy](Remove-CsTeamsMediaConnectivityPolicy.yml) | ||
|
||
[Get-CsTeamsMediaConnectivityPolicy](Get-CsTeamsMediaConnectivityPolicy.yml) | ||
|
||
[Set-CsTeamsMediaConnectivityPolicy](Set-CsTeamsMediaConnectivityPolicy.yml) |
68 changes: 68 additions & 0 deletions
68
teams/teams-ps/teams/New-CsTeamsMediaConnectivityPolicy.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
--- | ||
Module Name: microsoftteams | ||
applicable: Microsoft Teams | ||
title: New-CsTeamsMediaConnectivityPolicy | ||
online version: https://learn.microsoft.com/powershell/module/teams/New-CsTeamsMediaConnectivityPolicy | ||
schema: 2.0.0 | ||
author: lirunping_MSFT | ||
ms.author: runli | ||
--- | ||
|
||
|
||
# New-CsTeamsMediaConnectivityPolicy | ||
|
||
## SYNOPSIS | ||
This cmdlet creates a Teams media connectivity policy. | ||
|
||
## SYNTAX | ||
|
||
```powershell | ||
New-CsTeamsMediaConnectivityPolicy -Identity <String> | ||
``` | ||
|
||
## DESCRIPTION | ||
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. | ||
|
||
## EXAMPLES | ||
|
||
### Example 1 | ||
```powershell | ||
PS C:\> New-CsTeamsMediaConnectivityPolicy -Identity Test | ||
|
||
Identity DirectConnection | ||
------------------------- | ||
Tag:Test Enabled | ||
``` | ||
Creates a new Teams media connectivity policy with the specified identity. | ||
The newly created policy with value will be printed on success. | ||
|
||
|
||
## PARAMETERS | ||
|
||
### -Identity | ||
Identity of the Teams media connectivity policy. | ||
|
||
```yaml | ||
Type: String | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: True | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
|
||
### CommonParameters | ||
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). | ||
|
||
|
||
## RELATED LINKS | ||
[Remove-CsTeamsMediaConnectivityPolicy](Remove-CsTeamsMediaConnectivityPolicy.yml) | ||
|
||
[Get-CsTeamsMediaConnectivityPolicy](Get-CsTeamsMediaConnectivityPolicy.yml) | ||
|
||
[Set-CsTeamsMediaConnectivityPolicy](Set-CsTeamsMediaConnectivityPolicy.yml) | ||
|
||
[Grant-CsTeamsMediaConnectivityPolicy](Grant-CsTeamsMediaConnectivityPolicy.yml) |
66 changes: 66 additions & 0 deletions
66
teams/teams-ps/teams/Remove-CsTeamsMediaConnectivityPolicy.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
--- | ||
Module Name: microsoftteams | ||
applicable: Microsoft Teams | ||
title: Remove-CsTeamsMediaConnectivityPolicy | ||
online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsTeamsMediaConnectivityPolicy | ||
schema: 2.0.0 | ||
author: lirunping_MSFT | ||
ms.author: runli | ||
--- | ||
|
||
# Remove-CsTeamsMediaConnectivityPolicy | ||
|
||
## SYNOPSIS | ||
|
||
This cmdlet deletes a Teams media connectivity policy. | ||
|
||
## SYNTAX | ||
|
||
``` | ||
Remove-CsTeamsMediaConnectivityPolicy -Identity <String> | ||
``` | ||
|
||
## DESCRIPTION | ||
|
||
This cmdlet deletes a Teams media connectivity policy with the specified identity string. | ||
|
||
## EXAMPLES | ||
|
||
### Example 1 | ||
```powershell | ||
PS C:\> Remove-CsTeamsMediaConnectivityPolicy -Identity "Test" | ||
``` | ||
|
||
Deletes a Teams media connectivity policy with the identify of "Test". | ||
|
||
## PARAMETERS | ||
|
||
### -Identity | ||
Identity of the Teams media connectivity policy. | ||
|
||
```yaml | ||
Type: String | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: True | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
|
||
### CommonParameters | ||
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). | ||
|
||
## INPUTS | ||
|
||
## OUTPUTS | ||
|
||
## RELATED LINKS | ||
|
||
[New-CsTeamsMediaConnectivityPolicy](New-CsTeamsMediaConnectivityPolicy.md) | ||
|
||
[Get-CsTeamsMediaConnectivityPolicy](Get-CsTeamsMediaConnectivityPolicy.yml) | ||
|
||
[Set-CsTeamsMediaConnectivityPolicy](Set-CsTeamsMediaConnectivityPolicy.yml) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.