Skip to content

Commit 4a6bc9f

Browse files
authored
Merge pull request #227897 from sipastak/db-eventgrid
data box event grid integration
2 parents d3cf555 + 55f28f1 commit 4a6bc9f

File tree

2 files changed

+144
-0
lines changed

2 files changed

+144
-0
lines changed
Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
---
2+
title: Azure Data Box as Event Grid source
3+
description: Describes the properties that are provided for Data Box events with Azure Event Grid.
4+
ms.topic: conceptual
5+
ms.date: 02/09/2023
6+
---
7+
8+
# Azure Data Box as an Event Grid source
9+
10+
This article provides the properties and schema for Azure Data Box events. For an introduction to event schemas, see [Azure Event Grid event schema](event-schema.md).
11+
12+
## Data Box events
13+
14+
|Event name |Description|
15+
|----------|-----------|
16+
| Microsoft.DataBox.CopyStarted |Triggered when the copy has started from the device and the first byte of data copy is copied. |
17+
|Microsoft.DataBox.CopyCompleted |Triggered when the copy has completed from device.|
18+
| Microsoft.DataBox.OrderCompleted |Triggered when the order has completed copying and copy logs are available. |
19+
20+
### Example events
21+
22+
# [Event Grid event schema](#tab/event-grid-event-schema)
23+
24+
### Microsoft.DataBox.CopyStarted event
25+
26+
```json
27+
[{
28+
"topic": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.DataBox/jobs/{your-resource}",
29+
"subject": "/jobs/{your-resource}",
30+
"eventType": "Microsoft.DataBox.CopyStarted",
31+
"id": "049ec3f6-5b7d-4052-858e-6f4ce6a46570",
32+
"data": {
33+
"serialNumber": "SampleSerialNumber",
34+
"stageName": "CopyStarted",
35+
"stageTime": "2022-10-12T19:38:08.0218897Z"
36+
},
37+
"dataVersion": "1",
38+
"metadataVersion": "1",
39+
"eventTime": "2022-10-16T02:51:26.4248221Z"
40+
}]
41+
```
42+
43+
### Microsoft.DataBox.CopyCompleted event
44+
45+
```json
46+
[{
47+
"topic": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.DataBox/jobs/{your-resource}",
48+
"subject": "/jobs/{your-resource}",
49+
"eventType": "Microsoft.DataBox.CopyCompleted",
50+
"id": "759c892a-a628-4e48-a116-2e1d54c555ce",
51+
"data": {
52+
"serialNumber": "SampleSerialNumber",
53+
"stageName": "CopyCompleted",
54+
"stageTime": "2022-10-12T19:38:08.0218897Z"
55+
},
56+
"dataVersion": "1",
57+
"metadataVersion": "1",
58+
"eventTime": "2022-10-16T02:58:18.503829Z"
59+
}]
60+
```
61+
62+
### Microsoft.DataBox.OrderCompleted event
63+
64+
```json
65+
{
66+
"topic": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.DataBox/jobs/{your-resource}",
67+
"subject": "/jobs/{your-resource}",
68+
"eventType": "Microsoft.DataBox.OrderCompleted",
69+
"id": "5eb07c79-39a8-439c-bb4b-bde1f6267c37",
70+
"data": {
71+
"serialNumber": "SampleSerialNumber",
72+
"stageName": "OrderCompleted",
73+
"stageTime": "2022-10-12T19:38:08.0218897Z"
74+
},
75+
"dataVersion": "1",
76+
"metadataVersion": "1",
77+
"eventTime": "2022-10-16T02:51:26.4248221Z"
78+
}
79+
```
80+
81+
# [Cloud event schema](#tab/cloud-event-schema)
82+
83+
### Microsoft.DataBox.CopyStarted event
84+
85+
```json
86+
[{
87+
"source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.DataBox/jobs/{your-resource}",
88+
"subject": "/jobs/{your-resource}",
89+
"type": "Microsoft.DataBox.CopyStarted",
90+
"time": "2022-10-16T02:51:26.4248221Z",
91+
"id": "049ec3f6-5b7d-4052-858e-6f4ce6a46570",
92+
"data": {
93+
"serialNumber": "SampleSerialNumber",
94+
"stageName": "CopyStarted",
95+
"stageTime": "2022-10-12T19:38:08.0218897Z"
96+
},
97+
"specVersion": "1.0"
98+
}]
99+
```
100+
101+
### Microsoft.DataBox.CopyCompleted event
102+
103+
```json
104+
{
105+
"source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.DataBox/jobs/{your-resource}",
106+
"subject": "/jobs/{your-resource}",
107+
"type": "Microsoft.DataBox.CopyCompleted",
108+
"time": "2022-10-16T02:51:26.4248221Z",
109+
"id": "759c892a-a628-4e48-a116-2e1d54c555ce",
110+
"data": {
111+
"serialNumber": "SampleSerialNumber",
112+
"stageName": "CopyCompleted",
113+
"stageTime": "2022-10-12T19:38:08.0218897Z"
114+
},
115+
"specVersion": "1.0"
116+
}
117+
```
118+
119+
### Microsoft.DataBox.OrderCompleted event
120+
121+
```json
122+
[{
123+
"source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.DataBox/jobs/{your-resource}",
124+
"subject": "/jobs/{your-resource}",
125+
"type": "Microsoft.DataBox.OrderCompleted",
126+
"time": "2022-10-16T02:51:26.4248221Z",
127+
"id": "5eb07c79-39a8-439c-bb4b-bde1f6267c37",
128+
"data": {
129+
"serialNumber": "SampleSerialNumber",
130+
"stageName": "OrderCompleted",
131+
"stageTime": "2022-10-12T19:38:08.0218897Z"
132+
},
133+
"specVersion": "1.0"
134+
}]
135+
```
136+
---
137+
138+
139+
## Next steps
140+
141+
* For an introduction to Azure Event Grid, see [What is Event Grid?](overview.md)
142+
* For more information about creating an Azure Event Grid subscription, see [Event Grid subscription schema](subscription-creation-schema.md).

articles/event-grid/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,8 @@ items:
141141
href: communication-services-email-events.md
142142
- name: Azure Container Registry
143143
href: event-schema-container-registry.md
144+
- name: Azure Data Box
145+
href: event-schema-data-box.md
144146
- name: Azure Event Hubs
145147
href: event-schema-event-hubs.md
146148
- name: Azure Health Data Services

0 commit comments

Comments
 (0)