Edit

Share via

Get-DlpCompliancePolicy

  • Reference
Module:
ExchangePowerShell
Applies to:
Security & Compliance

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-DlpCompliancePolicy to view data loss prevention (DLP) policies in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Syntax

Get-DlpCompliancePolicy
   [[-Identity] <PolicyIdParameter>]
   [-DisplayName <String>]
   [-DistributionDetail]
   [-ForceValidate <Boolean>]
   [-IncludeExtendedProperties <Boolean>]
   [-IncludeRulesMetadata <Boolean>]
   [-IncludeSimulationResults <Boolean>]
   [-IRMUserRiskConfiguredAnyRule]
   [-Summary]
   [<CommonParameters>]

Description

To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see Permissions in the Microsoft Purview compliance portal.

Examples

Example 1

Get-DlpCompliancePolicy

This example displays summary information for all DLP policies in the Microsoft Purview compliance portal.

Example 2

Get-DlpCompliancePolicy -Identity "PII Limited" | Format-List

This example displays detailed information for the DLP policy named "PII Limited".

Example 3

Get-DlpCompliancePolicy -Identity "PII Limited" -DistributionDetail | Format-List DistributionStatus

This example displays distribution details for a DLP policy.

Example 4

$dlp = Get-DlpCompliancePolicy; ForEach ($d in $dlp){Get-DlpCompliancePolicy -DistributionDetail $d.name | Format-List Name,DistributionStatus}

This example gets all of the DLP policies in an environment and displays the distribution status for each.

Parameters

-DisplayName

{{ Fill DisplayName Description }}

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-DistributionDetail

The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-ForceValidate

{{ Fill ForceValidate Description }}

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-Identity

The Identity parameter specifies the DLP policy that you want to view. You can use any value that uniquely identifies the policy. For example:

  • Name
  • Distinguished name (DN)
  • GUID
  • Id
Type:PolicyIdParameter
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Security & Compliance

-IncludeExtendedProperties

{{ Fill IncludeExtendedProperties Description }}

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-IncludeRulesMetadata

{{ Fill IncludeRulesMetadata Description }}

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-IncludeSimulationResults

{{ Fill IncludeSimulationResults Description }}

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-IRMUserRiskConfiguredAnyRule

{{ Fill IRMUserRiskConfiguredAnyRule Description }}

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-Summary

{{ Fill Summary Description }}

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance