Freigeben über

Azure Device Update for IoT Hub Restclientbibliothek für JavaScript – Version 1.0.0

  • Artikel

Die Bibliothek bietet Zugriff auf das Geräteupdate für IoT Hub Dienst, mit dem Kunden Updates für ihre IoT-Geräte in der Cloud veröffentlichen und diese Updates dann auf ihren Geräten bereitstellen können (Updates für Gruppen von Geräten genehmigen, die in IoT Hub verwaltet und bereitgestellt werden).

Verlassen Sie sich auf die Dokumentation des Diensts und unsere REST-Clientdokumentation, um diese Bibliothek zu verwenden.

Wichtige Links:

Erste Schritte

Die derzeitig unterstützten Umgebungen

  • Node.js Version 14.x.x oder höher

Voraussetzungen

  • Microsoft Azure-Abonnement: Um Microsoft Azure-Dienste aufzurufen, müssen Sie ein Azure-Abonnement erstellen
  • Geräteupdate für IoT Hub Instanz
  • Azure IoT Hub-Instanz

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

Installieren Sie die Azure Iot Device Update-Clientbibliothek für JavaScript mit npm:

npm install @azure-rest/iot-device-update

Erstellen und Authentifizieren eines DeviceUpdate

Um Azure Active Directory-Tokenanmeldeinformationen (AAD) zu verwenden, geben Sie eine Instanz des gewünschten Anmeldeinformationstyps an, der aus der @azure-/Identitätsbibliothek abgerufen wird.

Um sich bei AAD zu authentifizieren, müssen Sie zuerst npm installieren @azure/identity.

Nach der Installation können Sie auswählen, welche Art von @azure/identityAnmeldeinformationen verwendet werden sollen. Als Beispiel kann DefaultAzureCredential verwendet werden, um den Client zu authentifizieren:

Legen Sie die Werte der Client-ID, Mandanten-ID und geheimen Clientschlüssel der AAD-Anwendung als Umgebungsvariablen fest: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET

Verwenden Sie die zurückgegebenen Tokenanmeldeinformationen, um den Client zu authentifizieren:

import DeviceUpdate from "@azure-rest/iot-device-update";
import { DefaultAzureCredential } from "@azure/identity";
const client = DeviceUpdate(
  "https://<my-instance-id>.api.adu.microsoft.com",
  new DefaultAzureCredential()
);

Wichtige Begriffe

REST-Client

Dieser Client ist einer unserer REST-Kunden. Es wird dringend empfohlen, hier zu lesen, wie Sie einen REST-Client verwenden.

Beispiele

Im folgenden Abschnitt erfahren Sie, wie Sie Ihren Client initialisieren und authentifizieren und dann alle Geräte abrufen.

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

async function main() {
  console.log("== List devices ==");
  const client = DeviceUpdate(endpoint, new DefaultAzureCredential());

  const result = await client
    .path("/deviceupdate/{instanceId}/management/devices", instanceId)
    .get();

  console.log(result);
}

main().catch(console.error);

Problembehandlung

Protokollierung

Die Aktivierung der Protokollierung kann hilfreiche Informationen über Fehler aufdecken. Um ein Protokoll von HTTP-Anforderungen und -Antworten anzuzeigen, legen Sie die Umgebungsvariable AZURE_LOG_LEVEL auf info fest. Alternativ kann die Protokollierung zur Laufzeit aktiviert werden, indem Sie setLogLevel in @azure/logger aufrufen:

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

setLogLevel("info");

Ausführlichere Anweisungen zum Aktivieren von Protokollen finden Sie in der Paketdokumentation zu @azure/logger.

Nächste Schritte

Mitwirken

Wenn Sie an dieser Bibliothek mitwirken möchten, lesen Sie die Anleitung für Mitwirkende, um mehr darüber zu erfahren, wie Sie den Code erstellen und testen können.

Aufrufe