|
| 1 | +--- |
| 2 | +external help file: Microsoft.Exchange.TransportMailflow-Help.xml |
| 3 | +online version: https://docs.microsoft.com/powershell/module/exchange/get-quarantinepolicy |
| 4 | +applicable: Exchange Online, Exchange Online Protection |
| 5 | +title: Get-QuarantinePolicy |
| 6 | +schema: 2.0.0 |
| 7 | +author: chrisda |
| 8 | +ms.author: chrisda |
| 9 | +ms.reviewer: |
| 10 | +--- |
| 11 | + |
| 12 | +# Get-QuarantinePolicy |
| 13 | + |
| 14 | +## SYNOPSIS |
| 15 | +This cmdlet is available only in the cloud-based service. |
| 16 | + |
| 17 | +Use the Get-QuarantinePolicy cmdlet to view quarantine policies in your cloud-based organization. |
| 18 | + |
| 19 | +**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). |
| 20 | + |
| 21 | +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). |
| 22 | + |
| 23 | +## SYNTAX |
| 24 | + |
| 25 | +``` |
| 26 | +Get-QuarantinePolicy [[-Identity] <QuarantineTagIdParameter>] |
| 27 | + [-QuarantinePolicyType <QuarantinePolicyTypeEnum>] |
| 28 | + [<CommonParameters>] |
| 29 | +``` |
| 30 | + |
| 31 | +## DESCRIPTION |
| 32 | +Quarantine policies define what users are allowed to do to quarantined messages based on why the message was quarantined (for supported features). For more information, see [Quarantine policies](https://docs.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). |
| 33 | + |
| 34 | +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](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). |
| 35 | + |
| 36 | +## EXAMPLES |
| 37 | + |
| 38 | +### Example 1 |
| 39 | +```powershell |
| 40 | +Get-QuarantinePolicy | Format-Table Name |
| 41 | +``` |
| 42 | + |
| 43 | +This example returns as summary list of all quarantine policies. |
| 44 | + |
| 45 | +### Example 2 |
| 46 | +```powershell |
| 47 | +Get-QuarantinePolicy -Identity NoAccess |
| 48 | +``` |
| 49 | + |
| 50 | +This example returns detailed information about the quarantine policy named NoAccess. |
| 51 | + |
| 52 | +### Example 3 |
| 53 | +```powershell |
| 54 | +Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy |
| 55 | +``` |
| 56 | + |
| 57 | +This example returns detailed information about the default quarantine policy named GlobalDefaultTag that controls the global quarantine notification (formerly known as end-user spam notification) settings. |
| 58 | + |
| 59 | +## PARAMETERS |
| 60 | + |
| 61 | +### -Identity |
| 62 | +The Identity parameter specifies the quarantine policy you want to view. You can use any value that uniquely identifies the quarantine policy. For example: |
| 63 | + |
| 64 | +- Name |
| 65 | +- Distinguished name (DN) |
| 66 | +- GUID |
| 67 | + |
| 68 | +```yaml |
| 69 | +Type: QuarantineTagIdParameter |
| 70 | +Parameter Sets: (All) |
| 71 | +Aliases: |
| 72 | +Applicable: Exchange Online, Exchange Online Protection |
| 73 | + |
| 74 | +Required: False |
| 75 | +Position: 0 |
| 76 | +Default value: None |
| 77 | +Accept pipeline input: True (ByPropertyName, ByValue) |
| 78 | +Accept wildcard characters: False |
| 79 | +``` |
| 80 | +
|
| 81 | +### -QuarantinePolicyType |
| 82 | +The QuarantinePolicyType parameter filters the results by the specified quarantine policy type. Valid values are: |
| 83 | +
|
| 84 | +- QuarantinePolicy: This is the default value, and returns built-in and custom quarantine policies. |
| 85 | +- GlobalQuarantinePolicy: This value is required to return the global settings (quarantine notification settings) in the quarantine policy named GlobalDefaultTag. |
| 86 | +
|
| 87 | +```yaml |
| 88 | +Type: QuarantinePolicyTypeEnum |
| 89 | +Parameter Sets: (All) |
| 90 | +Aliases: |
| 91 | +Accepted values: QuarantinePolicy, GlobalQuarantinePolicy |
| 92 | +Applicable: Exchange Online, Exchange Online Protection |
| 93 | + |
| 94 | +Required: False |
| 95 | +Position: Named |
| 96 | +Default value: None |
| 97 | +Accept pipeline input: False |
| 98 | +Accept wildcard characters: False |
| 99 | +``` |
| 100 | +
|
| 101 | +### CommonParameters |
| 102 | +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). |
| 103 | +
|
| 104 | +## INPUTS |
| 105 | +
|
| 106 | +### |
| 107 | +
|
| 108 | +## OUTPUTS |
| 109 | +
|
| 110 | +### |
| 111 | +
|
| 112 | +## NOTES |
| 113 | +
|
| 114 | +## RELATED LINKS |
0 commit comments