Azure iotDps client library for JavaScript - version 6.0.0

Det här paketet innehåller en isomorfisk SDK (körs både i Node.js och i webbläsare) för Azure iotDPS-klienten.

API för att använda funktionerna i Azure IoT Hub Device Provisioning Service.

Nyckellänkar:

Komma igång

Miljöer som stöds för närvarande

Mer information finns i vår supportprincip.

Förutsättningar

Installera @azure/arm-deviceprovisioningservices-paketet

Installera Azure iotDps-klientbiblioteket för JavaScript med npm:

npm install @azure/arm-deviceprovisioningservices

Skapa och autentisera en IotDpsClient

Om du vill skapa ett klientobjekt för att få åtkomst till Azure iotDPS-API:et behöver du för endpoint din Azure iotDps-resurs och en credential. Azure iotDPS-klienten kan använda Azure Active Directory-autentiseringsuppgifter för att autentisera. Du hittar slutpunkten för din Azure iotDPS-resurs i Azure-portalen.

Du kan autentisera med Azure Active Directory med hjälp av en autentiseringsuppgift från biblioteket @azure/identitet eller en befintlig AAD-token.

Installera -paketet om du vill använda @azure/identity som visas nedan eller andra leverantörer av autentiseringsuppgifter som tillhandahålls med Azure SDKs:

npm install @azure/identity

Du måste också registrera ett nytt AAD-program och bevilja åtkomst till Azure iotDPS genom att tilldela lämplig roll till tjänstens huvudnamn (observera att roller som inte beviljar de behörigheter som "Owner" krävs).

Mer information om hur du skapar ett Azure AD-program finns i den här guiden.

Med hjälp av Node.js- och Node-liknande miljöer kan du använda klassen DefaultAzureCredential för att autentisera klienten.

import { IotDpsClient } from "@azure/arm-deviceprovisioningservices";
import { DefaultAzureCredential } from "@azure/identity";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new IotDpsClient(new DefaultAzureCredential(), subscriptionId);

För webbläsarmiljöer använder du InteractiveBrowserCredential från @azure/identity-paketet för att autentisera.

import { InteractiveBrowserCredential } from "@azure/identity";
import { IotDpsClient } from "@azure/arm-deviceprovisioningservices";

const credential = new InteractiveBrowserCredential({
  tenantId: "<YOUR_TENANT_ID>",
  clientId: "<YOUR_CLIENT_ID>",
});
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new IotDpsClient(credential, subscriptionId);

JavaScript-paket

Om du vill använda det här klientbiblioteket i webbläsaren måste du först använda en bundler. Mer information om hur du gör detta finns i vår paketeringsdokumentation.

Viktiga begrepp

IotDpsClient (på engelska)

IotDpsClient är det primära gränssnittet för utvecklare som använder Azure iotDPS-klientbiblioteket. Utforska metoderna för det här klientobjektet för att förstå de olika funktionerna i Azure iotDPS-tjänsten som du kan komma åt.

Troubleshooting

Logging

Aktivering av loggning kan hjälpa dig att hitta användbar information om fel. Om du vill se en logg med HTTP-begäranden och svar anger du AZURE_LOG_LEVEL miljövariabeln till info. Du kan också aktivera loggning vid körning genom att anropa setLogLevel i @azure/logger:

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

setLogLevel("info");

Mer detaljerade anvisningar om hur du aktiverar loggar finns i dokument för @azure/logger-paket.

Nästa steg

Ta en titt på exempel katalog för detaljerade exempel på hur du använder det här biblioteket.

Contributing

Om du vill bidra till det här biblioteket kan du läsa bidragsguide för att lära dig mer om hur du skapar och testar koden.

  • Last updated on