Get-HostedContentFilterRule

Reference

Module:: ExchangePowerShell

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

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

Use the Get-HostedContentFilterRule cmdlet to view spam filter rules (content filter rules) in your cloud-based organization.

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

Syntax

Get-HostedContentFilterRule
   [[-Identity] <RuleIdParameter>]
   [-DomainController <Fqdn>]
   [-State <RuleState>]
   [<CommonParameters>]

Description

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-HostedContentFilterRule

This example shows a summary list of all the spam filter rules in your cloud-based organization.

Example 2

Get-HostedContentFilterRule "Contoso Recipients" | Format-List

This example retrieves details about the spam filter rule named Contoso Recipients.

Parameters

-DomainController

This parameter is reserved for internal Microsoft use.

Type:	Fqdn
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Identity

The Identity parameter specifies the spam filter 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 Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection

-State

The State parameter filters the results by the state of the rule. Valid values are:

Enabled: The command returns only enabled rules.
Disabled: The command returns only disabled rules.

Type:	RuleState
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection

Inputs

Input types

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.

Outputs

Output types

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.

Jaa