Get-SafeAttachmentRule

  • Reference
Module:
ExchangePowerShell
Applies to:
Exchange Online

This cmdlet is available only in the cloud-based service.

Use the Get-SafeAttachmentRule cmdlet to view safe attachment rules in your cloud-based organization.

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

Syntax

Get-SafeAttachmentRule
   [[-Identity] <RuleIdParameter>]
   [-State <RuleState>]
   [<CommonParameters>]

Description

Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see Safe Attachments in Defender for Office 365.

You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet.

Examples

Example 1

Get-SafeAttachmentRule

This example returns a summary list of all safe attachment rules in your organization.

Example 2

Get-SafeAttachmentRule -Identity "Research Department Attachment Rule" | Format-List

This example returns detailed information about the safe attachment rule named Research Department Attachment Rule.

Parameters

-Identity

The Identity parameter specifies the safe attachment rule that you want to view.

You can use any value that uniquely identifies the rule. For example:

  • Name
  • Distinguished name (DN)
  • GUID
Type:RuleIdParameter
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Online

-State

The State parameter filters the results by the state of the rule. Valid values are Enabled and Disabled.

Type:RuleState
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online