Skip to content

Commit 058e9fc

Browse files
Update migration-api-overview.md
Adding examples for the all the event types that we log into the Azure Reporting Queue.
1 parent 465e39f commit 058e9fc

File tree

1 file changed

+138
-1
lines changed

1 file changed

+138
-1
lines changed

docs/apis/migration-api-overview.md

Lines changed: 138 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "SharePoint Online Import Migration API"
33
ms.date: 06/14/2020
44
ms.author: jhendr
55
author: JoanneHendrickson
6-
manager: pamgreen
6+
manager: serdars
77
search.appverid: MET150
88
description: "This document is to give more in depth information about how to use the SPO Migration API."
99
localization_priority: Priority
@@ -86,6 +86,143 @@ The valid URL including SAS token for accessing the user provided Azure Queue us
8686
```
8787
Once accepted, the job ID will be written to the notification queue if it was provided and access is valid. The notification queue can be used for multiple migration jobs at the same time, as each job will identify itself in values sent back to the notification queue.
8888

89+
The following are examples of all event types logged into the Azure reporting queue:
90+
91+
**Event:JobQueued**
92+
JobId:845daca4-5529-4b0e-85ab-a603efee5b12
93+
Time:09/29/2020 19:56:02.883
94+
SiteId:48917234-de43-474a-9f1b-8d98ffa08425
95+
DbId:8fd09323-b23f-430d-8957-213586ce3861
96+
TotalRetryCount:0
97+
MigrationType:None
98+
MigrationDirection:Import
99+
CorrelationId:c8d97e9f-802f-0000-ceac-44663834d510
100+
101+
**Event:JobPostponed**
102+
JobId:845daca4-5529-4b0e-85ab-a603efee5b12
103+
Time:09/29/2020 19:56:57.598
104+
NextPickupTime:09/29/2020 20:16:57.519
105+
SiteId:48917234-de43-474a-9f1b-8d98ffa08425
106+
DbId:8fd09323-b23f-430d-8957-213586ce3861
107+
JobsInQueue:
108+
TotalRetryCount:0
109+
MigrationType:None
110+
MigrationDirection:Import
111+
CorrelationId:d5d97e9f-702c-0000-ceb9-354fefa5e9f6
112+
113+
**Event:JobLogFileCreate**
114+
JobId:071f9aad-36e6-4bef-9f09-40b5c7498ecd
115+
Time:09/29/2020 19:56:29.053
116+
FileName:Import-071f9aad-36e6-4bef-9f09-40b5c7498ecd-1.log
117+
CorrelationId:22ca20ec-23de-468b-add3-4e52e90d3a68
118+
119+
**Event:JobStart**
120+
JobId:071f9aad-36e6-4bef-9f09-40b5c7498ecd
121+
Time:09/29/2020 19:56:29.100
122+
SiteId:48917234-de43-474a-9f1b-8d98ffa08425
123+
WebId:36b66979-4a43-4b93-9b92-909c7186ff98
124+
DBId:8fd09323-b23f-430d-8957-213586ce3861
125+
FarmId:211e600c-f48d-4319-ba92-61150c8e8e8c
126+
ServerId:cfd27448-822a-420b-bcc8-4f39629b01bc
127+
SubscriptionId:51812136-3cba-482d-9696-532cddceab31
128+
TotalRetryCount:0
129+
MigrationType:None
130+
MigrationDirection:Import
131+
CorrelationId:c308c0ea-a7f5-4be9-acd4-1ebd39867434
132+
133+
**Event:JobProgress**
134+
JobId:845daca4-5529-4b0e-85ab-a603efee5b12
135+
Time:09/29/2020 19:56:32.265
136+
FilesCreated:15
137+
BytesProcessed:45
138+
ObjectsProcessed:217
139+
TotalExpectedSPObjects:403
140+
TotalErrors:0
141+
TotalWarnings:0
142+
TotalRetryCount:0
143+
MigrationType:None
144+
MigrationDirection:Import
145+
WaitTimeOnSqlThrottlingMilliseconds:0
146+
TotalDurationInMs:0
147+
CpuDurationInMs:0
148+
SqlDurationInMs:0
149+
SqlQueryCount:0
150+
CreatedOrUpdatedFileStatsBySize:{"0-1K":{"Count":15,"TotalSize":45,"TotalDownloadTime":251,"TotalCreationTime":6754}}
151+
ObjectsStatsByType:{"SPUser":{"Count":1,"TotalTime":289,"AccumulatedVersions":0,"ObjectsWithVersions":0},"SPFolder":{"Count":2,"TotalTime":144,"AccumulatedVersions":0,"ObjectsWithVersions":0},"SPDocumentLibrary":{"Count":1,"TotalTime":173,"AccumulatedVersions":0,"ObjectsWithVersions":0},"SPFile":{"Count":200,"TotalTime":6765,"AccumulatedVersions":0,"ObjectsWithVersions":0},"SPListItem":{"Count":14,"TotalTime":2111,"AccumulatedVersions":0,"ObjectsWithVersions":0}}
152+
TotalExpectedBytes:0
153+
CorrelationId:ccd97e9f-a0cc-0000-ceb9-37a900bec68d
154+
155+
**Event:JobEnd**
156+
JobId:16d658cf-ecd3-485f-9c9e-1ca268565e24
157+
Time:09/29/2020 20:29:38.180
158+
FilesCreated:200
159+
BytesProcessed:600
160+
ObjectsProcessed:403
161+
TotalExpectedSPObjects:403
162+
TotalErrors:0
163+
TotalWarnings:0
164+
TotalRetryCount:0
165+
MigrationType:None
166+
MigrationDirection:Import
167+
WaitTimeOnSqlThrottlingMilliseconds:0
168+
TotalDurationInMs:372294.0861
169+
CpuDurationInMs:17351
170+
SqlDurationInMs:98359
171+
SqlQueryCount:1998
172+
CreatedOrUpdatedFileStatsBySize:{"0-1K":{"Count":200,"TotalSize":600,"TotalDownloadTime":15448,"TotalCreationTime":275662}}
173+
ObjectsStatsByType:{"SPUser":{"Count":1,"TotalTime":44,"AccumulatedVersions":0,"ObjectsWithVersions":0},"SPFolder":{"Count":2,"TotalTime":108,"AccumulatedVersions":0,"ObjectsWithVersions":0},"SPDocumentLibrary":{"Count":1,"TotalTime":50,"AccumulatedVersions":0,"ObjectsWithVersions":0},"SPFile":{"Count":200,"TotalTime":293628,"AccumulatedVersions":0,"ObjectsWithVersions":0},"SPListItem":{"Count":200,"TotalTime":76541,"AccumulatedVersions":0,"ObjectsWithVersions":0}}
174+
TotalExpectedBytes:0
175+
CorrelationId:59db7e9f-a003-0000-ceb9-300001119ee3
176+
177+
**Event:JobDeleted**
178+
JobId:071f9aad-36e6-4bef-9f09-40b5c7498ecd
179+
Time:09/29/2020 19:56:29.053
180+
CorrelationId:22ca20ec-23de-468b-add3-4e52e90d3a68
181+
182+
**Event:JobCancelled**
183+
JobId:071f9aad-36e6-4bef-9f09-40b5c7498ecd
184+
Time:09/29/2020 19:58:29.053
185+
TotalRetryCount:0
186+
CancelledByUser:false
187+
MigrationType:None
188+
MigrationDirection:Import
189+
CorrelationId:22ca20ec-23de-468b-add3-4e52e90d3a68
190+
191+
**Event:JobError**
192+
JobId:b427d8d7-2b91-4da0-aee5-4b5a5a5d867e
193+
Time: 02/05/2019 06:56:09.732
194+
TotalRetryCount:0
195+
MigrationType:None
196+
MigrationDirection:Import
197+
ObjectType:File
198+
Url:Shared Documents/file.pdf
199+
Id:fae7b4b0-2912-11e9-b0f3-7b554a52d6ab
200+
ErrorCode:-2147024816
201+
ErrorType:Microsoft.SharePoint.SPException
202+
Message:ErrorMessage
203+
CorrelationId:d8e9bc9e-20e2-8000-aa83-48a62fc5ce75
204+
205+
**Event:JobWarning**
206+
JobId:b427d8d7-2b91-4da0-aee5-4b5a5a5d867e
207+
Time: 02/05/2019 06:56:09.732
208+
TotalRetryCount:0
209+
MigrationType:None
210+
MigrationDirection:Import
211+
ObjectType:File
212+
Url:Shared Documents/file.pdf
213+
Id:fae7b4b0-2912-11e9-b0f3-7b554a52d6ab
214+
ErrorCode:-2147024816
215+
ErrorType:Microsoft.SharePoint.SPException
216+
Message:ErrorMessage
217+
CorrelationId:d8e9bc9e-20e2-8000-aa83-48a62fc5ce75
218+
219+
**Event:FinishManifestFileUpload**
220+
JobId:b427d8d7-2b91-4da0-aee5-4b5a5a5d867e
221+
Time:02/05/2019 06:56:09.732
222+
ManifestFileName:Filename
223+
CorrelationId:d8e9bc9e-20e2-8000-aa83-48a62fc5ce75
224+
225+
89226
#### Return values
90227

91228
The unique identifier for the migration job is returned if the job is successfully queued, or if unsuccessful, a null value will be returned. The migration job unique identifier can be used to query the migration job status while it is in the queue or being processed by using the GetMigrationJobStatus method.

0 commit comments

Comments
 (0)