Skip to content

Commit 66ad4eb

Browse files
ShawnJacksonShawnJackson
authored
Merge pull request #77661 from atookey/time-series-insights-how-to-add-an-event-source-eventhub
Edit pass: time-series-insights-how-to-add-an-event-source-eventhub
2 parents 66876e5 + bac66c8 commit 66ad4eb

File tree

2 files changed

+69
-66
lines changed

2 files changed

+69
-66
lines changed

‎articles/time-series-insights/time-series-insights-how-to-add-an-event-source-eventhub.md

Lines changed: 36 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ ms.custom: seodec18
1818
This article describes how to use the Azure portal to add an event source that reads data from Azure Event Hubs to your Azure Time Series Insights environment.
1919

2020
> [!NOTE]
21-
> The steps described in this article apply both to the Time Series Insights GA and Time Series Insights Preview environments.
21+
> The steps that are described in this article apply both to the Time Series Insights GA and Time Series Insights Preview environments.
2222
2323
## Prerequisites
2424

@@ -29,7 +29,7 @@ This article describes how to use the Azure portal to add an event source that r
2929

3030
### Add a consumer group to your event hub
3131

32-
Applications use consumer groups to pull data from Azure Event Hubs. Provide a dedicated consumer group, for use only by this Time Series Insights environment, to reliably read data from your event hub.
32+
Applications use consumer groups to pull data from Azure Event Hubs. To reliably read data from your event hub, provide a dedicated consumer group that's used only by this Time Series Insights environment.
3333

3434
To add a new consumer group in your event hub:
3535

@@ -59,38 +59,40 @@ To add a new consumer group in your event hub:
5959

6060
1. Select the appropriate values for **Import option**:
6161
- If you have an existing event hub in one of your subscriptions, select **Use Event Hub from available subscriptions**. This option is the easiest approach.
62-
- If the event hub is external to your subscriptions or if you want to select advanced options, select **Provide Event Hub settings manually**.
63-
64-
[![In the New event source pane, enter values for the first three parameters](media/time-series-insights-how-to-add-an-event-source-eventhub/2-import-option.png)](media/time-series-insights-how-to-add-an-event-source-eventhub/2-import-option.png#lightbox)
65-
66-
1. The following table describes the required properties for the **Use Event Hub from available subscriptions** option:
67-
68-
[![Subscription and event hub details](media/time-series-insights-how-to-add-an-event-source-eventhub/3-new-event-source.png)](media/time-series-insights-how-to-add-an-event-source-eventhub/3-new-event-source.png#lightbox)
69-
70-
| Property | Description |
71-
| --- | --- |
72-
| Subscription Id | Select the subscription in which this event hub was created.
73-
| Service bus namespace | Select the Azure Service Bus namespace that contains the event hub.
74-
| Event hub name | Select the name of the event hub.
75-
| Event hub policy name | Select the shared access policy. You can create the shared access policy on the event hub **Configure** tab. Each shared access policy has a name, permissions that you set, and access keys. The shared access policy for your event source *must* have **read** permissions.
76-
| Event hub policy key | The key value might be prepopulated.
77-
| Event hub consumer group | The consumer group that reads events from the event hub. We highly recommend that you use a dedicated consumer group for your event source. |
78-
| Event serialization format | Currently, JSON is the only available serialization format. Event messages must be in this format or no data can be read. |
79-
| Timestamp property name | To determine this value, you need to understand the message format of the message data that's sent to the event hub. This value is the **name** of the specific event property in the message data that you want to use as the event timestamp. The value is case-sensitive. If left blank, the **event enqueue time** in the event source is used as the event timestamp. |
80-
81-
1. The following table describes the required properties for the **Provide Event Hub settings manually** option:
82-
83-
| Property | Description |
84-
| --- | --- |
85-
| Subscription Id | The subscription in which this event hub was created.
86-
| Resource group | The resource group in which this event hub was created.
87-
| Service bus namespace | A Service Bus namespace is a container for a set of messaging entities. When you created a new event hub, you also created a Service Bus namespace.
88-
| Event hub name | The name of your event hub. When you created your event hub, you also gave it a specific name.
89-
| Event hub policy name | The shared access policy. You can create a shared access policy on the event hub **Configure** tab. Each shared access policy has a name, permissions that you set, and access keys. The shared access policy for your event source *must* have **read** permissions.
90-
| Event hub policy key | The shared access key that's used to authenticate access to the Service Bus namespace. Enter the primary or secondary key here.
91-
| Event hub consumer group | The consumer group that reads events from the event hub. We highly recommend that you use a dedicated consumer group for your event source.
92-
| Event serialization format | Currently, JSON is the only available serialization format. Event messages must be in this format or no data can be read. |
93-
| Timestamp property name | To determine this value, you need to understand the message format of the message data that's sent to the event hub. This value is the **name** of the specific event property in the message data that you want to use as the event timestamp. The value is case-sensitive. If left blank, the **event enqueue time** in the event source is used as the event timestamp. |
62+
63+
[![In the New event source pane, enter values for the first three parameters](media/time-series-insights-how-to-add-an-event-source-eventhub/2-import-option.png)](media/time-series-insights-how-to-add-an-event-source-eventhub/2-import-option.png#lightbox)
64+
65+
66+
[![Subscription and event hub details](media/time-series-insights-how-to-add-an-event-source-eventhub/3-new-event-source.png)](media/time-series-insights-how-to-add-an-event-source-eventhub/3-new-event-source.png#lightbox)
67+
68+
The following table describes the required properties for the **Use Event Hub from available subscriptions** option:
69+
70+
| Property | Description |
71+
| --- | --- |
72+
| Subscription ID | Select the subscription in which this event hub was created.
73+
| Service Bus namespace | Select the Azure Service Bus namespace that contains the event hub.
74+
| Event hub name | Select the name of the event hub.
75+
| Event hub policy name | Select the shared access policy. You can create the shared access policy on the event hub **Configure** tab. Each shared access policy has a name, permissions that you set, and access keys. The shared access policy for your event source *must* have **read** permissions.
76+
| Event hub policy key | The key value might be prepopulated.
77+
| Event hub consumer group | The consumer group that reads events from the event hub. We highly recommend that you use a dedicated consumer group for your event source. |
78+
| Event serialization format | Currently, JSON is the only available serialization format. Event messages must be in this format or data can't be read. |
79+
| Timestamp property name | To determine this value, you need to understand the message format of the message data that's sent to the event hub. This value is the **name** of the specific event property in the message data that you want to use as the event timestamp. The value is case-sensitive. If left blank, the **event enqueue time** in the event source is used as the event timestamp. |
80+
81+
- If the event hub is external to your subscriptions or if you want to select advanced options, select **Provide Event Hub settings manually**.
82+
83+
The following table describes the required properties for the **Provide Event Hub settings manually** option:
84+
85+
| Property | Description |
86+
| --- | --- |
87+
| Subscription ID | The subscription in which this event hub was created.
88+
| Resource group | The resource group in which this event hub was created.
89+
| Service Bus namespace | A Service Bus namespace is a container for a set of messaging entities. When you created a new event hub, you also created a Service Bus namespace.
90+
| Event hub name | The name of your event hub. When you created your event hub, you also gave it a specific name.
91+
| Event hub policy name | The shared access policy. You can create a shared access policy on the event hub **Configure** tab. Each shared access policy has a name, permissions that you set, and access keys. The shared access policy for your event source *must* have **read** permissions.
92+
| Event hub policy key | The shared access key that's used to authenticate access to the Service Bus namespace. Enter the primary or secondary key here.
93+
| Event hub consumer group | The consumer group that reads events from the event hub. We highly recommend that you use a dedicated consumer group for your event source.
94+
| Event serialization format | Currently, JSON is the only available serialization format. Event messages must be in this format or data can't be read. |
95+
| Timestamp property name | To determine this value, you need to understand the message format of the message data that's sent to the event hub. This value is the **name** of the specific event property in the message data that you want to use as the event timestamp. The value is case-sensitive. If left blank, the **event enqueue time** in the event source is used as the event timestamp. |
9496

9597
1. Add the dedicated Time Series Insights consumer group name that you added to your event hub.
9698

‎articles/time-series-insights/time-series-insights-how-to-add-an-event-source-iothub.md

Lines changed: 33 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,13 @@ This article describes how to use the Azure portal to add an event source that r
2929

3030
### Add a consumer group to your IoT hub
3131

32-
Applications use consumer groups to pull data from Azure IoT Hub. Provide a dedicated consumer group that's used only by this Time Series Insights environment to reliably read data from your IoT hub.
32+
Applications use consumer groups to pull data from Azure IoT Hub. To reliably read data from your IoT hub, provide a dedicated consumer group that's used only by this Time Series Insights environment.
3333

3434
To add a new consumer group to your IoT hub:
3535

3636
1. In the Azure portal, find and open your IoT hub.
3737

38-
1. In the menu, under **Settings**, select **Built-in Endpoints**, and then select the **Events** endpoint.
38+
1. Under **Settings**, select **Built-in Endpoints**, and then select the **Events** endpoint.
3939

4040
[![On the Build-in Endpoints page, select the Events button](media/time-series-insights-how-to-add-an-event-source-iothub/iothub_one.png)](media/time-series-insights-how-to-add-an-event-source-iothub/iothub_one.png#lightbox)
4141

@@ -60,36 +60,37 @@ To add a new consumer group to your IoT hub:
6060
1. Select a value for **Import option**:
6161

6262
* If you already have an IoT hub in one of your subscriptions, select **Use IoT Hub from available subscriptions**. This option is the easiest approach.
63-
* If the IoT hub is external to your subscriptions, or if you want to choose advanced options, select **Provide IoT Hub settings manually**.
64-
65-
[![Select options in the New event source pane](media/time-series-insights-how-to-add-an-event-source-iothub/iothub_three.png)](media/time-series-insights-how-to-add-an-event-source-iothub/iothub_three.png#lightbox)
66-
67-
1. The following table describes the properties that are required for the **Use IoT Hub from available subscriptions** option:
68-
69-
[![New event source pane - Properties to set in the Use IoT Hub from available subscriptions option](media/time-series-insights-how-to-add-an-event-source-iothub/iothub_four.png)](media/time-series-insights-how-to-add-an-event-source-iothub/iothub_four.png#lightbox)
70-
71-
| Property | Description |
72-
| --- | --- |
73-
| Subscription ID | Select the subscription in which the IoT hub was created.
74-
| IoT hub name | Select the name of the IoT hub.
75-
| IoT hub policy name | Select the shared access policy. You can find the shared access policy on the IoT hub settings tab. Each shared access policy has a name, permissions that you set, and access keys. The shared access policy for your event source *must* have **service connect** permissions.
76-
| IoT hub policy key | The key is prepopulated.
77-
| IoT hub consumer group | The consumer group that reads events from the IoT hub. We highly recommend that you use a dedicated consumer group for your event source.
78-
| Event serialization format | Currently, JSON is the only available serialization format. The event messages must be in this format or no data can be read. |
79-
| Timestamp property name | To determine this value, you need to understand the message format of the message data that's sent to the IoT hub. This value is the **name** of the specific event property in the message data that you want to use as the event timestamp. The value is case-sensitive. If left blank, the **event enqueue time** in the event source is used as the event timestamp. |
80-
81-
1. The following table describes the required properties for the **Provide IoT Hub settings manually**:
82-
83-
| Property | Description |
84-
| --- | --- |
85-
| Subscription ID | The subscription in which the IoT hub was created.
86-
| Resource group | The resource group name in which the IoT hub was created.
87-
| IoT hub name | The name of your IoT hub. When you created your IoT hub, you entered a name for the IoT hub.
88-
| IoT hub policy name | The shared access policy. You can create the shared access policy on the IoT hub settings tab. Each shared access policy has a name, permissions that you set, and access keys. The shared access policy for your event source *must* have **service connect** permissions.
89-
| IoT hub policy key | The shared access key that's used to authenticate access to the Azure Service Bus namespace. Enter the primary or secondary key here.
90-
| IoT hub consumer group | The consumer group that reads events from the IoT hub. We highly recommend that you use a dedicated consumer group for your event source.
91-
| Event serialization format | Currently, JSON is the only available serialization format. The event messages must be in this format or no data can be read. |
92-
| Timestamp property name | To determine this value, you need to understand the message format of the message data that's sent to the IoT hub. This value is the **name** of the specific event property in the message data that you want to use as the event timestamp. The value is case-sensitive. If left blank, the **event enqueue time** in the event source is used as the event timestamp. |
63+
64+
[![Select options in the New event source pane](media/time-series-insights-how-to-add-an-event-source-iothub/iothub_three.png)](media/time-series-insights-how-to-add-an-event-source-iothub/iothub_three.png#lightbox)
65+
66+
* The following table describes the properties that are required for the **Use IoT Hub from available subscriptions** option:
67+
68+
[![New event source pane - Properties to set in the Use IoT Hub from available subscriptions option](media/time-series-insights-how-to-add-an-event-source-iothub/iothub_four.png)](media/time-series-insights-how-to-add-an-event-source-iothub/iothub_four.png#lightbox)
69+
70+
| Property | Description |
71+
| --- | --- |
72+
| Subscription ID | Select the subscription in which the IoT hub was created.
73+
| IoT hub name | Select the name of the IoT hub.
74+
| IoT hub policy name | Select the shared access policy. You can find the shared access policy on the IoT hub settings tab. Each shared access policy has a name, permissions that you set, and access keys. The shared access policy for your event source *must* have **service connect** permissions.
75+
| IoT hub policy key | The key is prepopulated.
76+
| IoT hub consumer group | The consumer group that reads events from the IoT hub. We highly recommend that you use a dedicated consumer group for your event source.
77+
| Event serialization format | Currently, JSON is the only available serialization format. The event messages must be in this format or no data can be read. |
78+
| Timestamp property name | To determine this value, you need to understand the message format of the message data that's sent to the IoT hub. This value is the **name** of the specific event property in the message data that you want to use as the event timestamp. The value is case-sensitive. If left blank, the **event enqueue time** in the event source is used as the event timestamp. |
79+
80+
* If the IoT hub is external to your subscriptions, or if you want to choose advanced options, select **Provide IoT Hub settings manually**.
81+
82+
The following table describes the required properties for the **Provide IoT Hub settings manually**:
83+
84+
| Property | Description |
85+
| --- | --- |
86+
| Subscription ID | The subscription in which the IoT hub was created.
87+
| Resource group | The resource group name in which the IoT hub was created.
88+
| IoT hub name | The name of your IoT hub. When you created your IoT hub, you entered a name for the IoT hub.
89+
| IoT hub policy name | The shared access policy. You can create the shared access policy on the IoT hub settings tab. Each shared access policy has a name, permissions that you set, and access keys. The shared access policy for your event source *must* have **service connect** permissions.
90+
| IoT hub policy key | The shared access key that's used to authenticate access to the Azure Service Bus namespace. Enter the primary or secondary key here.
91+
| IoT hub consumer group | The consumer group that reads events from the IoT hub. We highly recommend that you use a dedicated consumer group for your event source.
92+
| Event serialization format | Currently, JSON is the only available serialization format. The event messages must be in this format or no data can be read. |
93+
| Timestamp property name | To determine this value, you need to understand the message format of the message data that's sent to the IoT hub. This value is the **name** of the specific event property in the message data that you want to use as the event timestamp. The value is case-sensitive. If left blank, the **event enqueue time** in the event source is used as the event timestamp. |
9394

9495
1. Add the dedicated Time Series Insights consumer group name that you added to your IoT hub.
9596

0 commit comments

Comments
 (0)