Skip to content

Commit 1bdb359

Browse files
committed
Update New-MigrationBatch.md
Added new ContentFilter, ContentFilterLanguage, and IncludeFolders parameters
1 parent 0d4899d commit 1bdb359

File tree

1 file changed

+113
-40
lines changed

1 file changed

+113
-40
lines changed

exchange/exchange-ps/exchange/New-MigrationBatch.md

Lines changed: 113 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ For information about the parameter sets in the Syntax section below, see [Excha
2121

2222
## SYNTAX
2323

24-
### Local
24+
### Onboarding
2525
```
26-
New-MigrationBatch [-Local] -Name <String> -CSVData <Byte[]> [-DisallowExistingUsers] [-WorkloadType <Microsoft.Exchange.MailboxReplicationService.RequestWorkloadType>] [-WorkflowControlFlags <MigrationWorkflowControlFlags>]
26+
New-MigrationBatch -Name <String> [-CSVData <Byte[]>] [-DisallowExistingUsers] [-WorkflowControlFlags <MigrationWorkflowControlFlags>]
2727
[-AllowIncrementalSyncs <Boolean>]
2828
[-AllowUnknownColumnsInCsv <Boolean>]
2929
[-ArchiveOnly]
@@ -32,29 +32,39 @@ New-MigrationBatch [-Local] -Name <String> -CSVData <Byte[]> [-DisallowExistingU
3232
[-AutoStart]
3333
[-BadItemLimit <Unlimited>]
3434
[-CompleteAfter <DateTime>]
35+
[-ContentFilter <String>]
36+
[-ContentFilterLanguage <CultureInfo>]
3537
[-Confirm]
3638
[-DomainController <Fqdn>]
39+
[-ExcludeDumpsters]
40+
[-ExcludeFolders <MultiValuedProperty>]
41+
[-IncludeFolders <MultiValuedProperty>]
42+
[-LargeItemLimit <Unlimited>]
3743
[-Locale <CultureInfo>]
3844
[-MoveOptions <MultiValuedProperty>]
3945
[-NotificationEmails <MultiValuedProperty>]
4046
[-Partition <MailboxIdParameter>]
4147
[-PrimaryOnly]
4248
[-ReportInterval <Timespan>]
49+
[-SkipMerging <MultiValuedProperty>]
4350
[-SkipMoving <MultiValuedProperty>]
4451
[-SkipReports]
4552
[-SkipSteps <SkippableMigrationSteps[]>]
53+
[-SourceEndpoint <MigrationEndpointIdParameter>]
4654
[-StartAfter <DateTime>]
4755
[-TargetArchiveDatabases <MultiValuedProperty>]
4856
[-TargetDatabases <MultiValuedProperty>]
57+
[-TargetDeliveryDomain <String>]
4958
[-TimeZone <ExTimeZoneValue>]
5059
[-WhatIf] [<CommonParameters>]
5160
```
5261

53-
### LocalPublicFolder
62+
### Offboarding
5463
```
55-
New-MigrationBatch -Name <String> -CSVData <Byte[]> -SourcePublicFolderDatabase <DatabaseIdParameter>
64+
New-MigrationBatch -Name <String> -CSVData <Byte[]> [-DisallowExistingUsers]
5665
[-AllowIncrementalSyncs <Boolean>]
5766
[-AllowUnknownColumnsInCsv <Boolean>]
67+
[-ArchiveOnly]
5868
[-AutoComplete]
5969
[-AutoRetryCount <Int32>]
6070
[-AutoStart]
@@ -64,126 +74,119 @@ New-MigrationBatch -Name <String> -CSVData <Byte[]> -SourcePublicFolderDatabase
6474
[-DomainController <Fqdn>]
6575
[-LargeItemLimit <Unlimited>]
6676
[-Locale <CultureInfo>]
77+
[-MoveOptions <MultiValuedProperty>]
6778
[-NotificationEmails <MultiValuedProperty>]
6879
[-Partition <MailboxIdParameter>]
80+
[-PrimaryOnly]
6981
[-ReportInterval <Timespan>]
7082
[-SkipMerging <MultiValuedProperty>]
83+
[-SkipMoving <MultiValuedProperty>]
7184
[-SkipReports]
7285
[-SkipSteps <SkippableMigrationSteps[]>]
7386
[-StartAfter <DateTime>]
87+
[-TargetArchiveDatabases <MultiValuedProperty>]
88+
[-TargetDatabases <MultiValuedProperty>]
89+
[-TargetDeliveryDomain <String>]
90+
[-TargetEndpoint <MigrationEndpointIdParameter>]
7491
[-TimeZone <ExTimeZoneValue>]
7592
[-WhatIf] [<CommonParameters>]
7693
```
7794

78-
### PreexistingUserIds
95+
### Local
7996
```
80-
New-MigrationBatch <MultiValuedProperty> -Name <String> [-UserIds]
97+
New-MigrationBatch [-Local] -Name <String> -CSVData <Byte[]> [-DisallowExistingUsers] [-WorkloadType <Microsoft.Exchange.MailboxReplicationService.RequestWorkloadType>] [-WorkflowControlFlags <MigrationWorkflowControlFlags>]
8198
[-AllowIncrementalSyncs <Boolean>]
8299
[-AllowUnknownColumnsInCsv <Boolean>]
100+
[-ArchiveOnly]
83101
[-AutoComplete]
84102
[-AutoRetryCount <Int32>]
85103
[-AutoStart]
104+
[-BadItemLimit <Unlimited>]
86105
[-CompleteAfter <DateTime>]
87106
[-Confirm]
88-
[-DisableOnCopy]
89107
[-DomainController <Fqdn>]
90108
[-Locale <CultureInfo>]
109+
[-MoveOptions <MultiValuedProperty>]
91110
[-NotificationEmails <MultiValuedProperty>]
92111
[-Partition <MailboxIdParameter>]
112+
[-PrimaryOnly]
93113
[-ReportInterval <Timespan>]
114+
[-SkipMoving <MultiValuedProperty>]
94115
[-SkipReports]
95116
[-SkipSteps <SkippableMigrationSteps[]>]
96117
[-StartAfter <DateTime>]
118+
[-TargetArchiveDatabases <MultiValuedProperty>]
119+
[-TargetDatabases <MultiValuedProperty>]
97120
[-TimeZone <ExTimeZoneValue>]
98121
[-WhatIf] [<CommonParameters>]
99122
```
100123

101-
### Preexisting
124+
### LocalPublicFolder
102125
```
103-
New-MigrationBatch -Name <String> [-Users] <MultiValuedProperty>
126+
New-MigrationBatch -Name <String> -CSVData <Byte[]> -SourcePublicFolderDatabase <DatabaseIdParameter>
104127
[-AllowIncrementalSyncs <Boolean>]
128+
[-AllowUnknownColumnsInCsv <Boolean>]
105129
[-AutoComplete]
106130
[-AutoRetryCount <Int32>]
107131
[-AutoStart]
132+
[-BadItemLimit <Unlimited>]
108133
[-CompleteAfter <DateTime>]
109134
[-Confirm]
110-
[-DisableOnCopy]
111135
[-DomainController <Fqdn>]
136+
[-LargeItemLimit <Unlimited>]
112137
[-Locale <CultureInfo>]
113138
[-NotificationEmails <MultiValuedProperty>]
114139
[-Partition <MailboxIdParameter>]
115140
[-ReportInterval <Timespan>]
141+
[-SkipMerging <MultiValuedProperty>]
116142
[-SkipReports]
117143
[-SkipSteps <SkippableMigrationSteps[]>]
118144
[-StartAfter <DateTime>]
119145
[-TimeZone <ExTimeZoneValue>]
120146
[-WhatIf] [<CommonParameters>]
121147
```
122148

123-
### Onboarding
149+
### PreexistingUserIds
124150
```
125-
New-MigrationBatch -Name <String> [-CSVData <Byte[]>] [-DisallowExistingUsers] [-WorkflowControlFlags <MigrationWorkflowControlFlags>]
151+
New-MigrationBatch <MultiValuedProperty> -Name <String> [-UserIds]
126152
[-AllowIncrementalSyncs <Boolean>]
127153
[-AllowUnknownColumnsInCsv <Boolean>]
128-
[-ArchiveOnly]
129154
[-AutoComplete]
130155
[-AutoRetryCount <Int32>]
131156
[-AutoStart]
132-
[-BadItemLimit <Unlimited>]
133157
[-CompleteAfter <DateTime>]
134158
[-Confirm]
159+
[-DisableOnCopy]
135160
[-DomainController <Fqdn>]
136-
[-ExcludeDumpsters]
137-
[-ExcludeFolders <MultiValuedProperty>]
138-
[-LargeItemLimit <Unlimited>]
139161
[-Locale <CultureInfo>]
140-
[-MoveOptions <MultiValuedProperty>]
141162
[-NotificationEmails <MultiValuedProperty>]
142163
[-Partition <MailboxIdParameter>]
143-
[-PrimaryOnly]
144164
[-ReportInterval <Timespan>]
145-
[-SkipMerging <MultiValuedProperty>]
146-
[-SkipMoving <MultiValuedProperty>]
147165
[-SkipReports]
148166
[-SkipSteps <SkippableMigrationSteps[]>]
149-
[-SourceEndpoint <MigrationEndpointIdParameter>]
150167
[-StartAfter <DateTime>]
151-
[-TargetArchiveDatabases <MultiValuedProperty>]
152-
[-TargetDatabases <MultiValuedProperty>]
153-
[-TargetDeliveryDomain <String>]
154168
[-TimeZone <ExTimeZoneValue>]
155169
[-WhatIf] [<CommonParameters>]
156170
```
157171

158-
### Offboarding
172+
### Preexisting
159173
```
160-
New-MigrationBatch -Name <String> -CSVData <Byte[]> [-DisallowExistingUsers]
174+
New-MigrationBatch -Name <String> [-Users] <MultiValuedProperty>
161175
[-AllowIncrementalSyncs <Boolean>]
162-
[-AllowUnknownColumnsInCsv <Boolean>]
163-
[-ArchiveOnly]
164176
[-AutoComplete]
165177
[-AutoRetryCount <Int32>]
166178
[-AutoStart]
167-
[-BadItemLimit <Unlimited>]
168179
[-CompleteAfter <DateTime>]
169180
[-Confirm]
181+
[-DisableOnCopy]
170182
[-DomainController <Fqdn>]
171-
[-LargeItemLimit <Unlimited>]
172183
[-Locale <CultureInfo>]
173-
[-MoveOptions <MultiValuedProperty>]
174184
[-NotificationEmails <MultiValuedProperty>]
175185
[-Partition <MailboxIdParameter>]
176-
[-PrimaryOnly]
177186
[-ReportInterval <Timespan>]
178-
[-SkipMerging <MultiValuedProperty>]
179-
[-SkipMoving <MultiValuedProperty>]
180187
[-SkipReports]
181188
[-SkipSteps <SkippableMigrationSteps[]>]
182189
[-StartAfter <DateTime>]
183-
[-TargetArchiveDatabases <MultiValuedProperty>]
184-
[-TargetDatabases <MultiValuedProperty>]
185-
[-TargetDeliveryDomain <String>]
186-
[-TargetEndpoint <MigrationEndpointIdParameter>]
187190
[-TimeZone <ExTimeZoneValue>]
188191
[-WhatIf] [<CommonParameters>]
189192
```
@@ -669,6 +672,58 @@ Accept pipeline input: False
669672
Accept wildcard characters: False
670673
```
671674

675+
### -ContentFilter
676+
This parameter is available only in the cloud-based service.
677+
678+
The ContentFilter parameter uses OPath filter syntax to filter the results by the specified properties and values. Only contents that match the ContentFilter parameter will be exported into the .pst file. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`.
679+
680+
- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables.
681+
682+
- Property is a filterable property. For filterable properties, see [Filterable properties for the ContentFilter parameter](https://docs.microsoft.com/exchange/filterable-properties-for-the-contentfilter-parameter).
683+
684+
- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators).
685+
686+
- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`).
687+
688+
You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`.
689+
690+
For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information).
691+
692+
You can specify the language of the filter by using the ContentFilterLanguage parameter.
693+
694+
```yaml
695+
Type: String
696+
Parameter Sets: Onboarding
697+
Aliases:
698+
Applicable: Exchange Online
699+
700+
Required: False
701+
Position: Named
702+
Default value: None
703+
Accept pipeline input: False
704+
Accept wildcard characters: False
705+
```
706+
707+
### -ContentFilterLanguage
708+
This parameter is available only in the cloud-based service.
709+
710+
The ContentFilterLanguage parameter specifies the language for the ContentFilter parameter.
711+
712+
Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo).
713+
714+
```yaml
715+
Type: CultureInfo
716+
Parameter Sets: Onboarding
717+
Aliases:
718+
Applicable: Exchange Online
719+
720+
Required: False
721+
Position: Named
722+
Default value: None
723+
Accept pipeline input: False
724+
Accept wildcard characters: False
725+
```
726+
672727
### -DisableOnCopy
673728
The DisableOnCopy switch disables the original migration job item for a user if you're copying users from an existing batch to a new batch by using the UserIds or Users parameters.. You don't need to specify a value with this switch.
674729

@@ -746,7 +801,25 @@ Accept wildcard characters: False
746801
### -ExcludeFolders
747802
This parameter is available only in the cloud-based service.
748803

749-
For an IMAP migration, the ExcludeFolders parameter specifies mailbox folders that you don't want to migrate from the on-premises messaging system to the cloud-based mailboxes. Use folder names relative to the IMAP root on the on-premises mail server. Specify the value as a string array and separate multiple folder names with commas.
804+
For an IMAP migration, the ExcludeFolders parameter specifies mailbox folders that you don't want to migrate from the on-premises email system to the cloud-based mailboxes. Use folder names relative to the IMAP root on the on-premises mail server. Specify the value as a string array and separate multiple folder names with commas.
805+
806+
```yaml
807+
Type: MultiValuedProperty
808+
Parameter Sets: Onboarding
809+
Aliases:
810+
Applicable: Exchange Online
811+
812+
Required: False
813+
Position: Named
814+
Default value: None
815+
Accept pipeline input: False
816+
Accept wildcard characters: False
817+
```
818+
819+
### -IncludeFolders
820+
This parameter is available only in the cloud-based service.
821+
822+
For an IMAP migration, the IncludeFolders parameter specifies mailbox folders that you want to migrate from the on-premises email system to the cloud-based mailboxes. Use folder names relative to the IMAP root on the on-premises mail server. Specify the value as a string array and separate multiple folder names with commas.
750823

751824
```yaml
752825
Type: MultiValuedProperty

0 commit comments

Comments
 (0)