You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: exchange/exchange-ps/exchange/Get-MigrationBatch.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,10 +58,12 @@ The Get-MigrationBatch cmdlet displays status information about the current migr
58
58
59
59
- Migration errors
60
60
61
-
- Date and time when the migration was started
61
+
- Date and time when the migration was started and completed.
62
62
63
63
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).
64
64
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.
Safe Links is a feature in Advanced Threat Protection that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. For more information about Advanced Threat Protection Safe Links, see [Office 365 ATP Safe Links](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-links).
34
42
35
-
The following list described the values that are returned in the output of this cmdlet:
43
+
For the reporting period you specify, the cmdlet returns the following information:
44
+
45
+
- Time Clicked: The date/time when the URL in the message body was clicked. Every analyzed URL click is recorded, even when a user clicks a URL in an existing message that's already been scanned.
46
+
47
+
- Workload
48
+
49
+
- Application Name
50
+
51
+
- Message ID
52
+
53
+
- Message Trace ID
54
+
55
+
- Source ID
56
+
57
+
- Source Details
36
58
37
59
- ClickId: A GUID for each URL that was analyzed in a message.
38
60
39
-
- Clicked: The date/time when the URL in the message body was clicked. Every analyzed URL click is recorded, even when a user clicks a URL in an existing message that's already been scanned.
61
+
- Recipient Address
62
+
63
+
- URL
64
+
65
+
- User IP Address
40
66
41
67
- UrlBlocked: The URL was detected as malicious by Safe Links (only the initial block, not subsequent clicks), or the user clicked the URL while the scan in progress (users are taken to a notification page that asks them to try again after the scan is complete).
42
68
43
69
- UrlClicked: The URL is blocked, but the applicable Safe Links policy has the DoNotAllowClickThrough parameter value $false (click through is allowed). Updated policies aren't applied to existing messages that have already been scanned. New or updated policies are applied to new messages that were received after the policy is applied to the mailbox.
44
70
71
+
- Click Action: The action of a specific click. Possible values are:
72
+
73
+
• None: We were unable to capture the verdict for the URL. The user might have clicked through the URL.
74
+
• Allowed: The user was allowed to navigate to the URL.
75
+
• Blocked: The User was blocked from navigating to the URL.
76
+
• Pending verdict: The user was presented with the detonation pending page.
77
+
• Blocked overridden: The user was blocked from navigating to the URL; however, the user overrode the block to navigate to the URL.
78
+
• Pending verdict bypassed: The user presented with the detonation page; however, the user overrode the page to navigate to the URL.
79
+
• Error: The user was presented with the error page. This can also mean there was an error in capturing the verdict.
80
+
• Failure: There was unknown exception while capturing the verdict. The user might have clicked through the URL.
81
+
45
82
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).
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.
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.
This parameter is available only in the cloud-based service.
618
628
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.
620
630
621
631
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".
622
632
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:
626
634
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"`.
628
636
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.
630
638
631
639
```yaml
632
640
Type: DateTime
@@ -1014,13 +1022,11 @@ The StartAfter parameter specifies a delay before the data migration for the use
1014
1022
1015
1023
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".
1016
1024
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:
1020
1026
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"`.
1022
1028
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.
The TimeZone parameter specifies the time zone of the administrator who submits the migration batch.
1126
1132
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"`).
1128
1134
1129
1135
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`.
1130
1136
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.
This parameter is available only in the cloud-based service.
206
206
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.
208
208
209
209
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".
210
210
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:
212
212
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"`.
214
214
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.
218
216
219
217
```yaml
220
218
Type: DateTime
@@ -472,13 +470,11 @@ The StartAfter parameter specifies a delay before the data migration for the use
472
470
473
471
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".
474
472
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:
478
474
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"`.
480
476
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.
0 commit comments