Azure DeviceUpdate biblioteka klienta dla JavaScript - wersja 1.1.0

Ten pakiet zawiera izomorficzne SDK (działające zarówno w Node.js, jak i w przeglądarkach) dla klienta DeviceUpdate Azure.

Device Update dla IoT Hub to usługa Azure, która umożliwia klientom publikowanie aktualizacji dla ich urządzeń IoT w chmurze, a następnie wdrażanie tych aktualizacji na ich urządzenia (zatwierdzanie aktualizacji dla grup urządzeń zarządzanych i przydzielonych w IoT Hub). Wykorzystuje sprawdzone bezpieczeństwo i niezawodność platformy Windows Update, zoptymalizowanej pod kątem urządzeń IoT. Działa globalnie i wie, kiedy i jak zaktualizować urządzenia, umożliwiając klientom skupienie się na celach biznesowych i pozwalanie Device Update for IoT Hub na zarządzanie aktualizacją.

Kluczowe linki:

Rozpoczęcie pracy

Obecnie obsługiwane środowiska

  • Wersje LTS systemu Node.js
  • Najnowsze wersje przeglądarek Safari, Chrome, Edge i Firefox.

Aby uzyskać więcej informacji, zobacz nasze zasad pomocy technicznej.

Prerequisites

Instalowanie pakietu @azure/iot-device-update

Zainstaluj bibliotekę klienta Azure DeviceUpdate dla JavaScript z :npm

npm install @azure/iot-device-update

Twórz i uwierzytelnij DeviceUpdateClient

Aby utworzyć obiekt klienta do dostępu do API Azure DeviceUpdate, będziesz potrzebować zasobu endpoint Azure DeviceUpdate oraz .credential Klient Azure DeviceUpdate może używać poświadczeń Azure Active Directory do uwierzytelniania. Punkt końcowy dla swojego zasobu Azure DeviceUpdate znajdziesz w Azure Portal.

Możesz uwierzytelnić się w usłudze Azure Active Directory przy użyciu poświadczeń z biblioteki @azure/tożsamości lub istniejącego tokenu usługi AAD.

Aby użyć dostawcy DefaultAzureCredential pokazanego poniżej lub innych dostawców poświadczeń dostarczonych z zestawem Azure SDK, zainstaluj pakiet @azure/identity:

npm install @azure/identity

Będziesz także musiał zarejestrować nową aplikację AAD i przyznać dostęp do Azure DeviceUpdate, przypisując odpowiednią rolę swojemu podmiotowi usługi (uwaga: role takie jak E-Link "Owner" nie przyznają niezbędnych uprawnień).

Aby uzyskać więcej informacji na temat tworzenia aplikacji usługi Azure AD, zobacz tym przewodniku.

Korzystając ze środowisk Node.js i środowisk podobnych do węzłów, możesz użyć klasy DefaultAzureCredential do uwierzytelniania klienta.

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

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

W przypadku środowisk przeglądarki użyj InteractiveBrowserCredential z pakietu @azure/identity do uwierzytelniania.

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>");

Pakiet JavaScript

Aby użyć tej biblioteki klienta w przeglądarce, najpierw należy użyć pakietu. Aby uzyskać szczegółowe informacje o tym, jak to zrobić, zapoznaj się z naszą dokumentacją dotyczącą tworzenia pakietów .

Kluczowe pojęcia

DeviceUpdateClient

DeviceUpdateClientjest głównym interfejsem dla deweloperów korzystających z biblioteki klienta Azure DeviceUpdate. Poznaj metody tego obiektu klienta, aby zrozumieć różne funkcje usługi Azure DeviceUpdate, do których masz dostęp.

Troubleshooting

Logowanie

Włączenie rejestrowania może pomóc odkryć przydatne informacje o błędach. Aby wyświetlić dziennik żądań i odpowiedzi HTTP, ustaw zmienną środowiskową AZURE_LOG_LEVEL na info. Alternatywnie rejestrowanie można włączyć w czasie wykonywania, wywołując setLogLevel w @azure/logger:

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

setLogLevel("info");

Aby uzyskać bardziej szczegółowe instrukcje dotyczące włączania dzienników, zapoznaj się z dokumentacją pakietu @azure/logger.

Contributing

Jeśli chcesz współtworzyć tę bibliotekę, przeczytaj przewodnik dotyczący współtworzenia , aby dowiedzieć się więcej na temat tworzenia i testowania kodu.

  • Last updated on