Dela via

Azure Device Update för IoT Hub Rest Client-biblioteket för JavaScript – version 1.1.0

  • Artikel

Biblioteket ger åtkomst till enhetsuppdateringen för IoT Hub-tjänsten som gör det möjligt för kunder att publicera uppdateringar för sina IoT-enheter till molnet och sedan distribuera dessa uppdateringar till sina enheter (godkänna uppdateringar till grupper av enheter som hanteras och etableras i IoT Hub).

Förlitar du dig mycket på -tjänstens dokumentation och våra REST-klientdokument att använda det här biblioteket

Nyckellänkar:

Komma igång

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

Förutsättningar

  • Microsoft Azure-prenumeration: Om du vill anropa Microsoft Azure-tjänster måste du skapa en Azure-prenumeration
  • Enhetsuppdatering för IoT Hub-instans
  • Azure IoT Hub-instans

Installera @azure-rest/iot-device-update-paketet

Installera Azure Iot Device Update-klientbiblioteket för JavaScript med npm:

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

Skapa och autentisera en DeviceUpdate

Om du vill använda en AAD-tokenautentiseringsuppgifter (Azure Active Directory)anger du en instans av önskad typ av autentiseringsuppgifter som hämtats från @azure/identitetsbiblioteket.

Om du vill autentisera med AAD måste du först npm installera @azure/identity.

Efter installationen kan du välja vilken typ av autentiseringsuppgifter från @azure/identity att använda. Till exempel kan StandardAzureCredential användas för att autentisera klienten:

Ange värdena för klient-ID, klient-ID och klienthemlighet för AAD-programmet som miljövariabler: AZURE_CLIENT_ID, AZURE_TENANT_ID AZURE_CLIENT_SECRET

Använd den returnerade tokenautentiseringsuppgiften för att autentisera klienten:

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

const endpoint = "https://<my-instance-id>.api.adu.microsoft.com";
const client = DeviceUpdate(endpoint, new DefaultAzureCredential());

Viktiga begrepp

REST-klient

Den här klienten är en av våra REST-klienter. Vi rekommenderar starkt att du läser hur du använder en REST-klient här.

Exempel

I följande avsnitt visas hur du initierar och autentiserar klienten och sedan hämtar alla enheter.

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

const endpoint = "https://<my-instance-id>.api.adu.microsoft.com";
const client = DeviceUpdate(endpoint, new DefaultAzureCredential());

const instanceId = "<my-instance-id>";
const result = await client.path("/deviceupdate/{instanceId}/management/devices", instanceId).get();

console.log(result);

Felsökning

Skogsavverkning

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 @azure/logger-paketdokumenten.

Nästa steg

Bidragande

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.