Skip to content

Latest commit

 

History

History
190 lines (140 loc) · 4.58 KB

Grant-CsTeamsMediaConnectivityPolicy.md

File metadata and controls

190 lines (140 loc) · 4.58 KB
external help file Module Name applicable title online version schema author ms.author
Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml
MicrosoftTeams
Microsoft Teams
Grant-CsTeamsMediaConnectivityPolicy
2.0.0
lirunping-MSFT
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

PS C:\> Grant-CsTeamsMediaConnectivityPolicy -PolicyName Test -Identity testuser@test.onmicrosoft.com

Assigns a given policy to a user.

Example 2

PS C:\> Grant-CsTeamsMediaConnectivityPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test

Assigns a given policy to a group.

Example 3

PS C:\> Grant-CsTeamsMediaConnectivityPolicy -Global -PolicyName Test

Assigns a given policy to the tenant.

Example 4

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.

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.

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.

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.

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".

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.

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.

INPUTS

OUTPUTS

RELATED LINKS

New-CsTeamsMediaConnectivityPolicy

Remove-CsTeamsMediaConnectivityPolicy

Get-CsTeamsMediaConnectivityPolicy

Set-CsTeamsMediaConnectivityPolicy