Parameters

Parameter	Attribute	DataType	Description	Allowed Values
Identity	Key	String	The Identity parameter specifies the name of the SafeAttachment rule that you want to modify.
SafeAttachmentPolicy	Required	String	The SafeAttachmentPolicy parameter specifies the name of the SafeAttachment policy that's associated with the SafeAttachment rule.
Enabled	Write	Boolean	Specify if this rule should be enabled. Default is $true.
Priority	Write	UInt32	The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value.
Comments	Write	String	The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters.
ExceptIfRecipientDomainIs	Write	StringArray[]	The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas.
ExceptIfSentTo	Write	StringArray[]	The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient.
ExceptIfSentToMemberOf	Write	StringArray[]	The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group.
RecipientDomainIs	Write	StringArray[]	The RecipientDomainIs parameter specifies a condition that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas.
SentTo	Write	StringArray[]	The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient.
SentToMemberOf	Write	StringArray[]	The SentToMemberOf parameter looks for messages sent to members of groups. You can use any value that uniquely identifies the group.
Ensure	Write	String	Specify if this rule should exist or not.	Present, Absent
Credential	Write	PSCredential	Credentials of the Exchange Global Admin
ApplicationId	Write	String	Id of the Azure Active Directory application to authenticate with.
TenantId	Write	String	Id of the Azure Active Directory tenant used for authentication.
CertificateThumbprint	Write	String	Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication.
CertificatePassword	Write	PSCredential	Username can be made up to anything but password will be used for CertificatePassword
CertificatePath	Write	String	Path to certificate used in service principal usually a PFX file.

EXOSafeAttachmentRule

Description

This resource configures an Safe Attachment Rule in Exchange Online.

Parameters

SafeAttachmentPolicy

Required: Yes
Description: The Identity of the SafeAttachment Policy to associate with this SafeAttachment Rule.

Ensure

Required: No (Defaults to 'Present')
Description: Specifies if the configuration should be Present or Absent

Credential

Required: Yes
Description: Credentials of the account to authenticate with

Identity

Required: Yes
Description: Name of the Safe Attachment Rule

Example

        EXOSafeAttachmentRule TestSafeAttachmentRule {
            Ensure = 'Present'
            Identity = 'TestRule'
            Credential = $Credential
            SafeAttachmentPolicy = 'TestPolicy'
            Enabled = $true
            Priority = 0
            RecipientDomainIs = @('contoso.com')
        }

Home
What is Microsoft365DSC?
Getting Started
Resources List and Examples