Skip to content

Commit 30abe15

Browse files
authored
Merge pull request MicrosoftDocs#6209 from dariomws/patch-191
Added more detail about DateTime parameters to Set/New-MigrationBatch.md
2 parents 331b618 + 91a9927 commit 30abe15

File tree

3 files changed

+34
-26
lines changed

3 files changed

+34
-26
lines changed

exchange/exchange-ps/exchange/Get-MigrationBatch.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,12 @@ The Get-MigrationBatch cmdlet displays status information about the current migr
5858

5959
- Migration errors
6060

61-
- Date and time when the migration was started
61+
- Date and time when the migration was started and completed.
6262

6363
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).
6464

65+
**Note**: In the cloud-based service, if you don't use the TimeZone parameter in the New-MigrationBatch command, the default time zone for the migration batch is UTC. The CompleteAfter and CompleteAfterUTC properties will contain the same value (as will the StartAfter and StartAfterUTC properties). When you create the migration batch in the Exchange admin center (EAC), the time zone that's used is based on your regional configuration.
66+
6567
## EXAMPLES
6668

6769
### Example 1

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

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -336,7 +336,17 @@ $OnboardingBatch = New-MigrationBatch -Name RemoteOnBoarding1 -SourceEndpoint $M
336336
Start-MigrationBatch -Identity $OnboardingBatch.Identity
337337
```
338338

339-
This example is the same as Example 3, but the CompleteAfter parameter is also used. Data migration for the batch will start, but won't complete until 09/01/2018 7:00 PM. This method allows you to start a migration and then leave it to complete after business hours.
339+
This example is the same as Example 3, but the CompleteAfter parameter is also used. Data migration for the batch will start, but won't complete until 09/01/2018 7:00 PM (UTC). This method allows you to start a migration and then leave it to complete after business hours if your time zone is Coordinated Universal Time.
340+
341+
### Example 9
342+
```powershell
343+
$Credentials = Get-Credential;
344+
$MigrationEndpointOnPrem = New-MigrationEndpoint -ExchangeRemoteMove -Name OnpremEndpoint -Autodiscover -EmailAddress [email protected] -Credentials $Credentials;
345+
$OnboardingBatch = New-MigrationBatch -Name RemoteOnBoarding1 -SourceEndpoint $MigrationEndpointOnprem.Identity -TargetDeliveryDomain cloud.contoso.com -CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\RemoteOnBoarding1.csv")) -CompleteAfter "09/01/2018 7:00 PM" -TimeZone "Pacific Standard Time";
346+
Start-MigrationBatch -Identity $OnboardingBatch.Identity
347+
```
348+
349+
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.
340350

341351
## PARAMETERS
342352

@@ -616,17 +626,15 @@ Accept wildcard characters: False
616626
### -CompleteAfter
617627
This parameter is available only in the cloud-based service.
618628

619-
The CompleteAfter parameter specifies a delay before the batch is completed. Data migration for the batch will start, but won't complete until the date/time you specify with this parameter.
629+
The CompleteAfter parameter specifies a delay before the batch is completed. Data migration for the batch will start, but completion won't start until the date/time you specify with this parameter.
620630

621631
Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM".
622632

623-
In Exchange Online PowerShell, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC).
624-
625-
To specify a date/time value for this parameter, use either of the following options:
633+
In Exchange Online PowerShell, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). To specify a value, use either of the following options:
626634

627-
- Specify the date/time value in UTC: For example, "2016-05-06 14:30:00z".
635+
- Specify the date/time value in UTC: For example, `"7/30/2020 9:00PM Z"`.
628636

629-
- 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/2016 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date).
637+
- Specify the date/time value in your local time zone: For example, `"7/30/2020 9:00PM -700"`. The value will be converted to UTC if you don't use the TimeZone parameter.
630638

631639
```yaml
632640
Type: DateTime
@@ -1014,13 +1022,11 @@ The StartAfter parameter specifies a delay before the data migration for the use
10141022

10151023
Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM".
10161024

1017-
In Exchange Online PowerShell, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC).
1018-
1019-
To specify a date/time value for this parameter, use either of the following options:
1025+
In Exchange Online PowerShell, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). To specify a value, use either of the following options:
10201026

1021-
- Specify the date/time value in UTC: For example, "2016-05-06 14:30:00z".
1027+
- Specify the date/time value in UTC: For example, `"7/30/2020 9:00PM Z"`.
10221028

1023-
- 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/2016 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date).
1029+
- Specify the date/time value in your local time zone. For example, `"7/30/2020 9:00PM -700"`. The value will be converted to UTC if you don't use the TimeZone parameter.
10241030

10251031
```yaml
10261032
Type: DateTime
@@ -1124,11 +1130,15 @@ Accept wildcard characters: False
11241130
### -TimeZone
11251131
The TimeZone parameter specifies the time zone of the administrator who submits the migration batch.
11261132

1127-
A valid value for this parameter is a supported time zone key name (for example, "Pacific Standard Time").
1133+
A valid value for this parameter is a supported time zone key name (for example, `"Pacific Standard Time"`).
11281134

11291135
To see the available values, run the following command: `$TimeZone = Get-ChildItem "HKLM:\Software\Microsoft\Windows NT\CurrentVersion\Time zones" | foreach {Get-ItemProperty $_.PSPath}; $TimeZone | sort Display | Format-Table -Auto PSChildname,Display`.
11301136

1131-
If the value contains spaces, enclose the value in quotation marks ("). The default value is the time zone setting of the Exchange server.
1137+
If the value contains spaces, enclose the value in quotation marks (").
1138+
1139+
In on-premises Exchange, the default value is the time zone setting of the Exchange server.
1140+
1141+
In Exchange Online, the default value is `UTC`.
11321142

11331143
```yaml
11341144
Type: ExTimeZoneValue

exchange/exchange-ps/exchange/Set-MigrationBatch.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -204,17 +204,15 @@ Accept wildcard characters: False
204204
### -CompleteAfter
205205
This parameter is available only in the cloud-based service.
206206
207-
The CompleteAfter parameter specifies a delay before the batch is completed. Data migration for the batch will start, but won't complete until the date/time you specify with this parameter.
207+
The CompleteAfter parameter specifies a delay before the batch is completed. Data migration for the batch will start, but completion won't start until the date/time you specify with this parameter.
208208
209209
Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM".
210210
211-
In Exchange Online PowerShell, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC).
211+
In Exchange Online PowerShell, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). To specify a value, use either of the following options:
212212
213-
To specify a date/time value for this parameter, use either of the following options:
213+
- Specify the date/time value in UTC: For example, `"7/30/2020 9:00PM Z"`.
214214
215-
- Specify the date/time value in UTC: For example, "2016-05-06 14:30:00z".
216-
217-
- 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/2016 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date).
215+
- Specify the date/time value in your local time zone. For example, `"7/30/2020 9:00PM -700"`. The value will be converted to UTC if you don't use the TimeZone parameter.
218216
219217
```yaml
220218
Type: DateTime
@@ -472,13 +470,11 @@ The StartAfter parameter specifies a delay before the data migration for the use
472470

473471
Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM".
474472

475-
In Exchange Online PowerShell, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC).
476-
477-
To specify a date/time value for this parameter, use either of the following options:
473+
In Exchange Online PowerShell, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). To specify a value, use either of the following options:
478474

479-
- Specify the date/time value in UTC: For example, "2016-05-06 14:30:00z".
475+
- Specify the date/time value in UTC: For example, `"7/30/2020 9:00PM Z"`.
480476

481-
- 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/2016 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date).
477+
- Specify the date/time value in your local time zone. For example, `"7/30/2020 9:00PM -700"`. The value will be converted to UTC if you don't use the TimeZone parameter.
482478

483479
```yaml
484480
Type: DateTime

0 commit comments

Comments
 (0)