Get-AntiPhishPolicy
This cmdlet is available only in the cloud-based service.
Use the Get-AntiPhishPolicy cmdlet to view antiphish policies in your cloud-based organization. This cmdlet returns results only in Exchange Online PowerShell.
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.
Syntax
Default (Default)
Get-AntiPhishPolicy
[-Identity <AntiPhishPolicyIdParameter>]
[-Advanced]
[-Impersonation]
[-Spoof]
[<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-AntiPhishPolicy | Format-Table Name,Enabled,IsDefault
This example shows a summary list of all antiphish policies.
Example 2
Get-AntiPhishPolicy -Identity "Office365 AntiPhish Default"
This example shows detailed information about the antiphish policy named Office 365 AntiPhish Default.
Parameters
-Advanced
Applicable: Exchange Online
The Advanced switch filters the properties that are returned to the advanced settings in the policy. For example:
- PhishThresholdLevel
- EnableSuspiciousSafetyTip (This value is always False, and you can't change it.)
You don't need to specify a value with this switch.
Advanced settings are available only in anti-phishing policies in Microsoft Defender for Office 365.
Parameter properties
Type: | SwitchParameter |
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 |
-Identity
Applicable: Exchange Online, Exchange Online Protection
The Identity parameter specifies the antiphish policy that you want to view. You can use any value that uniquely identifies the policy. For example:
- Name
- Distinguished name (DN)
- GUID
Parameter properties
Type: | AntiPhishPolicyIdParameter |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | 0 |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-Impersonation
Applicable: Exchange Online
The Impersonation switch filters the properties that are returned to the impersonation settings in the policy. For example:
- EnableMailboxIntelligence
- EnableMailboxIntelligenceProtection
- EnableOrganizationDomainsProtection
- EnableSimilarDomainsSafetyTips
- EnableSimilarUsersSafetyTips
- EnableTargetedDomainsProtection
- EnableTargetedUserProtection
- EnableUnusualCharactersSafetyTips
- ExcludedDomains
- ExcludedSenders
- ImpersonationProtectionState
- MailboxIntelligenceProtectionAction
- MailboxIntelligenceProtectionActionRecipients
- TargetedDomainActionRecipients
- TargetedDomainProtectionAction
- TargetedDomainsToProtect
- TargetedUserActionRecipients
- TargetedUserProtectionAction
- TargetedUsersToProtect
You don't need to specify a value with this switch.
Impersonation settings are available only in anti-phishing policies in Microsoft Defender for Office 365.
Parameter properties
Type: | SwitchParameter |
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 |
-Spoof
Applicable: Exchange Online, Exchange Online Protection
The Spoof switch filters the properties that are returned to the spoof settings in the policy. For example:
- EnableAntiSpoofEnforcement
- EnableUnauthenticatedSender
You don't need to specify a value with this switch.
Parameter properties
Type: | SwitchParameter |
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.