Skip to content

Latest commit

 

History

History
192 lines (134 loc) · 11 KB

tutorial-deployiothub.md

File metadata and controls

192 lines (134 loc) · 11 KB
title description author
Deploy an Azure IoT Hub
Deploy an Azure IoT Hub using an ARM template

Tutorial: Deploy an Azure IoT Hub

In this tutorial, you learn how to:

  • Deploy an Azure Resource Group using PowerShell
  • Deploy an Azure IoT Hub using an ARM template
  • Deploy an Azure Storage Account using an ARM template

In this tutorial you'll create an IoT Hub and an associated storage account using an Azure Resource Manager (ARM) template. Following the diagram below using the machine you configured in the previous tutorial:

  1. Create an Azure Resource Group for your IoT Hub
  2. Deploy IoT Hub and a Storage Account

lnk_deployiothub

A resource group is a logical container in Azure that allows you to group related resources that you want to manage as a single unit. Resource groups provide a way to manage, deploy, monitor, and delete resources in Azure. There are several reasons to use a resource group:

  • Organization. A resource group help you organize your Azure resources in a logical and meaningful way, which can make it easier to manage and understand your Azure infrastructure.
  • Cost management. It is used to manage costs associated with your Azure resources. For example, you can use a resource group to monitor and track the costs of your resources, and apply tags to your resources to help you better understand how your costs are being incurred.
  • Resource management. Resource groups provide a convenient way to manage the lifecycle of your Azure resources. For example, you can use a resource group to deploy, update, and delete resources as a group, rather than managing them individually.
  • Access control. It is used to control access to your Azure resources. For example, you can use resource policies or role-based access control to grant or restrict access to specific resource groups or resources within them.

IoT hub is a service that acts as a communication bridge between devices on an IoT network and a cloud-based server. It enables devices to send and receive data, and facilitates communication between devices and other systems. Below are IoT reasons to use an IoT hub:

  • Device management. IoT Hub enables you to manage and monitor your IoT devices, including provisioning, updating, and de-provisioning devices.
  • Scalability. It can handle a large number of connected devices, making it easy to scale up as the number of devices increases.
  • Security. It provides a secure connection between devices and the cloud, which is important for protecting sensitive data and maintaining the integrity of the system.
  • Integration with Azure services. IoT Hub can be easily integrated with other Azure services, such as Azure Stream Analytics, Azure Functions, and Azure Machine Learning, which can be useful for building more complex IoT solutions.
  • Customizable routing. It allows you to configure custom routes to send device data to different endpoints, such as storage or event hubs.
  • Ease of use. An IoT hub makes it easy to manage and communicate with a large number of devices, as it provides a single point of access and a standardized communication protocol.
  • Reliability. It can provide a reliable and robust communication channel between devices and the cloud, which is important for maintaining the continuity of the system.

Azure Storage is a cloud-based service that provides access to IoT types of storage services:

  • Blob storage. Used to store unstructured data such as images, videos, and documents.
  • File storage. Used to store files and enables file-based workloads using the standard SMB 3.0 protocol.
  • Table storage. Used to store structured NoSQL data.
  • Queue storage. Used to store and retrieve large numbers of messages to enable communication between web services.

An Azure Storage Account provides a unique namespace to store and access your data. It also provides a set of keys to access the data and implements security measures to control access to your data. The benefits of using an Azure Storage Account:

  • Scalability. Azure Storage can scale to meet the needs of your application, making it easy to store and access large amounts of data.
  • Durability. It is designed to provide high availability and durability for your data, with multiple copies of your data stored in multiple locations to protect against data loss.
  • Cost-effectiveness. It provides a cost-effective solution for storing and accessing data, with flexible pricing options and the ability to pay only for what you use.
  • Integration. It integrates with other Azure services, making it easy to build end-to-end solutions that span multiple Azure services.
  • Security. It provides IoT security features to protect your data, including encryption, access control, and network security.

All tutorials involving deploying or creating an Azure service focus on using an ARM (Azure Resource Manager) template rather than the Azure portal user interface. An ARM template is a JSON file that defines the infrastructure and configuration for an Azure solution. You'll find tutorial ARM templates in your forked GitHub repo at {Forked GitHub root directory}\arm, for example c:\repos\IoT\arm. There are several benefits to using an ARM template to deploy services:

  • Reusability. An ARM template is used to deploy resources consistently and repeatably, which is especially useful when deploying the same resources across multiple environments (e.g., development, staging, production).
  • Version control. It can be stored in a version control system, such as Git, which allows you to track changes to the infrastructure over time and roll back to previous versions if needed.
  • Collaboration. It can be shared and collaborated on by multiple team members, which can be useful when working on complex projects with multiple dependencies.
  • Automation. ARM templates are used to automate the deployment of resources, which can save time and reduce the risk of errors.
  • Consistency. It can help ensure that resources are deployed consistently across environments, which can be especially important for maintaining compliance with corporate standards or regulatory requirements.

No need to avoid using the Azure portal user interfaces entirely as it is a great way to visualize any Azure service and all its settings.

Prerequisites

Create an Azure Resource Group for your IoT Hub

In this section you'll create a resource group for your IoT Hub and Storage Account. Before starting all tutorials, be sure to open Visual Studio (VS) Code, select the Terminal > New Terminal... menu and Authenticate your Azure Subscription using the PowerShell (PS) session.

  1. From your VS code PS terminal session, run the following script to set a new resource group name to the $rg powershell variable. Replace {new resource group name} with the new name of your resource group.

    $projectName = "{new hub project name}"
$rg = ($projectName + "RG")

    For example,

    PS > $projectName = "HubMsg"
PS > $rg = ($projectName + "RG")

  2. Run the following script to set the PowerShell variable to a region location for your resource group. Replace {region location} with the location of your resource group.

    $location = "{region location}"

    For example,

    $location = "Central US"

  3. Run the following script to create a new resource group

    New-AzResourceGroup -Name $rg -Location $location

    For example,

    PS > New-AzResourceGroup -Name $rg -Location $location

ResourceGroupName : myMessagingRG
Location          : centralus
ProvisioningState : Succeeded
Tags              : 
ResourceId        : /subscriptions/d330xxxx-xxxx-xxxx-xxxx-xxxxxxxxabda/resourceGroups/myMessagingRG

Deploy IoT Hub and a Storage Account

In this section you'll deploy an Azure IoT Hub and a Storage Account. Before starting, verify your PowerShell variables are set in your PS session:

  • $rg
  • $projectName
  • $location

For example,

PS> $location
Central US

  1. Run the following script to set the path to the ARM template hub.json. Be sure to replace the text {path to your IoT Hub ARM template} in the sample below.

    $templateFile = "{path to your IoT Hub ARM template}"

    For example,

    PS > $templateFile = "C:\repos\IoT\arm\hub.json"

  2. Deploy the hub ARM template

    New-AzResourceGroupDeployment `
-ResourceGroupName $rg `
-TemplateFile $templateFile `
-projectName $projectName `
-location $location

    For example,

    New-AzResourceGroupDeployment `
-ResourceGroupName $rg `
-TemplateFile $templateFile `
-projectName $projectName `
-location $location

  3. Check the status of your deployment by opening the Azure Portal and following the diagram below. 1️⃣ Open the resource group you created earlier in this tutorial. 2️⃣ Select Settings > Deployments in the left pane, then 3️⃣ select your hyperlinked deployment name.

    lnk_checkdeployment

Resources

Be sure to read more about the following code and concept references you used in this tutorial.

Explore More

You can optionally explore and learn more about deploying Azure services by doing the following:

  1. Modify the ARM template to deploy IoT Hub
  2. Create your own ARM template

Next Steps

Tutorial: Create a Simulated Device