Edit

Share via

Get-ProtectionAlert

Module:
Exchange PowerShell

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

Use the Get-ProtectionAlert cmdlet to view alert policies in the Microsoft Purview compliance portal.

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

Syntax

Default (Default) 

Get-ProtectionAlert
    [[-Identity] <ComplianceRuleIdParameter>]
    [-IncludeRuleXml]
    [<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-ProtectionAlert | Format-List Name,Category,Comment,NotifyUser

This example returns a summary list of all alert policies.

Example 2

Get-ProtectionAlert -Identity "Malware campaign detected after delivery"

This example returns detailed information about the specified alert policy.

Parameters

-Identity

Applicable: Security & Compliance

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

  • Name
  • Distinguished name (DN)
  • GUID

Parameter properties

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

Parameter sets

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

-IncludeRuleXml

Applicable: Security & Compliance

{{ Fill IncludeRuleXml Description }}

Parameter properties

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

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
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.