Azure iotDps client library for JavaScript

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

API for using the Azure IoT Hub Device Provisioning Service features.

Source code |Package (NPM) |API reference documentation |Samples

Getting started

Currently supported environments

• LTS versions of Node.js
• Latest versions of Safari, Chrome, Edge and Firefox.

See oursupport policy for more details.

Prerequisites

• AnAzure subscription.

Install the@azure/arm-deviceprovisioningservices package

Install the Azure iotDps client library for JavaScript withnpm:

npm install @azure/arm-deviceprovisioningservices

Create and authenticate aIotDpsClient

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

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

To use theDefaultAzureCredential 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 toregister a new AAD application and grant access to Azure iotDps by assigning the suitable role to your service principal (note: roles such as"Owner" will not grant the necessary permissions).Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:AZURE_CLIENT_ID,AZURE_TENANT_ID,AZURE_CLIENT_SECRET.

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

const{ IotDpsClient}=require("@azure/arm-deviceprovisioningservices");const{ DefaultAzureCredential}=require("@azure/identity");// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.constsubscriptionId="00000000-0000-0000-0000-000000000000";constclient=newIotDpsClient(newDefaultAzureCredential(),subscriptionId);// For client-side applications running in the browser, use this code instead:// const credential = new InteractiveBrowserCredential({//   tenantId: "<YOUR_TENANT_ID>",//   clientId: "<YOUR_CLIENT_ID>"// });// const client = new IotDpsClient(credential, subscriptionId);

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 ourbundling documentation.

Key concepts

IotDpsClient

IotDpsClient is the primary interface for developers using the Azure iotDps client library. Explore the methods on this client object to understand the different features of the Azure iotDps 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 theAZURE_LOG_LEVEL environment variable toinfo. Alternatively, logging can be enabled at runtime by callingsetLogLevel in the@azure/logger:

const{ setLogLevel}=require("@azure/logger");setLogLevel("info");

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

Next steps

Please take a look at thesamples directory for detailed examples on how to use this library.

Contributing

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

Related projects

• Microsoft Azure SDK for JavaScript