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: articles/event-hubs/event-hubs-data-explorer.md
+14-10Lines changed: 14 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,9 @@
1
1
---
2
-
title: Overview of the Event Hubs Data Explorer
2
+
title: Use Event Hubs Data Explorer
3
3
description: This article provides an overview of the Event Hubs Data Explorer, which provides an easy way to send data to and receive data from Azure Event Hubs.
4
-
ms.topic: article
5
-
ms.date: 11/18/2024
4
+
ms.topic: tutorial
5
+
ms.date: 02/14/2025
6
+
# Customer intent: I want to test sending events to and receiving events from an Azure event hub.
6
7
---
7
8
8
9
# Use Event Hubs Data Explorer to run data operations on Event Hubs
@@ -21,7 +22,7 @@ Operations run on an Azure Event Hubs namespace are of two kinds.
21
22
> [!IMPORTANT]
22
23
> * The Event Hubs Data Explorer doesn't support **management operations**. The event hub must be created before the data explorer can send or view events from that event hub.
23
24
> * While events payloads (known as **values** in Kafka) sent using the **Kafka protocol** is visible via the data explorer, the **key** for the specific event isn't visible.
24
-
> * We advise against using the Event Hubs Data Explorer for larger messages, as this may result in time-outs, depending on the message size, network latency between client and Service Bus service etc. Instead, we recommend that you use your own client to work with larger messages, where you can specify your own time-out values.
25
+
> * We advise against using the Event Hubs Data Explorer for larger messages, as it can result in time-outs, depending on the message size, network latency between client and Service Bus service etc. Instead, we recommend that you use your own client to work with larger messages, where you can specify your own time-out values.
25
26
> * The operations that a user can perform using Event Hubs Data Explorer is determined by the [role-based access control (RBAC)](authorize-access-azure-active-directory.md#azure-built-in-roles-for-azure-event-hubs) role that the user is assigned to.
26
27
> * If your Event Hubs namespace can only be accessed via a private endpoint, you must run your web browser on a host in the virtual network with the private endpoint, and also ensure that there are no network security gateways (NSGs) in the way.
27
28
@@ -35,7 +36,7 @@ To use the Event Hubs data explorer, navigate to the Event Hubs namespace on whi
35
36
36
37
Either navigate to the `Data Explorer` directly where you can pick the event hub, or pick the event hub from the `entities` and then pick the `Data Explorer` from the navigation menu.
37
38
38
-
:::image type="content" source="./media/event-hubs-data-explorer/left-pane-nav.png" alt-text="Screenshot showing the left pane nav with 'Data Explorer' selected.":::
39
+
:::image type="content" source="./media/event-hubs-data-explorer/left-pane-nav.png" alt-text="Screenshot showing the left pane nav with 'Data Explorer' selected." lightbox="./media/event-hubs-data-explorer/left-pane-nav.png":::
39
40
40
41
### Send Events
41
42
@@ -49,7 +50,7 @@ To do so, select the `send events` button, which enables the right pane.
49
50
#### Sending custom payload
50
51
51
52
To send a custom payload -
52
-
1.**Select Dataset** - Pick `Custom payload`.
53
+
1.**Select Dataset** - Pick `Custom payload`. You can also select pre-canned datasets such as Yellow Taxi data, Weather data, etc. as shown in the next section.
53
54
2. Select the **Content-Type**, from either `Text/Plain`, `JSON`, or `XML`.
54
55
3. Either upload a JSON file, or type out the payload in the **Enter payload** box.
55
56
4.**[Optional]** Specify system properties.
@@ -86,11 +87,14 @@ To view events, you can define the below properties, or rely on the default -
86
87
1.**PartitionID** - Pick either a specific partition or select *All partition IDs*.
87
88
2.**Consumer Group** - Pick the *$Default* or another consumer group, or create one on the fly.
88
89
3.**Event position** - Pick the *oldest position* (that is, the start of the event hub), *Newest position* (that is, latest), *Custom position* (for a specific offset, sequence number or timestamp).
89
-
4.**Advanced properties** - Specify the *maximum batch size* and *maximum wait time in seconds*.
90
+
1.**Oldest position**: Begin receiving events from the first event in the partition which wasn't expired due to the retention policy.
91
+
1.**Custom position**: Add filter to specify the position in the partition to begin receiving events from.
92
+
1.**Newest position**: Begin receiving events from the event that is enqueued right after the view call. Only events sent after last viewing of events are received.
93
+
1.**Advanced properties** - Specify the *maximum batch size* and *maximum wait time in seconds*.
90
94
91
95
Once the above options are set, select **View events** to pull the events and render them on the data explorer.
92
96
93
-
:::image type="content" source="./media/event-hubs-data-explorer/grid-of-events.png" alt-text="Screenshot showing the grid of events.":::
97
+
:::image type="content" source="./media/event-hubs-data-explorer/grid-of-events.png" alt-text="Screenshot showing the grid of events." lightbox="./media/event-hubs-data-explorer/grid-of-events.png":::
94
98
95
99
96
100
Once the events are loaded, you can select **View next events** to pull events using the same query again, or **Clear all** to refresh the grid.
@@ -101,10 +105,10 @@ When viewing the events on a given event hub, the event payload can be downloade
101
105
102
106
To download the event payload, select the specific event and select the **download** button displayed above the event payload body.
103
107
104
-
:::image type="content" source="./media/event-hubs-data-explorer/download-event-body.png" alt-text="Screenshot showing the grid of events with selected event and highlighted download event button.":::
108
+
:::image type="content" source="./media/event-hubs-data-explorer/download-event-body.png" alt-text="Screenshot showing the grid of events with selected event and highlighted download event button." lightbox="./media/event-hubs-data-explorer/download-event-body.png":::
105
109
106
110
107
-
## Next steps
111
+
## Related content
108
112
109
113
* Learn more about [Event Hubs](event-hubs-about.md).
110
114
* Check out [Event Hubs features and terminology](event-hubs-features.md)
0 commit comments