@azure/arm-iotcentral
TypeScript icon, indicating that this package has built-in type declarations

6.0.0 • Public • Published

Azure IotCentral client library for JavaScript

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

Use this API to manage IoT Central Applications in your Azure subscription.

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

Getting started

Currently supported environments

Prerequisites

Install the @azure/arm-iotcentral package

Install the Azure IotCentral client library for JavaScript with npm:

npm install @azure/arm-iotcentral

Create and authenticate a IotCentralClient

To create a client object to access the Azure IotCentral API, you will need the endpoint of your Azure IotCentral resource and a credential. The Azure IotCentral client can use Azure Active Directory credentials to authenticate. You can find the endpoint for your Azure IotCentral 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 IotCentral 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 out this guide.

const { IotCentralClient } = require("@azure/arm-iotcentral");
const { DefaultAzureCredential } = require("@azure/identity");
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new IotCentralClient(new DefaultAzureCredential(), 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 our bundling documentation.

Key concepts

IotCentralClient

IotCentralClient is the primary interface for developers using the Azure IotCentral client library. Explore the methods on this client object to understand the different features of the Azure IotCentral 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:

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 the samples directory for detailed examples on how to use this library.

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.

Related projects

Impressions

Package Sidebar

Install

npm i @azure/arm-iotcentral

Weekly Downloads

358

Version

6.0.0

License

MIT

Unpacked Size

481 kB

Total Files

118

Last publish

Collaborators

  • microsoft1es
  • amarzavery
  • vladbarosan
  • veronicagg
  • azure-sdk