Set-MalwareFilterRule

 

Applies to: Exchange Online, Exchange Online Protection, Exchange Server 2016

This cmdlet is available in on-premises Exchange Server 2016 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-MalwareFilterRule cmdlet to modify malware filter rules in your organization.

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

Set-MalwareFilterRule -Identity <RuleIdParameter> [-Comments <String>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-ExceptIfRecipientDomainIs <Word[]>] [-ExceptIfSentTo <RecipientIdParameter[]>] [-ExceptIfSentToMemberOf <RecipientIdParameter[]>] [-MalwareFilterPolicy <MalwareFilterPolicyIdParameter>] [-Name <String>] [-Priority <Int32>] [-RecipientDomainIs <Word[]>] [-SentTo <RecipientIdParameter[]>] [-SentToMemberOf <RecipientIdParameter[]>] [-WhatIf [<SwitchParameter>]]

This example adds an exception to the malware filter rule named Contoso Recipients for members of the distribution group named Contoso Human Resources.

Set-MalwareFilterRule "Contoso Recipients" -ExceptIfSentToMemberOf "Contoso Human Resources"

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Anti-malware" entry in the Anti-spam and anti-malware permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.MessagingPolicies.Rules.Tasks.RuleIdParameter

The Identity parameter specifies the malware filter rule that you want to view. You can use any value that uniquely identifies the rule. For example, you can use the name, GUID, or distinguished name (DN) of the malware filter rule.

Comments

Optional

System.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.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2016.

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

ExceptIfRecipientDomainIs

Optional

Microsoft.Exchange.Data.Word[]

The ExceptIfRecipientDomainIs parameter specifies an exception to the rule that's based on the domain of the recipient's email address (for example, contoso.com). The rule isn't applied to messages sent to recipients whose email addresses are in the specified domain. You can specify multiple values separated by commas.

ExceptIfSentTo

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

The ExceptIfSentTo parameter specifies an exception to the rule that's based on the recipient. The rule isn't applied to messages sent to the specified recipient. You can use any value that uniquely identifies the recipient. For example:

  • Name

  • Distinguished name (DN)

  • Display name

  • Email address

  • GUID

You can specify multiple values separated by commas.

To enter multiple values, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, use the following syntax: "<value1>","<value2>"....

ExceptIfSentToMemberOf

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

The ExceptIfSentToMemberOf parameter specifies an exception to the rule that's based on group membership. The rule isn't applied to messages where any recipient is a member of the specified group. You can use any value that uniquely identifies the group. For example:

  • Name

  • Distinguished name (DN)

  • Display name

  • Email address

  • GUID

You can specify multiple values separated by commas.

To enter multiple values, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, use the following syntax: "<value1>","<value2>"....

noteNote:
If the group is removed after creation of the rule, no exception is made.

MalwareFilterPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.MalwareFilterPolicyIdParameter

The MalwareFilterPolicy parameter specifies the malware filter policy to apply to messages that match the conditions defined by this malware filter rule.

You can use any value that uniquely identifies the policy. For example, you can specify the name, GUID, or distinguished name (DN) of the content filter policy.

noteNote:
You can't specify the default malware filter policy. And, you can't specify a malware filter policy that's already associated with another malware filter rule.

Name

Optional

System.String

The Name parameter specifies a unique name for the malware filter rule.

Priority

Optional

System.Int32

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.

Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules:

  • Valid priority values for the existing 8 rules are from 0 through 7.

  • Valid priority values for a new rule (the 9th rule) are from 0 through 8.

  • The default value for a new rule (the 9th rule) is 8.

If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1.

RecipientDomainIs

Optional

Microsoft.Exchange.Data.Word[]

The RecipientDomainIs parameter specifies a condition for the rule that's based on the domain of the recipient's email address (for example, contoso.com). The rule is applied to messages sent to recipients whose email addresses are in the specified domain. You can specify multiple values separated by commas.

SentTo

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

The SentTo parameter specifies a condition for the rule that's based on the recipient. The rule is applied to messages sent to the specified recipient. You can use any value that uniquely identifies the recipient. For example:

  • Name

  • Distinguished name (DN)

  • Display name

  • Email address

  • GUID

You can specify multiple values separated by commas.

To enter multiple values, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, use the following syntax: "<value1>","<value2>"....

SentToMemberOf

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

The SentToMemberOf parameter specifies a condition for the rule that's based on group membership. The rule is applied to messages where any recipient is a member of the specified group. You can use any value that uniquely identifies the group. For example:

  • Name

  • Distinguished name (DN)

  • Display name

  • Email address

  • GUID

You can specify multiple values separated by commas.

To enter multiple values, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, use the following syntax: "<value1>","<value2>"....

noteNote:
If the group is removed after creation of the rule, no action is taken.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

 
Show: