Get-SafeAttachmentRule

This cmdlet is available only in the cloud-based service. Use the Get-SafeAttachmentRule cmdlet to view Safe Attachments rules in your cloud-based organization. For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx).

Syntax

Get-SafeAttachmentRule
   [[-Identity] <RuleIdParameter>]
   [-State <Enabled | Disabled>]
   [<CommonParameters>]

Description

Safe Attachments is a feature in Advanced Threat Protection that opens email attachments in a special hypervisor environment to detect malicious activity.

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 (https://technet.microsoft.com/library/mt432940.aspx).

Examples

-------------------------- Example 1 --------------------------

Get-SafeAttachmentRule

This example returns a summary list of all Safe Attachments rules in your organization.

-------------------------- Example 2 --------------------------

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

This example returns detailed information about the Safe Attachments rule named Research Department Attachment Rule.

Optional Parameters

-Identity

The Identity parameter specifies the Safe Attachments rule that you want to view.

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

  • Name

  • Distinguised name (DN)

  • GUID

Type:RuleIdParameter
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Online, Exchange Online Protection
-State

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

Type:Enabled | Disabled
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online, Exchange Online Protection

Inputs

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data.

Outputs

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data.