Edit

Share via

Get-QuarantinePolicy

Module:
Exchange PowerShell

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

Use the Get-QuarantinePolicy cmdlet to view quarantine 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-QuarantinePolicy
    [[-Identity] <QuarantineTagIdParameter>]
    [-QuarantinePolicyType <QuarantinePolicyType>]
    [<CommonParameters>]

Description

Quarantine policies define what users are allowed to do to quarantined messages based on why the message was quarantined (for supported features) and quarantine notification settings. For more information, see Quarantine policies.

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-QuarantinePolicy | Format-Table Name

This example returns as summary list of all quarantine policies.

Example 2

Get-QuarantinePolicy -Identity NoAccess

This example returns detailed information about the quarantine policy named NoAccess.

Example 3

Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy

This example returns detailed information about the default quarantine policy named DefaultGlobalTag that controls the global quarantine notification (formerly known as end-user spam notification) settings.

Parameters

-Identity

Applicable: Exchange Online, Exchange Online Protection

The Identity parameter specifies the quarantine policy you want to view. You can use any value that uniquely identifies the quarantine policy. For example:

  • Name
  • Distinguished name (DN)
  • GUID

Parameter properties

Type:QuarantineTagIdParameter
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

-QuarantinePolicyType

Applicable: Exchange Online, Exchange Online Protection

The QuarantinePolicyType parameter filters the results by the specified quarantine policy type. Valid values are:

  • QuarantinePolicy: This value is the default, and returns built-in and custom quarantine policies.
  • GlobalQuarantinePolicy: This value is required to return the global settings (quarantine notification settings) in the quarantine policy named DefaultGlobalTag.

Parameter properties

Type:QuarantinePolicyType
Default value:None
Accepted values:QuarantinePolicy, GlobalQuarantinePolicy
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.