Edit

Share via

Get-CsPolicyPackage

Module:
MicrosoftTeams PowerShell module

This cmdlet supports retrieving all the policy packages available on a tenant.

Syntax

Default (Default) 

Get-CsPolicyPackage
    [[-Identity] <String>]
    -InputObject <IConfigApiBasedCmdletsIdentity>
    [<CommonParameters>]

Description

This cmdlet supports retrieving all the policy packages available on a tenant. Provide the identity of a specific policy package to retrieve its definition, including details on the policies applied with the package. For more information on policy packages, please review https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages.

Examples

Example 1

PS C:\> Get-CsPolicyPackage

Returns all policy packages available on the tenant.

Example 2

PS C:\> Get-CsPolicyPackage -Identity Education_PrimaryStudent

Returns only the Education_PrimaryStudent policy package.

Example 3

PS C:\> $a = Get-CsPolicyPackage -Identity Education_PrimaryStudent
PS C:\> $a.Policies

# In module versions 1.1.9+
PS C:\> $a = Get-CsPolicyPackage -Identity Education_PrimaryStudent
PS C:\> $a.Policies.AdditionalProperties

Key                         Value
---                         -----
TeamsMessagingPolicy        {[Identity, Education_PrimaryStudent], [Description, This is an Education_PrimarySt...
TeamsMeetingPolicy          {[Identity, Education_PrimaryStudent], [Description, This is an Education_PrimarySt...
TeamsAppSetupPolicy         {[Identity, Education_PrimaryStudent], [Description, This is an Education_PrimarySt...
TeamsCallingPolicy          {[Identity, Education_PrimaryStudent], [Description, This is an Education_PrimarySt...
TeamsMeetingBroadcastPolicy {[Identity, Education_PrimaryStudent], [Description, This is an Education_PrimarySt...

Returns the set of policies in the Education_PrimaryStudent policy package.

Parameters

-Identity

Applicable: Microsoft Teams

The name of a specific policy package. All possible policy package names can be found by running Get-CsPolicyPackage.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

The identity parameter.

Parameter properties

Type:IConfigApiBasedCmdletsIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.