Skip to content

Commit

Permalink
azure-int-docs (helium#632)
Browse files Browse the repository at this point in the history
how-to docs for azure int
  • Loading branch information
jdgemm authored Sep 22, 2021
1 parent 2900203 commit 4c37f39
Show file tree
Hide file tree
Showing 6 changed files with 61 additions and 1 deletion.
58 changes: 58 additions & 0 deletions docs/use-the-network/console/integrations/azure.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
id: azure
sidebar_label: Azure IoT Hub
slug: /use-the-network/console/integrations/azure
---

# Azure IoT Hub

import useBaseUrl from "@docusaurus/useBaseUrl";

[Microsoft Azure IoT Hub](https://azure.microsoft.com/en-us/overview/iot/#overview) enables highly secure and reliable communication between your Internet of Things (IoT) application and the devices it manages.

## On Azure IoT Hub
Prior to setting up an integration in Console, the following Azure IoT Hub information is required:

- Hub Name
- Policy Name
- Primary Key

Log into your Azure IoT Hub account and on the left hand menu go to "Shared access policies".

Console requires the following permissions.
- Registry Read: query Azure for devices in your hub
- Registry Write: create devices in your hub
- Device Connect: send messages through http/mqtt to your azure device

The `iothubowner` policy includes those by default, if you want to create another policy, just make sure it has the 3 permissions listed above.

Whatever policy you choose, click it and a pane will appear. Copy the `Primary Key` information.

## On Console
To add the integration in Console, go to **Integrations** on the left-hand menu.

Click the **Add** integration button.
<img
src={useBaseUrl(
"img/use-the-network/console/integrations/integrations-add-helium-console.png"
)}
/>


Choose the **Azure IoT** integration icon.
<img
src={useBaseUrl(
"img/use-the-network/console/integrations/integrations-azure-helium-console.png"
)}
/>

Enter the Azure IoT Hub information into the corresponding fields on Console:

- `Hostname` (enter IoT Hub Hub Name)
- `Shared Access Key Name` (enter IoT Hub Policy Name)
- `Shared Access Key` (enter IoT Hub Primary Key)

Remember the policy must have the following permissions enabled on your Azure IoT Hub: Registry Read, Registry Write, and Device Connect.

## Adding a device
Every time the Azure IoT Hub integration starts up on Console, it will check if the device exists on IoT Hub, and if it doesn’t it will create one.
2 changes: 2 additions & 0 deletions docs/use-the-network/console/integrations/integrations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ Node elements (devices, labels, integrations) need to be created before they're

[MQTT](/use-the-network/console/integrations/mqtt)

[Microsoft Azure IoT Hub](/use-the-network/console/integrations/azure)

[AWS IoT Core](/use-the-network/console/integrations/aws-iot-core)

[Cargo](/use-the-network/console/integrations/cargo)
Expand Down
2 changes: 1 addition & 1 deletion sidebarsDocs.js
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ module.exports = {
{
type: 'category',
label: 'Integrations',
items: ['use-the-network/console/integrations/json-schema', 'use-the-network/console/integrations/http', 'use-the-network/console/integrations/mqtt', 'use-the-network/console/integrations/aws-iot-core', 'use-the-network/console/integrations/cargo', 'use-the-network/console/integrations/datacake', 'use-the-network/console/integrations/mydevices-cayenne', 'use-the-network/console/integrations/adafruitio', 'use-the-network/console/integrations/ubidots', 'use-the-network/console/integrations/tago', 'use-the-network/console/integrations/google-sheets', 'use-the-network/console/integrations/microshare'],
items: ['use-the-network/console/integrations/json-schema', 'use-the-network/console/integrations/http', 'use-the-network/console/integrations/mqtt', 'use-the-network/console/integrations/azure', 'use-the-network/console/integrations/aws-iot-core', 'use-the-network/console/integrations/cargo', 'use-the-network/console/integrations/datacake', 'use-the-network/console/integrations/mydevices-cayenne', 'use-the-network/console/integrations/adafruitio', 'use-the-network/console/integrations/ubidots', 'use-the-network/console/integrations/tago', 'use-the-network/console/integrations/google-sheets', 'use-the-network/console/integrations/microshare'],
collapsed: false,
},
],
Expand Down
Binary file modified static/img/use-the-network/console/console-integrations-add.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4c37f39

Please sign in to comment.