Edit

Share via


Get-SafeLinksPolicy

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

Use the Get-SafeLinksPolicy cmdlet to view Safe Links policies in your cloud-based organization.

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

Syntax

Default (Default)

Get-SafeLinksPolicy
    [[-Identity] <SafeLinksPolicyIdParameter>]
    [<CommonParameters>]

Description

Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site.

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-SafeLinksPolicy | Format-Table Name,EnableSafe*

This example shows a summary list of all Safe Links policies.

Example 2

Get-SafeLinksPolicy -Identity "Contoso All"

This example shows detailed information about the Safe Links policy named Contoso All.

Parameters

-Identity

Applicable: Exchange Online

The Identity parameter specifies the Safe Links 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:SafeLinksPolicyIdParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
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.