Azure DeviceUpdate client library for JavaScript - versie 1.1.0

Dit pakket bevat een isomorfe SDK (draait zowel in Node.js als in browsers) voor Azure DeviceUpdate-client.

Device Update for IoT Hub is een Azure-dienst waarmee klanten updates voor hun IoT-apparaten naar de cloud kunnen publiceren en die updates vervolgens op hun apparaten kunnen uitrollen (zoals het goedkeuren van updates voor groepen apparaten die beheerd en geprovisioneerd zijn in IoT Hub). Het maakt gebruik van de bewezen beveiliging en betrouwbaarheid van het Windows Update-platform, geoptimaliseerd voor IoT-apparaten. Het werkt wereldwijd en weet wanneer en hoe apparaten te updaten, waardoor klanten zich kunnen richten op hun bedrijfsdoelen en Device Update for IoT Hub de updates kunnen afhandelen.

Sleutelkoppelingen:

Aan de slag

Momenteel ondersteunde omgevingen

Zie ons ondersteuningsbeleid voor meer informatie.

Prerequisites

Het @azure/iot-device-update-pakket installeren

Installeer de Azure DeviceUpdate clientbibliotheek voor JavaScript met npm:

npm install @azure/iot-device-update

Een DeviceUpdateClient maken en verifiëren

Om een clientobject te maken dat toegang krijgt tot de Azure DeviceUpdate API, heb je de endpoint van je Azure DeviceUpdate-resource en een credential. De Azure DeviceUpdate-client kan Azure Active Directory-credentials gebruiken om te authenticeren. Je kunt het eindpunt voor je Azure DeviceUpdate-resource vinden in de Azure Portal.

U kunt verifiëren met Azure Active Directory met behulp van een referentie uit de @azure/identiteit-bibliotheek of een bestaand AAD-token.

Als u de DefaultAzureCredential- provider wilt gebruiken die hieronder wordt weergegeven, of andere referentieproviders die zijn opgegeven bij de Azure SDK, installeert u het @azure/identity-pakket:

npm install @azure/identity

Je moet ook een nieuwe AAD-applicatie registreren en toegang verlenen tot Azure DeviceUpdate door de geschikte rol toe te wijzen aan je diensthoofd (opmerking: rollen zoals "Owner" geven niet de benodigde rechten).

Raadpleeg deze handleidingvoor meer informatie over het maken van een Azure AD-toepassing.

Met Node.js- en Node-achtige omgevingen kunt u de DefaultAzureCredential-klasse gebruiken om de client te verifiëren.

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

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

Gebruik voor browseromgevingen de InteractiveBrowserCredential uit het @azure/identity-pakket om te verifiëren.

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-bundel

Als u deze clientbibliotheek in de browser wilt gebruiken, moet u eerst een bundelaar gebruiken. Raadpleeg onze bundeldocumentatievoor meer informatie over hoe u dit doet.

belangrijke concepten

DeviceUpdateClient

DeviceUpdateClientis de primaire interface voor ontwikkelaars die de Azure DeviceUpdate clientbibliotheek gebruiken. Verken de methoden op dit clientobject om de verschillende functies van de Azure DeviceUpdate-service te begrijpen waar je toegang toe hebt.

Problemen oplossen

Loggen

Het inschakelen van logboekregistratie kan helpen nuttige informatie over fouten te ontdekken. Als u een logboek met HTTP-aanvragen en -antwoorden wilt zien, stelt u de omgevingsvariabele AZURE_LOG_LEVEL in op info. U kunt logboekregistratie ook tijdens runtime inschakelen door setLogLevel aan te roepen in de @azure/logger:

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

setLogLevel("info");

Voor meer gedetailleerde instructies over het inschakelen van logboeken, kunt u de @azure/logger pakketdocumentenbekijken.

Contributing

Als u een bijdrage wilt leveren aan deze bibliotheek, leest u de gids voor bijdragen voor meer informatie over het bouwen en testen van de code.