แก้ไข

แชร์ผ่าน


Tutorial: Send email notifications about Azure IoT Hub events using Event Grid and Logic Apps

Azure Event Grid enables you to react to events in IoT Hub by triggering actions in your downstream business applications.

This article walks through a sample configuration that uses IoT Hub and Event Grid. At the end, you have an Azure logic app set up to send a notification email every time a device connects or disconnects to your IoT hub. Event Grid can be used to get timely notification about critical devices disconnecting. Metrics and Diagnostics can take several minutes (such as 20 minutes or more) to show up in logs / alerts. Longer processing times might be unacceptable for critical infrastructure.

If you don't have an Azure subscription, create an Azure free account before you begin.

Prerequisites

  • An email account from any email provider that is supported by Azure Logic Apps, such as Office 365 Outlook or Outlook.com. This email account is used to send the event notifications.

Create an IoT hub

You can quickly create a new IoT hub using the Azure Cloud Shell terminal in the portal.

  1. Sign in to the Azure portal.

  2. On the upper right of the page, select the Cloud Shell button.

    Screenshot of how to open the Azure Cloud Shell from the Azure portal.

  3. Run the following command to create a new resource group:

    az group create --name {your resource group name} --location westus
    
  4. Run the following command to create an IoT hub:

    az iot hub create --name {your iot hub name} --resource-group {your resource group name} --sku S1 
    
  5. Minimize the Cloud Shell terminal. You'll return to the shell later in the tutorial.

Create a logic app

Next, create a logic app and add an HTTP Event Grid trigger that processes requests from IoT hub.

Create a logic app resource

  1. In the Azure portal, select Create a resource, then type "logic app" in the search box and select return. Select Logic App from the results.

    Screenshot of how to select the logic app from a list of resources.

  2. On the next screen, select Create.

  3. Give your logic app a unique name in your subscription, then select the same subscription, resource group, and location as your IoT hub. Choose the Consumption plan type.

    Screenshot of how to configure your logic app.

  4. Select Review + create.

  5. Verify your settings and then select Create.

  6. Once the resource is created, select Go to resource.

  7. In the Logic Apps Designer, page down to see Templates. Choose Blank Logic App so that you can build your logic app from scratch.

    Screenshot of the Logic App Designer templates.

Select a trigger

A trigger is a specific event that starts your logic app. For this tutorial, the trigger that sets off the workflow is receiving a request over HTTP.

  1. In the connectors and triggers search bar, type HTTP.

  2. Scroll through the results and select Request - When an HTTP request is received as the trigger.

    Select HTTP request trigger

  3. Select Use sample payload to generate schema.

    Use sample payload

  4. Copy the json below and replace the placeholder values <> with your own.

  5. Paste the Device connected event schema JSON into the text box, then select Done:

      [{  
       "id": "f6bbf8f4-d365-520d-a878-17bf7238abd8",
       "topic": "/SUBSCRIPTIONS/<azure subscription ID>/RESOURCEGROUPS/<resource group name>/PROVIDERS/MICROSOFT.DEVICES/IOTHUBS/<hub name>",
       "subject": "devices/LogicAppTestDevice",
       "eventType": "Microsoft.Devices.DeviceConnected",
       "eventTime": "2018-06-02T19:17:44.4383997Z",
       "data": {
           "deviceConnectionStateEventInfo": {
             "sequenceNumber":
               "000000000000000001D4132452F67CE200000002000000000000000000000001"
           },
         "hubName": "<hub name>",
         "deviceId": "LogicAppTestDevice",
         "moduleId" : "DeviceModuleID"
       }, 
       "dataVersion": "1",
       "metadataVersion": "1"
     }]
    

    Important

    Be sure to paste the JSON snippet into the box provided by the Use sample payload to generate schema link and not directly into the Request Body JSON Schema box. The sample payload link provides a way to generate the JSON content based on the JSON snippet. The final JSON that ends up in the request body is different than the JSON snippet.

    This event publishes when a device is connected to an IoT hub.

Note

You may receive a pop-up notification that says, Remember to include a Content-Type header set to application/json in your request. You can safely ignore this suggestion, and move on to the next section.

Create an action

Actions are any steps that occur after the trigger starts the logic app workflow. For this tutorial, the action is to send an email notification from your email provider.

  1. Select New step. A window appears, prompting you to Choose an action.

  2. Search for Outlook.

  3. Based on your email provider, find and select the matching connector. This tutorial uses Outlook.com. The steps for other email providers are similar. Alternatively, use Office 365 Outlook to skip the sign-in step.

    Select email provider connector

  4. Select the Send an email (V2) action.

  5. Select Sign in and sign in to your email account. Select Yes to let the app access your info.

  6. Build your email template.

    • To: Enter the email address to receive the notification emails. For this tutorial, use an email account that you can access for testing.

    • Subject: Fill in the text for the subject. When you click on the Subject text box, you can select dynamic content to include. For example, this tutorial uses IoT Hub alert: {eventType}. If you can't see Dynamic content, select the Add dynamic content hyperlink to toggle the Dynamic content view on or off.

    After selecting eventType, you'll see the email form output so far. Select the Send and email (V2) to edit the body of your email.

    Screenshot of the condensed body output form.

    • Body: Write the text for your email. Select JSON properties from the selector tool to include dynamic content based on event data. If you can't see the Dynamic content, select the Add dynamic content hyperlink under the Body text box. If it doesn't show you the fields you want, click more in the Dynamic content screen to include the fields from the previous action.

    Your email template may look like this example:

    Screenshot of how to create an event email in the template.

  7. Select Save in the Logic Apps Designer.

Copy the HTTP URL

Before you leave the Logic Apps Designer, copy the URL that your logic app is listening to for a trigger. You use this URL to configure Event Grid.

  1. Expand the When a HTTP request is received trigger configuration box by clicking on it.

  2. Copy the value of HTTP POST URL by selecting the copy button next to it.

    Copy the HTTP POST URL

  3. Save this URL so that you can refer to it in the next section.

Configure subscription for IoT Hub events

In this section, you configure your IoT Hub to publish events as they occur.

  1. In the Azure portal, navigate to your IoT hub. You can find your IoT hub by selecting IoT Hub from your Azure dashboard, then select your IoT hub instance from the list of resources.

  2. Select Events.

    Open the Event Grid details

  3. Select Event subscription.

    Create new event subscription

  4. Create the event subscription with the following values:

    1. In the EVENT SUBSCRIPTION DETAILS section:

      1. Provide a name for the event subscription.
      2. Select Event Grid Schema for Event Schema.
    2. In the TOPIC DETAILS section:

      1. Confirm that the Topic type is set to IoT Hub.
      2. Confirm that the name of the IoT hub is set as the value for the Source Resource field.
      3. Enter a name for the system topic that will be created for you. To learn about system topics, see Overview of system topics.
    3. In the EVENT TYPES section:

      1. Select the Filter to Event Types drop-down.

      2. Deselect the Device Created and Device Deleted checkboxes, leaving only the Device Connected and Device Disconnected checkboxes selected.

        select subscription event types

    4. In the ENDPOINT DETAILS section:

      1. Select Endpoint Type as Web Hook.
      2. Click select an endpoint, paste the URL that you copied from your logic app, and confirm selection.

      select endpoint url

      When you're done, the pane should look like the following example:

      Screenshot of your 'Create Event Subscription' page in the Azure portal.

  5. Select Create.

Simulate a new device connecting and sending telemetry

Test your logic app by quickly simulating a device connection using the Azure CLI.

  1. Select the Cloud Shell button to reopen your terminal.

  2. Run the following command to create a simulated device identity:

    az iot hub device-identity create --device-id simDevice --hub-name {YourIoTHubName}
    

    The processing could take a minute. You'll see a JSON printout in your console once it's created.

  3. Run the following command to simulate connecting your device to IoT Hub and sending telemetry:

    az iot device simulate -d simDevice -n {YourIoTHubName}
    
  4. When the simulated device connects to IoT Hub, you'll receive an email notifying you of a "DeviceConnected" event.

  5. When the simulation completes, you'll receive an email notifying you of a "DeviceDisconnected" event.

    Screenshot of the email you should receive.

Clean up resources

This tutorial used resources that incur charges on your Azure subscription. When you're finished trying out the tutorial and testing your results, disable or delete resources that you don't want to keep.

To delete all of the resources created in this tutorial, delete the resource group.

  1. Select Resource groups, then select the resource group you created for this tutorial.

  2. On the Resource group pane, select Delete resource group. You're prompted to enter the resource group name, and then you can delete it. All of the resources contained therein are also removed.

Next steps

For a complete list of supported Logic App connectors, see the