Get-HostedOutboundSpamFilterRule
This cmdlet is available only in the cloud-based service.
Use the Get-HostedOutboundSpamFilterRule cmdlet to view outbound spam filter rules in your cloud-based organization.
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.
Syntax
Default (Default)
Get-HostedOutboundSpamFilterRule
[[-Identity] <RuleIdParameter>]
[-State <RuleState>]
[<CommonParameters>]
Description
You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't 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-HostedOutboundSpamFilterRule | Format-Table Name,Priority,State,HostedOutboundSpamFilterPolicy
This example returns a summary list of all outbound spam filter rules.
Example 2
Get-HostedOutboundSpamFilterRule -Identity "Contoso Executives"
This example returns detailed information for the outbound spam filter rule named "Contoso Executives"
Parameters
-Identity
Applicable: Exchange Online, Exchange Online Protection
The Identity parameter specifies the outbound 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
Parameter properties
Type: | RuleIdParameter |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | 0 |
Mandatory: | False |
Value from pipeline: | True |
Value from pipeline by property name: | True |
Value from remaining arguments: | False |
-State
Applicable: Exchange Online, Exchange Online Protection
The State parameter filters the results by enabled or disabled rules. Valid values are:
- Enabled: Only enabled rules are returned.
- Disabled: Only disabled rules are returned.
Parameter properties
Type: | RuleState |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.