Merge branch 'master' into chrisda

Author: chrisda

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

@@ -21,9 +21,9 @@ For information about the parameter sets in the Syntax section below, see [Excha
 
 ## SYNTAX
 
-### Local
+### Onboarding
 ```
-New-MigrationBatch [-Local] -Name <String> -CSVData <Byte[]> [-DisallowExistingUsers] [-WorkloadType <Microsoft.Exchange.MailboxReplicationService.RequestWorkloadType>] [-WorkflowControlFlags <MigrationWorkflowControlFlags>]
+New-MigrationBatch -Name <String> [-CSVData <Byte[]>] [-DisallowExistingUsers] [-WorkflowControlFlags <MigrationWorkflowControlFlags>]
  [-AllowIncrementalSyncs <Boolean>]
  [-AllowUnknownColumnsInCsv <Boolean>]
  [-ArchiveOnly]
@@ -32,29 +32,39 @@ New-MigrationBatch [-Local] -Name <String> -CSVData <Byte[]> [-DisallowExistingU
  [-AutoStart]
  [-BadItemLimit <Unlimited>]
  [-CompleteAfter <DateTime>]
+ [-ContentFilter <String>]
+ [-ContentFilterLanguage <CultureInfo>]
  [-Confirm]
  [-DomainController <Fqdn>]
+ [-ExcludeDumpsters]
+ [-ExcludeFolders <MultiValuedProperty>]
+ [-IncludeFolders <MultiValuedProperty>]
+ [-LargeItemLimit <Unlimited>]
  [-Locale <CultureInfo>]
  [-MoveOptions <MultiValuedProperty>]
  [-NotificationEmails <MultiValuedProperty>]
  [-Partition <MailboxIdParameter>]
  [-PrimaryOnly]
  [-ReportInterval <Timespan>]
+ [-SkipMerging <MultiValuedProperty>]
  [-SkipMoving <MultiValuedProperty>]
  [-SkipReports]
  [-SkipSteps <SkippableMigrationSteps[]>]
+ [-SourceEndpoint <MigrationEndpointIdParameter>]
  [-StartAfter <DateTime>]
  [-TargetArchiveDatabases <MultiValuedProperty>]
  [-TargetDatabases <MultiValuedProperty>]
+ [-TargetDeliveryDomain <String>]
  [-TimeZone <ExTimeZoneValue>]
  [-WhatIf] [<CommonParameters>]
 ```
 
-### LocalPublicFolder
+### Offboarding
 ```
-New-MigrationBatch -Name <String> -CSVData <Byte[]> -SourcePublicFolderDatabase <DatabaseIdParameter>
+New-MigrationBatch -Name <String> -CSVData <Byte[]> [-DisallowExistingUsers]
  [-AllowIncrementalSyncs <Boolean>]
  [-AllowUnknownColumnsInCsv <Boolean>]
+ [-ArchiveOnly]
  [-AutoComplete]
  [-AutoRetryCount <Int32>]
  [-AutoStart]
@@ -64,126 +74,119 @@ New-MigrationBatch -Name <String> -CSVData <Byte[]> -SourcePublicFolderDatabase
  [-DomainController <Fqdn>]
  [-LargeItemLimit <Unlimited>]
  [-Locale <CultureInfo>]
+ [-MoveOptions <MultiValuedProperty>]
  [-NotificationEmails <MultiValuedProperty>]
  [-Partition <MailboxIdParameter>]
+ [-PrimaryOnly]
  [-ReportInterval <Timespan>]
  [-SkipMerging <MultiValuedProperty>]
+ [-SkipMoving <MultiValuedProperty>]
  [-SkipReports]
  [-SkipSteps <SkippableMigrationSteps[]>]
  [-StartAfter <DateTime>]
+ [-TargetArchiveDatabases <MultiValuedProperty>]
+ [-TargetDatabases <MultiValuedProperty>]
+ [-TargetDeliveryDomain <String>]
+ [-TargetEndpoint <MigrationEndpointIdParameter>]
  [-TimeZone <ExTimeZoneValue>]
  [-WhatIf] [<CommonParameters>]
 ```
 
-### PreexistingUserIds
+### Local
 ```
-New-MigrationBatch <MultiValuedProperty> -Name <String> [-UserIds]
+New-MigrationBatch [-Local] -Name <String> -CSVData <Byte[]> [-DisallowExistingUsers] [-WorkloadType <Microsoft.Exchange.MailboxReplicationService.RequestWorkloadType>] [-WorkflowControlFlags <MigrationWorkflowControlFlags>]
  [-AllowIncrementalSyncs <Boolean>]
  [-AllowUnknownColumnsInCsv <Boolean>]
+ [-ArchiveOnly]
  [-AutoComplete]
  [-AutoRetryCount <Int32>]
  [-AutoStart]
+ [-BadItemLimit <Unlimited>]
  [-CompleteAfter <DateTime>]
  [-Confirm]
- [-DisableOnCopy]
  [-DomainController <Fqdn>]
  [-Locale <CultureInfo>]
+ [-MoveOptions <MultiValuedProperty>]
  [-NotificationEmails <MultiValuedProperty>]
  [-Partition <MailboxIdParameter>]
+ [-PrimaryOnly]
  [-ReportInterval <Timespan>]
+ [-SkipMoving <MultiValuedProperty>]
  [-SkipReports]
  [-SkipSteps <SkippableMigrationSteps[]>]
  [-StartAfter <DateTime>]
+ [-TargetArchiveDatabases <MultiValuedProperty>]
+ [-TargetDatabases <MultiValuedProperty>]
  [-TimeZone <ExTimeZoneValue>]
  [-WhatIf] [<CommonParameters>]
 ```
 
-### Preexisting
+### LocalPublicFolder
 ```
-New-MigrationBatch -Name <String> [-Users] <MultiValuedProperty>
+New-MigrationBatch -Name <String> -CSVData <Byte[]> -SourcePublicFolderDatabase <DatabaseIdParameter>
  [-AllowIncrementalSyncs <Boolean>]
+ [-AllowUnknownColumnsInCsv <Boolean>]
  [-AutoComplete]
  [-AutoRetryCount <Int32>]
  [-AutoStart]
+ [-BadItemLimit <Unlimited>]
  [-CompleteAfter <DateTime>]
  [-Confirm]
- [-DisableOnCopy]
  [-DomainController <Fqdn>]
+ [-LargeItemLimit <Unlimited>]
  [-Locale <CultureInfo>]
  [-NotificationEmails <MultiValuedProperty>]
  [-Partition <MailboxIdParameter>]
  [-ReportInterval <Timespan>]
+ [-SkipMerging <MultiValuedProperty>]
  [-SkipReports]
  [-SkipSteps <SkippableMigrationSteps[]>]
  [-StartAfter <DateTime>]
  [-TimeZone <ExTimeZoneValue>]
  [-WhatIf] [<CommonParameters>]
 ```
 
-### Onboarding
+### PreexistingUserIds
 ```
-New-MigrationBatch -Name <String> [-CSVData <Byte[]>] [-DisallowExistingUsers] [-WorkflowControlFlags <MigrationWorkflowControlFlags>]
+New-MigrationBatch <MultiValuedProperty> -Name <String> [-UserIds]
  [-AllowIncrementalSyncs <Boolean>]
  [-AllowUnknownColumnsInCsv <Boolean>]
- [-ArchiveOnly]
  [-AutoComplete]
  [-AutoRetryCount <Int32>]
  [-AutoStart]
- [-BadItemLimit <Unlimited>]
  [-CompleteAfter <DateTime>]
  [-Confirm]
+ [-DisableOnCopy]
  [-DomainController <Fqdn>]
- [-ExcludeDumpsters]
- [-ExcludeFolders <MultiValuedProperty>]
- [-LargeItemLimit <Unlimited>]
  [-Locale <CultureInfo>]
- [-MoveOptions <MultiValuedProperty>]
  [-NotificationEmails <MultiValuedProperty>]
  [-Partition <MailboxIdParameter>]
- [-PrimaryOnly]
  [-ReportInterval <Timespan>]
- [-SkipMerging <MultiValuedProperty>]
- [-SkipMoving <MultiValuedProperty>]
  [-SkipReports]
  [-SkipSteps <SkippableMigrationSteps[]>]
- [-SourceEndpoint <MigrationEndpointIdParameter>]
  [-StartAfter <DateTime>]
- [-TargetArchiveDatabases <MultiValuedProperty>]
- [-TargetDatabases <MultiValuedProperty>]
- [-TargetDeliveryDomain <String>]
  [-TimeZone <ExTimeZoneValue>]
  [-WhatIf] [<CommonParameters>]
 ```
 
-### Offboarding
+### Preexisting
 ```
-New-MigrationBatch -Name <String> -CSVData <Byte[]> [-DisallowExistingUsers]
+New-MigrationBatch -Name <String> [-Users] <MultiValuedProperty>
  [-AllowIncrementalSyncs <Boolean>]
- [-AllowUnknownColumnsInCsv <Boolean>]
- [-ArchiveOnly]
  [-AutoComplete]
  [-AutoRetryCount <Int32>]
  [-AutoStart]
- [-BadItemLimit <Unlimited>]
  [-CompleteAfter <DateTime>]
  [-Confirm]
+ [-DisableOnCopy]
  [-DomainController <Fqdn>]
- [-LargeItemLimit <Unlimited>]
  [-Locale <CultureInfo>]
- [-MoveOptions <MultiValuedProperty>]
  [-NotificationEmails <MultiValuedProperty>]
  [-Partition <MailboxIdParameter>]
- [-PrimaryOnly]
  [-ReportInterval <Timespan>]
- [-SkipMerging <MultiValuedProperty>]
- [-SkipMoving <MultiValuedProperty>]
  [-SkipReports]
  [-SkipSteps <SkippableMigrationSteps[]>]
  [-StartAfter <DateTime>]
- [-TargetArchiveDatabases <MultiValuedProperty>]
- [-TargetDatabases <MultiValuedProperty>]
- [-TargetDeliveryDomain <String>]
- [-TargetEndpoint <MigrationEndpointIdParameter>]
  [-TimeZone <ExTimeZoneValue>]
  [-WhatIf] [<CommonParameters>]
 ```
@@ -258,7 +261,7 @@ Onboarding and offboarding in Exchange Online
 
 - IMAP migration: This onboarding migration type migrates mailbox data from an IMAP server (including Exchange) to Exchange Online. For an IMAP migration, you must first provision mailboxes in Exchange Online before you can migrate mailbox data. For more information, see Example 7.
 
-- G Suite migration: This onboarding migration type migrates mailbox data from a G Suite organization to Exchange Online.  For a G Suite migration, you must first provision mail users (or mailboxes) in Exchange Online before you can migrate mailbox data.
+- G Suite migration: This onboarding migration type migrates mailbox data from a G Suite organization to Exchange Online. For a G Suite migration, you must first provision mail users (or mailboxes) in Exchange Online before you can migrate mailbox data. For more information, see Example 10.
 
 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).
 
@@ -348,6 +351,18 @@ Start-MigrationBatch -Identity $OnboardingBatch.Identity
 
 This example is the same as Example 8, but the TimeZone parameter is also used. Data migration for the batch will start, but won't complete until 09/01/2018 7:00 PM (PST). This method allows you to start a migration and then leave it to complete after business hours if your time zone is Pacific Standard Time.
 
+### Example 10
+```powershell
+$MigrationEndpointGmail = New-MigrationEndpoint -Gmail -ServiceAccountKeyFileData $([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\gmailonboarding.json")) -EmailAddress [email protected] -Name GmailEndpoint; 
+$OnboardingBatch = New-MigrationBatch -SourceEndpoint $MigrationEndpointGmail.Identity -Name GmailBatch1 -CSVData $([System.IO.File]::ReadAll
+Bytes("C:\Users\Administrator\Desktop\gmail.csv")) -TargetDeliveryDomain "o365.contoso.com" -ContentFilter "Received -ge '2019/4/30'" -Inc
+ludeFolders "Payment"
+Start-MigrationBatch -Identity $OnboardingBatch.Identity
+```
+
+A G Suite migration batch is created that uses the CSV migration file gmail.csv and includes the contents of the Paymeng label and only migrate the mails which were received after the time '2019/4/30 00:00' (local system time). This migration batch is pending until it's started with the Start-MigrationBatch cmdlet.
+
+
 ## PARAMETERS
 
 ### -Name
@@ -669,6 +684,50 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -ContentFilter
+This parameter is available only in the cloud-based service.
+
+The ContentFilter parameter uses OPath filter syntax to filter the messages by Received date. Only content that match the ContentFilter parameter will be moved to Exchange online. For example:
+
+- `"Received -gt '8/23/2020'"`
+- `"Received -le '2019/01/01'"`
+- `"Received -gt '8/23/2015' -and Received -lt '8/23/2020'"`
+
+You can specify the language by using the ContentFilterLanguage parameter.
+
+```yaml
+Type: String
+Parameter Sets: Onboarding
+Aliases:
+Applicable: Exchange Online
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -ContentFilterLanguage
+This parameter is available only in the cloud-based service.
+
+The ContentFilterLanguage parameter specifies the language being used in the ContentFilter parameter for string searches.
+
+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).
+
+```yaml
+Type: CultureInfo
+Parameter Sets: Onboarding
+Aliases:
+Applicable: Exchange Online
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -DisableOnCopy
 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.
 
@@ -746,8 +805,85 @@ Accept wildcard characters: False
 ### -ExcludeFolders
 This parameter is available only in the cloud-based service.
 
-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.
+For an IMAP migration or G Suite migration, the ExcludeFolders parameter specifies mailbox folders that you don't want to migrate from the source email system to the cloud-based mailboxes. Specify the value as a string array and separate multiple folder names with commas.
+
+For IMAP migration, use folder names relative to the IMAP root on the source mail server. For G Suite migration, use label names on the source mail server.
+
+Folder names aren't case-sensitive, and there are no character restrictions. Use the following syntax:
+
+`<FolderName>/*`: Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, `MyProjects` or `MyProjects/FY2010`.
+
+`#<FolderName>#/*`: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, `#Inbox#` denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types:
+
+- Inbox
+- SentItems
+- DeletedItems
+- Calendar
+- Contacts
+- Drafts
+- Journal
+- Tasks
+- Notes
+- JunkEmail
+- CommunicatorHistory
+- Voicemail
+- Fax
+- Conflicts
+- SyncIssues
+- LocalFailures
+- ServerFailures
+
+If the user creates a personal folder with the same name as a well-known folder and the `#` symbol surrounding it, you can use a back slash (`\`) as an escape character to specify that folder. For example, if a user creates a folder named `#Notes#` and you want to specify that folder, but not the well-known Notes folder, use the following syntax: `\#Notes\#`.
+
+Wildcard characters can't be used in folder names.
+
+```yaml
+Type: MultiValuedProperty
+Parameter Sets: Onboarding
+Aliases:
+Applicable: Exchange Online
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -IncludeFolders
+This parameter is available only in the cloud-based service.
+
+For an IMAP migration or G Suite 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 source mail server or use label names for G Suite migration. Specify the value as a string array and separate multiple folder names with commas.
+
+For IMAP migration, use folder names relative to the IMAP root on the source mail server. For G Suite migration, use label names on the source mail server.
+
+Folder names aren't case-sensitive, and there are no character restrictions. Use the following syntax:
+
+`<FolderName>/*`: Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, `MyProjects` or `MyProjects/FY2010`.
+
+`#<FolderName>#/*`: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, `#Inbox#` denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types:
+
+- Inbox
+- SentItems
+- DeletedItems
+- Calendar
+- Contacts
+- Drafts
+- Journal
+- Tasks
+- Notes
+- JunkEmail
+- CommunicatorHistory
+- Voicemail
+- Fax
+- Conflicts
+- SyncIssues
+- LocalFailures
+- ServerFailures
+
+If the user creates a personal folder with the same name as a well-known folder and the `#` symbol surrounding it, you can use a back slash (`\`) as an escape character to specify that folder. For example, if a user creates a folder named `#Notes#` and you want to specify that folder, but not the well-known Notes folder, use the following syntax: `\#Notes\#`.
 
+Wildcard characters can't be used in folder names.
 ```yaml
 Type: MultiValuedProperty
 Parameter Sets: Onboarding