Get-CsTeamsMessagingPolicy

  • Reference
Module:
MicrosoftTeamsPowerShell
Applies to:
Microsoft Teams

The CsTeamsMessagingPolicy cmdlets enable administrators to control if a user is enabled to exchange messages.

Syntax

Get-CsTeamsMessagingPolicy
   [-Tenant <Guid>]
   [[-Identity] <XdsIdentity>]
   [-LocalStore]
   [<CommonParameters>]
Get-CsTeamsMessagingPolicy
   [-Tenant <Guid>]
   [-Filter <String>]
   [-LocalStore]
   [<CommonParameters>]

Description

The CsTeamsMessagingPolicy cmdlets enable administrators to control if a user is enabled to exchange messages. These also help determine the type of messages users can create and modify. This cmdlet lets you retrieve messaging policies that are available for use within your organization.

Examples

Example 1

powershell
PS C:\> Get-CsTeamsMessagingPolicy

In this example all teams messaging policies that have been configured in the organization will be returned.

Parameters

-Filter

Enables you to use wildcard characters when specifying the policy (or policies) to be returned.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Identity

Unique identifier for the policy to be retrieved. To retrieve the global policy, use this syntax: -Identity global. To retrieve a per-user policy use syntax similar to this: -Identity StudentMessagingPolicy.

If this parameter is not included, the Get-CsTeamsMessagingPolicy cmdlet will return a collection of all the teams messaging policies configured for use in your organization.

Note that wildcards are not allowed when specifying an Identity. Use the Filter parameter if you need to use wildcards when specifying a messaging policy.

Type:XdsIdentity
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LocalStore

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Tenant

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

System.Object