Skip to content

Commit 7d936eb

Browse files
authored
Merge pull request #10924 from v-smandalika/v-smandalika-7987046
OfficeDocs Powershell - v-smandalika - 7987046 - removed an incorrect syntax and replaced it
2 parents 71f5ddf + 3643c5d commit 7d936eb

File tree

1 file changed

+35
-36
lines changed

1 file changed

+35
-36
lines changed

exchange/exchange-ps/exchange/New-PublicFolderMoveRequest.md

Lines changed: 35 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ ms.reviewer:
1212
# New-PublicFolderMoveRequest
1313

1414
## SYNOPSIS
15-
This cmdlet is available only in on-premises Exchange.
15+
The `New-PublicFolderMoveRequest` cmdlet is available only in on-premises Exchange.
1616

17-
Use the New-PublicFolderMoveRequest cmdlet to begin the process of moving public folder contents between public folder mailboxes. Moving public folders only moves the physical contents of the public folder; it doesn't change the logical hierarchy. When the move request is completed, you must run the Remove-PublicFolderMoveRequest cmdlet to remove the request or wait until the time specified in the CompletedRequestAgeLimit parameter has passed. The request must be removed before you can run another move request.
17+
Use the `New-PublicFolderMoveRequest` cmdlet to begin the process of moving public folder contents between public folder mailboxes. Moving public folders only moves the physical contents of the public folder; it doesn't change the logical hierarchy. When the move request is completed, you must run the `Remove-PublicFolderMoveRequest` cmdlet to remove the request or wait until the time specified in the **CompletedRequestAgeLimit** parameter has passed. The request must be removed before you can run another move request.
1818

19-
Be aware that the target public folder mailbox will be locked while the move request is active. See the Detailed Description section below for more details.
19+
Be aware that the target public folder mailbox will be locked while the move request is active. For more information, see the Detailed Description section below.
2020

2121
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
2222

@@ -43,9 +43,9 @@ New-PublicFolderMoveRequest -Folders <PublicFolderIdParameter[]> -TargetMailbox
4343
```
4444

4545
## DESCRIPTION
46-
The New-PublicFolderMoveRequest cmdlet moves public folders from a source public folder mailbox to a target public folder mailbox. While the move request is active, the target public folder mailbox will be locked. As a result, public folders already residing in the target public folder mailbox will be inaccessible until the move request is complete. Therefore, before you begin the move request, you should make sure no users are accessing public folder data in that target public folder mailbox.
46+
The `New-PublicFolderMoveRequest` cmdlet moves public folders from a source public folder mailbox to a target public folder mailbox. While the move request is active, the target public folder mailbox will be locked. As a result, public folders already residing in the target public folder mailbox will be inaccessible until the move request is complete. Therefore, before you begin the move request, you should ensure that no users are accessing public folder data in that target public folder mailbox.
4747

48-
To move the public folder mailbox to another mailbox database, use the New-MoveRequest cmdlet. To ensure that this folder is already in the target public folder mailbox, run the Update-PublicFolderMailbox cmdlet against the target public folder mailbox. You can only perform one move request at a time. You can also move public folders by using the Move-PublicFolderBranch.ps1 script.
48+
To move the public folder mailbox to another mailbox database, use the `New-MoveRequest` cmdlet. To ensure that this folder is already in the target public folder mailbox, run the `Update-PublicFolderMailbox` cmdlet against the target public folder mailbox. You can only perform one move request at a time. You can also move public folders by using the Move-PublicFolderBranch.ps1 script.
4949

5050
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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions).
5151

@@ -69,16 +69,15 @@ You can also move a branch of public folders by using the Move-PublicFolderBranc
6969

7070
### Example 3
7171
```powershell
72-
$folders = Get-PublicFolder \ -Recurse -Mailbox PUB1 -ResidentFolders | ?{$_.Name -ne "IPM_SUBTREE"} | %{$_.Identity}
73-
New-PublicFolderMoveRequest -TargetMailbox PUB2 -Folders $folders
72+
$folders = Get-PublicFolder \ -Recurse -Mailbox PUB1 -ResidentFolders | ?{$_.Name -ne "IPM_SUBTREE"} | %{$_.Identity}; New-PublicFolderMoveRequest -TargetMailbox PUB2 -Folders $folders
7473
```
7574

7675
This example moves all public folders from public folder mailbox Pub1 to public folder mailbox Pub2.
7776

7877
## PARAMETERS
7978

8079
### -Folders
81-
The Folders parameter specifies the public folders that you want to move. If the public folder has child public folders, child public folders won't be moved unless you explicitly state them in the command. You can move multiple public folders by separating them with a comma, for example, \\Dev\\CustomerEngagements,\\Dev\\RequestsforChange,\\Dev\\Usability.
80+
The **Folders** parameter specifies the public folders that you want to move. If the public folder has child public folders, these child public folders won't be moved unless you explicitly state them in the command. You can move multiple public folders by separating them with a comma, for example, \\Dev\\CustomerEngagements,\\Dev\\RequestsforChange,\\Dev\\Usability.
8281

8382
```yaml
8483
Type: PublicFolderIdParameter[]
@@ -94,7 +93,7 @@ Accept wildcard characters: False
9493
```
9594
9695
### -TargetMailbox
97-
The TargetMailbox parameter specifies the target public folder mailbox that you want to move the public folders to. You can use any value that uniquely identifies the mailbox. For example:
96+
The **TargetMailbox** parameter specifies the target public folder mailbox that you want to move the public folders to. You can use any value that uniquely identifies the mailbox. For example:
9897
9998
- Name
10099
- Alias
@@ -121,9 +120,9 @@ Accept wildcard characters: False
121120
```
122121
123122
### -AcceptLargeDataLoss
124-
The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch.
123+
The **AcceptLargeDataLoss** switch specifies that the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch.
125124
126-
You need to use this switch if you set the LargeItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail.
125+
You need to use this switch if you set the **LargeItemLimit** parameter to a value of **51** or higher. Otherwise, the command will fail.
127126
128127
```yaml
129128
Type: SwitchParameter
@@ -139,7 +138,7 @@ Accept wildcard characters: False
139138
```
140139
141140
### -AllowLargeItems
142-
The AllowLargeItems switch specifies that you can move large items only when large items are encountered. You don't need to specify a value with this switch.
141+
The **AllowLargeItems** switch specifies that you can move large items only when they're encountered. You don't need to specify a value with this switch.
143142
144143
Large items are email messages with a maximum of 1,023 attachments.
145144
@@ -157,9 +156,9 @@ Accept wildcard characters: False
157156
```
158157
159158
### -BadItemLimit
160-
The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete.
159+
The **BadItemLimit** parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to be completed.
161160
162-
Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the request again.
161+
Valid input for this parameter is an integer or the value **unlimited**. The default value is **0**, which means that the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend **10** or lower) so that the request can proceed. If too many bad items are detected, consider using the `New-MailboxRepairRequest` cmdlet to attempt to fix corrupted items in the source mailbox, and then try the request again.
163162

164163
```yaml
165164
Type: Unlimited
@@ -175,7 +174,7 @@ Accept wildcard characters: False
175174
```
176175

177176
### -CompletedRequestAgeLimit
178-
The CompletedRequestAgeLimit parameter specifies how long the request will be kept after it has completed before being automatically removed. The default CompletedRequestAgeLimit parameter value is 30 days.
177+
The **CompletedRequestAgeLimit** parameter specifies how long the request will be kept after it has been completed before being automatically removed. The default value for this parameter is **30 days**.
179178

180179
```yaml
181180
Type: Unlimited
@@ -191,10 +190,10 @@ Accept wildcard characters: False
191190
```
192191

193192
### -Confirm
194-
The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.
193+
The **Confirm** switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding.
195194

196-
- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`.
197-
- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.
195+
- Destructive cmdlets (for example, `Remove-\*` cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`.
196+
- Most other cmdlets (for example, `New-\*` and `Set-\*` cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you to acknowledge the command before proceeding.
198197

199198
```yaml
200199
Type: SwitchParameter
@@ -210,7 +209,7 @@ Accept wildcard characters: False
210209
```
211210

212211
### -DomainController
213-
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.
212+
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.
214213

215214
```yaml
216215
Type: Fqdn
@@ -226,7 +225,7 @@ Accept wildcard characters: False
226225
```
227226

228227
### -InternalFlags
229-
The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes.
228+
The **InternalFlags** parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes.
230229

231230
```yaml
232231
Type: InternalMrsFlag[]
@@ -242,7 +241,7 @@ Accept wildcard characters: False
242241
```
243242

244243
### -Name
245-
The Name parameter specifies the name of the public folder move request. If you don't specify a name, the default name is PublicFolderMove.
244+
The **Name** parameter specifies the name of the public folder move request. If you don't specify a name, the default name is **PublicFolderMove**.
246245

247246
```yaml
248247
Type: String
@@ -258,7 +257,7 @@ Accept wildcard characters: False
258257
```
259258

260259
### -Priority
261-
The Priority parameter specifies the order in which the request should be processed in the request queue. Requests are processed in order, based on server health, status, priority, and last update time. Valid priority values are:
260+
The **Priority** parameter specifies the order in which the request should be processed in the request queue. Requests are processed in order, based on server health, status, priority, and last update time. Valid priority values are:
262261

263262
- Lowest
264263
- Lower
@@ -283,14 +282,14 @@ Accept wildcard characters: False
283282
```
284283

285284
### -RequestExpiryInterval
286-
The RequestExpiryInterval parameter specifies an age limit for a completed or failed request. When you use this parameter, the completed or failed request is automatically removed after the specified interval expires. If you don't use this parameter:
285+
The **RequestExpiryInterval** parameter specifies an age limit for a completed or failed request. When you use this parameter, the completed or failed request is automatically removed after the specified interval expires. If you don't use this parameter:
287286

288-
- The completed request is automatically removed based on the CompletedRequestAgeLimit parameter value.
289-
- If the request fails, you need to manually remove it by using the corresponding Remove-\*Request cmdlet.
287+
- The completed request is automatically removed based on the **CompletedRequestAgeLimit** parameter value.
288+
- If the request fails, you need to manually remove it by using the corresponding `Remove-\*Request` cmdlet.
290289

291290
To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds.
292291

293-
When you use the value Unlimited, the completed request isn't automatically removed.
292+
When you use the value **Unlimited**, the completed request isn't automatically removed.
294293

295294
```yaml
296295
Type: Unlimited
@@ -306,9 +305,9 @@ Accept wildcard characters: False
306305
```
307306

308307
### -Suspend
309-
The Suspend switch specifies whether to suspend the request. You don't need to specify a value with this switch.
308+
The **Suspend** switch specifies whether or not to suspend the request. You don't need to specify a value with this switch.
310309

311-
If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet.
310+
If you use this switch, the request is queued, but the request won't reach the status of **InProgress** until you resume the request with the relevant resume cmdlet.
312311

313312
```yaml
314313
Type: SwitchParameter
@@ -324,7 +323,7 @@ Accept wildcard characters: False
324323
```
325324

326325
### -SuspendComment
327-
The SuspendComment parameter specifies a description about why the request was suspended. You can only use this parameter if you specify the Suspend parameter.
326+
The **SuspendComment** parameter specifies a description about why the request was suspended. You can only use this parameter if you specify the **Suspend** parameter.
328327

329328
```yaml
330329
Type: String
@@ -340,9 +339,9 @@ Accept wildcard characters: False
340339
```
341340

342341
### -SuspendWhenReadyToComplete
343-
The SuspendWhenReadyToComplete switch specifies whether to suspend the request before it reaches the status of CompletionInProgress. You don't need to specify a value with this switch.
342+
The **SuspendWhenReadyToComplete** switch specifies whether or not to suspend the request before it reaches the status of **CompletionInProgress**. You don't need to specify a value with this switch.
344343

345-
After the move is suspended, it has a status of AutoSuspended. You can then manually complete the move by using the Resume-PublicFolderMoveRequest command.
344+
After the move is suspended, it has a status of **AutoSuspended**. You can then manually complete the move by using the `Resume-PublicFolderMoveRequest` command.
346345

347346
```yaml
348347
Type: SwitchParameter
@@ -358,7 +357,7 @@ Accept wildcard characters: False
358357
```
359358

360359
### -WhatIf
361-
The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.
360+
The **WhatIf** switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.
362361

363362
```yaml
364363
Type: SwitchParameter
@@ -374,7 +373,7 @@ Accept wildcard characters: False
374373
```
375374

376375
### -WorkloadType
377-
This parameter is reserved for internal Microsoft use.
376+
The **WorkloadType** parameter is reserved for internal Microsoft use.
378377

379378
```yaml
380379
Type: RequestWorkloadType
@@ -390,17 +389,17 @@ Accept wildcard characters: False
390389
```
391390

392391
### CommonParameters
393-
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).
392+
The `CommonParameters` 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).
394393

395394
## INPUTS
396395

397396
### Input types
398-
To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data.
397+
To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the **Input Type** field for a cmdlet is blank, the cmdlet doesn't accept input data.
399398

400399
## OUTPUTS
401400

402401
### Output types
403-
To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data.
402+
To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the **Output Type** field is blank, the cmdlet doesn't return data.
404403

405404
## NOTES
406405

0 commit comments

Comments
 (0)