Azure DeviceUpdate Client-Bibliothek für JavaScript - Version 1.1.0

Dieses Paket enthält ein isomorphes SDK (läuft sowohl in Node.js als auch in Browsern) für Azure DeviceUpdate-Client.

Device Update für IoT Hub ist ein Azure-Dienst, der es Kunden ermöglicht, Updates für ihre IoT-Geräte in die Cloud zu veröffentlichen und diese dann auf ihre Geräte auszurollen (Updates für Gruppen von Geräten, die im IoT Hub verwaltet und bereitgestellt werden, zu genehmigen). Sie nutzt die bewährte Sicherheit und Zuverlässigkeit der Windows Update-Plattform, die für IoT-Geräte optimiert ist. Es arbeitet global und weiß, wann und wie Geräte aktualisiert werden müssen, sodass Kunden sich auf ihre Geschäftsziele konzentrieren und Device Update for IoT Hub die Updates übernehmen können.

Wichtige Links:

Erste Schritte

Derzeit unterstützte Umgebungen

Weitere Informationen finden Sie in unserer Supportrichtlinie.

Voraussetzungen

Installieren Sie das @azure/iot-device-update-Paket

Installiere die Azure DeviceUpdate Client-Bibliothek für JavaScript mit npm:

npm install @azure/iot-device-update

Erstellen und Authentifizieren einer DeviceUpdateClient

Um ein Client-Objekt zu erstellen, das auf die Azure DeviceUpdate API zugriff, benötigen Sie die endpoint von Ihrer Azure DeviceUpdate-Ressource und eine credential. Der Azure DeviceUpdate-Client kann Azure Active Directory-Anmeldedaten zur Authentifizierung verwenden. Den Endpunkt für deine Azure DeviceUpdate-Ressource findest du im Azure-Portal.

Sie können sich mit Azure Active Directory mithilfe einer Anmeldeinformationen aus der @azure/Identitätsbibliothek oder einem vorhandenen AAD-Tokenauthentifizieren.

Um den unten gezeigten DefaultAzureCredential Anbieter oder andere Anmeldeinformationsanbieter zu verwenden, die mit dem Azure SDK bereitgestellt werden, installieren Sie bitte das @azure/identity Paket:

npm install @azure/identity

Sie müssen außerdem eine neue AAD-Anwendung registrieren und Zugang zu Azure DeviceUpdate gewähren, indem Sie die passende Rolle Ihrem Service Principal zuweisen (Hinweis: Rollen wie diese "Owner" gewähren nicht die erforderlichen Berechtigungen).

Weitere Informationen zum Erstellen einer Azure AD-Anwendung finden Sie diesem Leitfaden.

Mithilfe von Node.js- und Node-ähnlichen Umgebungen können Sie die DefaultAzureCredential Klasse verwenden, um den Client zu authentifizieren.

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

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

Verwenden Sie für Browserumgebungen die InteractiveBrowserCredential aus dem @azure/identity Paket, um sich zu authentifizieren.

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-Bündel

Um diese Clientbibliothek im Browser zu verwenden, müssen Sie zuerst einen Bundler verwenden. Ausführliche Informationen dazu finden Sie in unserer Bündelungsdokumentation.

Zentrale Konzepte

DeviceUpdateClient

DeviceUpdateClientist die primäre Schnittstelle für Entwickler, die die Client-Bibliothek von Azure DeviceUpdate verwenden. Erkunden Sie die Methoden auf diesem Client-Objekt, um die verschiedenen Funktionen des Azure DeviceUpdate-Dienstes zu verstehen, auf die Sie zugreifen können.

Troubleshooting

Protokollierung

Das Aktivieren der Protokollierung kann hilfreiche Informationen zu Fehlern aufdecken. Um ein Protokoll von HTTP-Anforderungen und -Antworten anzuzeigen, legen Sie die AZURE_LOG_LEVEL Umgebungsvariable auf infofest. Alternativ kann die Protokollierung zur Laufzeit durch Aufrufen von setLogLevel im @azure/loggeraktiviert werden:

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

setLogLevel("info");

Ausführlichere Anweisungen zum Aktivieren von Protokollen finden Sie in den @azure/Logger-Paketdokumenten.

Contributing

Wenn Sie an dieser Bibliothek mitwirken möchten, lesen Sie bitte den mitwirkenden Leitfaden, um mehr über das Erstellen und Testen des Codes zu erfahren.

  • Last updated on