Azure DeviceUpdate client library for JavaScript - version 1.1.0

This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure DeviceUpdate client.

Device Update for IoT Hub is an Azure service that enables customers to publish updates for their IoT devices to the cloud, and then deploy that update to their devices (approve updates to groups of devices managed and provisioned in IoT Hub). It leverages the proven security and reliability of the Windows Update platform, optimized for IoT devices. It works globally and knows when and how to update devices, enabling customers to focus on their business goals and let Device Update for IoT Hub handle the updates.

Key links:

Getting started

Currently supported environments

See our support policy for more details.

Prerequisites

Install the @azure/iot-device-update package

Install the Azure DeviceUpdate client library for JavaScript with npm:

npm install @azure/iot-device-update

Create and authenticate a DeviceUpdateClient

To create a client object to access the Azure DeviceUpdate API, you will need the endpoint of your Azure DeviceUpdate resource and a credential. The Azure DeviceUpdate client can use Azure Active Directory credentials to authenticate. You can find the endpoint for your Azure DeviceUpdate resource in the Azure Portal.

You can authenticate with Azure Active Directory using a credential from the @azure/identity library or an existing AAD Token.

To use the DefaultAzureCredential provider shown below, or other credential providers provided with the Azure SDK, please install the @azure/identity package:

npm install @azure/identity

You will also need to register a new AAD application and grant access to Azure DeviceUpdate by assigning the suitable role to your service principal (note: roles such as "Owner" will not grant the necessary permissions).

For more information about how to create an Azure AD Application check out this guide.

Using Node.js and Node-like environments, you can use the DefaultAzureCredential class to authenticate the client.

import { DeviceUpdateClient } from "@azure/iot-device-update";
import { DefaultAzureCredential } from "@azure/identity";

const client = new DeviceUpdateClient("<endpoint>", new DefaultAzureCredential(), "<instanceId>");

For browser environments, use the InteractiveBrowserCredential from the @azure/identity package to authenticate.

import { InteractiveBrowserCredential } from "@azure/identity";
import { DeviceUpdateClient } from "@azure/iot-device-update";

const credential = new InteractiveBrowserCredential({
  tenantId: "<YOUR_TENANT_ID>",
  clientId: "<YOUR_CLIENT_ID>",
});
const client = new DeviceUpdateClient("<endpoint>", credential, "<instanceId>");

JavaScript Bundle

To use this client library in the browser, first you need to use a bundler. For details on how to do this, please refer to our bundling documentation.

Key concepts

DeviceUpdateClient

DeviceUpdateClient is the primary interface for developers using the Azure DeviceUpdate client library. Explore the methods on this client object to understand the different features of the Azure DeviceUpdate service that you can access.

Troubleshooting

Logging

Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the AZURE_LOG_LEVEL environment variable to info. Alternatively, logging can be enabled at runtime by calling setLogLevel in the @azure/logger:

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

For more detailed instructions on how to enable logs, you can look at the @azure/logger package docs.

Contributing

If you'd like to contribute to this library, please read the contributing guide to learn more about how to build and test the code.

  • Last updated on