Getting an Azure IoT Hub Connector Up and Running

This topic provides a short list of expected installations before you begin. It provides an overview of the installation steps and provides a checklist that you may want to refer to as you go through the steps to get a new Azure IoT Hub Connector up and running. For upgrade procedures, refer to the following topics:

• To upgrade an existing v.4.1.0 Connector to version 4.2.0, refer to Upgrading the Azure IoT Hub Connector from 4.1.0 to 4.2.0.

• To upgrade an existing v.4.0.0 Connector to version 4.1.0, refer to Upgrading the Azure IoT Hub Connector from 4.0.x to 4.1.x

• To upgrade an existing v.3.0.0 Connector to version 4.0.0, refer to Upgrading the Azure IoT Hub Connector from 3.0.0 to 4.0.0.

• To upgrade an existing v.2.0.x Connector to version 3.0.0, refer to Upgrading the Azure IoT Hub Connector from 2.0.x to 3.0.0.

Installation Overview and Checklist

The following diagram presents an overview of the main steps of the installation, configuration, and testing procedures:

Here is a checklist that links you to the procedures to follow:

1. Create and Configure Items in Azure IoT, using your Microsoft Azure IoT account.

2. Download and Extract the Azure IoT Hub Connector

3. Import the Extensions

4. Create Security Entities for the Connector

5. Create Azure IoT Entities in ThingWorx Composer

6. Configure the Connector

The configuration topics apply to use of the Connector with Azure IoT Edge devices and the use of the Connector with the ThingWorx Microsoft Azure Industrial IoT (IIoT) OPC UA integration. All of these uses of the Connector are supported by v.4.1.x and 4.2.x. Where necessary, steps specific to configuration for the ThingWorx Azure IIoT OPC UA integration have been added to the following topics.

a. Before You Begin Configuration

b. Installing the Connector in Firewalled Environments

c. Minimal Configuration for Connecting to a ThingWorx Platform in Single-Server Mode

d. High Availability Configuration

e. Configuration Properties Reference

7. Encrypt the Configuration File

8. Set the Environment Variables for the Azure IoT Hub Connector

9. Run the Service to Grant Permissions and Visibility to the Connector

10. Start the Azure IoT Hub Connector

11. Run the Smoke Test