|
| 1 | +--- |
| 2 | +external help file: Microsoft.Exchange.TransportMailflow-Help.xml |
| 3 | +online version: https://docs.microsoft.com/powershell/module/exchange/get-tenantallowblocklistitems |
| 4 | +applicable: Exchange Online, Exchange Online Protection |
| 5 | +title: Get-TenantAllowBlockListItems |
| 6 | +schema: 2.0.0 |
| 7 | +author: chrisda |
| 8 | +ms.author: chrisda |
| 9 | +ms.reviewer: |
| 10 | +monikerRange: "exchonline-ps || eop-ps" |
| 11 | +ROBOTS: NOINDEX, NOFOLLOW |
| 12 | +--- |
| 13 | + |
| 14 | +# Get-TenantAllowBlockListItems |
| 15 | + |
| 16 | +## SYNOPSIS |
| 17 | +**Note**: The features described in this topic are in Preview, are subject to change, and are not available in all organizations. |
| 18 | + |
| 19 | +This cmdlet is available only in the cloud-based service. |
| 20 | + |
| 21 | +Use the Get-TenantAllowBlockListItems cmdlet to view entries in the Tenant Allow/Block List in the Security & Compliance Center. |
| 22 | + |
| 23 | +**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Use the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/exchange-online-powershell-v2). |
| 24 | + |
| 25 | +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-server/exchange-cmdlet-syntax). |
| 26 | + |
| 27 | +## SYNTAX |
| 28 | + |
| 29 | +### NoExpiration |
| 30 | +``` |
| 31 | +Get-TenantAllowBlockListItems -ListType <ListType> |
| 32 | + [-Action <TenantAllowBlockList.ItemAction>] |
| 33 | + [-Entry <String>] |
| 34 | + [-NoExpiration] |
| 35 | + [-OutputJson] |
| 36 | + [<CommonParameters>] |
| 37 | +``` |
| 38 | + |
| 39 | +### Expiration |
| 40 | +``` |
| 41 | +Get-TenantAllowBlockListItems -ListType <ListType> |
| 42 | + [-Action <TenantAllowBlockList.ItemAction>] |
| 43 | + [-Entry <String>] |
| 44 | + [-ExpirationDate <DateTime>] |
| 45 | + [-OutputJson] |
| 46 | + [<CommonParameters>] |
| 47 | +``` |
| 48 | + |
| 49 | +## DESCRIPTION |
| 50 | +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/exchange-server/find-exchange-cmdlet-permissions). |
| 51 | + |
| 52 | +## EXAMPLES |
| 53 | + |
| 54 | +### Example 1 |
| 55 | +```powershell |
| 56 | +Get-TenantAllowBlockListItems -ListType Url -Action Block |
| 57 | +``` |
| 58 | + |
| 59 | +This example returns all blocked URLs. |
| 60 | + |
| 61 | +### Example 2 |
| 62 | +```powershell |
| 63 | +Get-TenantAllowBlockListItems -ListType FileHash -Entry "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08" |
| 64 | +``` |
| 65 | + |
| 66 | +This example returns information for the specified file hash value. |
| 67 | + |
| 68 | +## PARAMETERS |
| 69 | + |
| 70 | +### -ListType |
| 71 | +The ListType parameter specifies the list to view. Valid values are: |
| 72 | + |
| 73 | +-FileHash |
| 74 | +-Url |
| 75 | + |
| 76 | +```yaml |
| 77 | +Type: ListType |
| 78 | +Parameter Sets: (All) |
| 79 | +Aliases: |
| 80 | +Applicable: Exchange Online, Exchange Online Protection |
| 81 | + |
| 82 | +Required: True |
| 83 | +Position: Named |
| 84 | +Default value: None |
| 85 | +Accept pipeline input: False |
| 86 | +Accept wildcard characters: False |
| 87 | +``` |
| 88 | +
|
| 89 | +### -Action |
| 90 | +The Action parameter filters the results by action type. Valid values are: |
| 91 | +
|
| 92 | +- Allow |
| 93 | +- Block |
| 94 | +
|
| 95 | +```yaml |
| 96 | +Type: TenantAllowBlockList.ItemAction |
| 97 | +Parameter Sets: (All) |
| 98 | +Aliases: |
| 99 | +Applicable: Exchange Online, Exchange Online Protection |
| 100 | + |
| 101 | +Required: False |
| 102 | +Position: Named |
| 103 | +Default value: None |
| 104 | +Accept pipeline input: False |
| 105 | +Accept wildcard characters: False |
| 106 | +``` |
| 107 | +
|
| 108 | +### -Entry |
| 109 | +The Entry parameter filters the results by the specified URL or file hash value: |
| 110 | +
|
| 111 | +- The exact URL entry value. |
| 112 | +
|
| 113 | +- The exact SHA256 file hash value. |
| 114 | +
|
| 115 | +```yaml |
| 116 | +Type: String |
| 117 | +Parameter Sets: (All) |
| 118 | +Aliases: |
| 119 | +Applicable: Exchange Online, Exchange Online Protection |
| 120 | + |
| 121 | +Required: False |
| 122 | +Position: Named |
| 123 | +Default value: None |
| 124 | +Accept pipeline input: False |
| 125 | +Accept wildcard characters: False |
| 126 | +``` |
| 127 | +
|
| 128 | +### -ExpirationDate |
| 129 | +The ExpirationDate parameter filters the results by expiration date in Coordinated Universal Time (UTC). |
| 130 | +
|
| 131 | +To specify a date/time value for this parameter, use either of the following options: |
| 132 | +
|
| 133 | +- Specify the date/time value in UTC: For example, `"2016-05-06 14:30:00z"`. |
| 134 | +
|
| 135 | +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2020 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://go.microsoft.com/fwlink/p/?LinkID=113313). |
| 136 | + |
| 137 | +```yaml |
| 138 | +Type: DateTime |
| 139 | +Parameter Sets: Expiration |
| 140 | +Aliases: |
| 141 | +Applicable: Exchange Online, Exchange Online Protection |
| 142 | +
|
| 143 | +Required: False |
| 144 | +Position: Named |
| 145 | +Default value: None |
| 146 | +Accept pipeline input: False |
| 147 | +Accept wildcard characters: False |
| 148 | +``` |
| 149 | + |
| 150 | +### -NoExpiration |
| 151 | +The NoExpiration switch filters the results by entries that are set to never expire. You don't need to specify a value with this switch. |
| 152 | + |
| 153 | +```yaml |
| 154 | +Type: SwitchParameter |
| 155 | +Parameter Sets: NoExpiration |
| 156 | +Aliases: |
| 157 | +Applicable: Exchange Online, Exchange Online Protection |
| 158 | +
|
| 159 | +Required: True |
| 160 | +Position: Named |
| 161 | +Default value: None |
| 162 | +Accept pipeline input: False |
| 163 | +Accept wildcard characters: False |
| 164 | +``` |
| 165 | + |
| 166 | +### -OutputJson |
| 167 | +The OutputJson switch specifies whether to return all entries in a single JSON value. You don't need to specify a value with this switch. |
| 168 | + |
| 169 | +You use this switch to prevent the command from halting on the first entry that contains a syntax error. |
| 170 | + |
| 171 | +```yaml |
| 172 | +Type: SwitchParameter |
| 173 | +Parameter Sets: (All) |
| 174 | +Aliases: |
| 175 | +Applicable: Exchange Online, Exchange Online Protection |
| 176 | +
|
| 177 | +Required: False |
| 178 | +Position: Named |
| 179 | +Default value: None |
| 180 | +Accept pipeline input: False |
| 181 | +Accept wildcard characters: False |
| 182 | +``` |
| 183 | + |
| 184 | +### CommonParameters |
| 185 | +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). |
| 186 | + |
| 187 | +## INPUTS |
| 188 | + |
| 189 | +### |
| 190 | + |
| 191 | +## OUTPUTS |
| 192 | + |
| 193 | +### |
| 194 | + |
| 195 | +## NOTES |
| 196 | + |
| 197 | +## RELATED LINKS |
0 commit comments