Skip to content

Commit 89c50cc

Browse files
committed
Update Search-Mailbox.md
Cmdlet now on-prem only per blind cmdlet sweep and VSO work item.
1 parent bd73135 commit 89c50cc

File tree

1 file changed

+18
-20
lines changed

1 file changed

+18
-20
lines changed

exchange/exchange-ps/exchange/Search-Mailbox.md

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
external help file: Microsoft.Exchange.RecordsandEdge-Help.xml
33
online version: https://learn.microsoft.com/powershell/module/exchange/search-mailbox
4-
applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
4+
applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
55
title: Search-Mailbox
66
schema: 2.0.0
77
author: chrisda
@@ -12,11 +12,11 @@ ms.reviewer:
1212
# Search-Mailbox
1313

1414
## SYNOPSIS
15-
This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.
15+
This cmdlet is available only in on-premises Exchange.
1616

1717
Use the Search-Mailbox cmdlet to search a mailbox and copy the results to a specified target mailbox, delete messages from the source mailbox, or both.
1818

19-
**Note**: In cloud-based environments, the Search-Mailbox cmdlet is being deprecated in favor of [New-ComplianceSearch](https://learn.microsoft.com/powershell/module/exchange/new-compliancesearch) and related eDiscovery cmdlets.
19+
**Note**: In cloud-based environments, the Search-Mailbox cmdlet was deprecated in favor of [New-ComplianceSearch](https://learn.microsoft.com/powershell/module/exchange/new-compliancesearch) and related eDiscovery cmdlets.
2020

2121
By default, Search-Mailbox is available only in the Mailbox Search or Mailbox Import Export roles, and these roles aren't assigned to *any* role groups. To use this cmdlet, you need to add one or both of the roles to a role group (for example, the Organization Management role group). Only the Mailbox Import Export role gives you access to the DeleteContent parameter. For more information about adding roles to role groups, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group).
2222

@@ -132,7 +132,7 @@ The Identity parameter specifies the identity of the mailbox to search. You can
132132
Type: MailboxOrMailUserIdParameter
133133
Parameter Sets: (All)
134134
Aliases:
135-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
135+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
136136

137137
Required: True
138138
Position: 1
@@ -150,7 +150,7 @@ You can't use this switch with the TargetMailbox parameter.
150150
Type: SwitchParameter
151151
Parameter Sets: EstimateResult
152152
Aliases:
153-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
153+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
154154

155155
Required: True
156156
Position: Named
@@ -166,7 +166,7 @@ The TargetFolder parameter specifies a folder name in which search results are s
166166
Type: String
167167
Parameter Sets: Mailbox
168168
Aliases:
169-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
169+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
170170

171171
Required: True
172172
Position: Named
@@ -195,7 +195,7 @@ You must use this parameter with the TargetFolder parameter. You can't use this
195195
Type: MailboxIdParameter
196196
Parameter Sets: Mailbox
197197
Aliases:
198-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
198+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
199199

200200
Required: True
201201
Position: Named
@@ -214,7 +214,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho
214214
Type: SwitchParameter
215215
Parameter Sets: (All)
216216
Aliases: cf
217-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
217+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
218218
219219
Required: False
220220
Position: Named
@@ -236,7 +236,7 @@ Before you use the DeleteContent switch to delete content, we recommend that you
236236
Type: SwitchParameter
237237
Parameter Sets: Mailbox, Identity
238238
Aliases:
239-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
239+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
240240
241241
Required: False
242242
Position: Named
@@ -246,8 +246,6 @@ Accept wildcard characters: False
246246
```
247247

248248
### -DomainController
249-
This parameter is available only in on-premises Exchange.
250-
251249
The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.
252250

253251
```yaml
@@ -274,7 +272,7 @@ If auto-expanding archiving is enabled for an Exchange Online mailbox, only the
274272
Type: SwitchParameter
275273
Parameter Sets: (All)
276274
Aliases:
277-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
275+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
278276
279277
Required: False
280278
Position: Named
@@ -292,7 +290,7 @@ Use this switch to hide the confirmation prompt when you use the DeleteContent s
292290
Type: SwitchParameter
293291
Parameter Sets: (All)
294292
Aliases:
295-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
293+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
296294
297295
Required: False
298296
Position: Named
@@ -308,7 +306,7 @@ The IncludeUnsearchableItems switch includes items that couldn't be indexed by E
308306
Type: SwitchParameter
309307
Parameter Sets: (All)
310308
Aliases:
311-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
309+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
312310
313311
Required: False
314312
Position: Named
@@ -332,7 +330,7 @@ When you included this parameter, an email message is created and sent to the ma
332330
Type: LoggingLevel
333331
Parameter Sets: Mailbox
334332
Aliases:
335-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
333+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
336334
337335
Required: False
338336
Position: Named
@@ -350,7 +348,7 @@ The logging level is specified by using the LogLevel parameter.
350348
Type: SwitchParameter
351349
Parameter Sets: Mailbox
352350
Aliases:
353-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
351+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
354352
355353
Required: False
356354
Position: Named
@@ -368,7 +366,7 @@ By default, the Recoverable Items folder is always included in the search. To ex
368366
Type: SwitchParameter
369367
Parameter Sets: (All)
370368
Aliases:
371-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
369+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
372370
373371
Required: False
374372
Position: Named
@@ -388,7 +386,7 @@ You can also use this switch with the DeleteContent switch to delete messages fr
388386
Type: SwitchParameter
389387
Parameter Sets: (All)
390388
Aliases:
391-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
389+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
392390
393391
Required: False
394392
Position: Named
@@ -408,7 +406,7 @@ If this parameter is empty, all messages are returned.
408406
Type: String
409407
Parameter Sets: (All)
410408
Aliases:
411-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
409+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
412410
413411
Required: False
414412
Position: Named
@@ -424,7 +422,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch
424422
Type: SwitchParameter
425423
Parameter Sets: (All)
426424
Aliases: wi
427-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
425+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
428426
429427
Required: False
430428
Position: Named

0 commit comments

Comments
 (0)