Skip to content
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

Add TeamsMediaConnectivityPolicy cmdlets public docs #11639

Merged
merged 5 commits into from Apr 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
56 changes: 56 additions & 0 deletions teams/teams-ps/teams/Get-CsTeamsMediaConnectivityPolicy.md
@@ -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 teams/teams-ps/teams/Grant-CsTeamsMediaConnectivityPolicy.md
@@ -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
lirunping-MSFT marked this conversation as resolved.
Show resolved Hide resolved
```

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 teams/teams-ps/teams/New-CsTeamsMediaConnectivityPolicy.md
@@ -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 teams/teams-ps/teams/Remove-CsTeamsMediaConnectivityPolicy.md
@@ -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)