Usługa Azure Device Update dla biblioteki klienta REST IoT Hub dla języka JavaScript — wersja 1.0.0
Biblioteka zapewnia dostęp do usługi Device Update for IoT Hub, która umożliwia klientom publikowanie aktualizacji dla urządzeń IoT w chmurze, a następnie wdrażanie tych aktualizacji na urządzeniach (zatwierdzanie aktualizacji grup urządzeń zarządzanych i aprowizowania w IoT Hub).
W dużej mierze polegaj na dokumentacji usługi i dokumentacji klienta REST , aby korzystać z tej biblioteki
Linki kluczowe:
Wprowadzenie
Obecnie obsługiwane środowiska
- Node.js w wersji 14.x.x lub nowszej
Wymagania wstępne
- Subskrypcja platformy Microsoft Azure: aby wywoływać usługi platformy Microsoft Azure, musisz utworzyć subskrypcję platformy Azure
- Aktualizacja urządzenia dla wystąpienia IoT Hub
- wystąpienie Azure IoT Hub
Instalowanie pakietu @azure-rest/iot-device-update
Zainstaluj bibliotekę klienta usługi Azure Iot Device Update dla języka JavaScript przy użyciu polecenia npm
:
npm install @azure-rest/iot-device-update
Tworzenie i uwierzytelnianie DeviceUpdate
Aby użyć poświadczeń tokenu usługi Azure Active Directory (AAD), podaj wystąpienie żądanego typu poświadczeń uzyskanego z biblioteki @azure/tożsamości .
Aby przeprowadzić uwierzytelnianie za pomocą usługi AAD, należy najpierw npm
zainstalować program @azure/identity
.
Po zakończeniu instalacji można wybrać typ poświadczeń@azure/identity
do użycia.
Na przykład wartość DefaultAzureCredential może służyć do uwierzytelniania klienta:
Ustaw wartości identyfikatora klienta, identyfikatora dzierżawy i klucza tajnego klienta aplikacji usługi AAD jako zmienne środowiskowe: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET
Użyj zwróconego poświadczenia tokenu, aby uwierzytelnić klienta:
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()
);
Kluczowe pojęcia
Klient REST
Ten klient jest jednym z naszych klientów REST. Zdecydowanie zalecamy zapoznanie się z tym, jak używać klienta REST tutaj.
Przykłady
W poniższej sekcji przedstawiono sposób inicjowania i uwierzytelniania klienta, a następnie pobierania wszystkich urządzeń.
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);
Rozwiązywanie problemów
Rejestrowanie
Włączenie rejestrowania może pomóc odkryć przydatne informacje o błędach. Aby wyświetlić dziennik żądań i odpowiedzi HTTP, ustaw zmienną AZURE_LOG_LEVEL
środowiskową na info
. Alternatywnie rejestrowanie można włączyć w czasie wykonywania, wywołując setLogLevel
polecenie w pliku @azure/logger
:
import { setLogLevel } from "@azure/logger";
setLogLevel("info");
Aby uzyskać bardziej szczegółowe instrukcje dotyczące włączania dzienników, zapoznaj się z dokumentami dotyczącymi pakietów @azure/rejestratora.
Następne kroki
Współtworzenie
Jeśli chcesz współtworzyć tę bibliotekę, przeczytaj przewodnik współtworzenia , aby dowiedzieć się więcej na temat tworzenia i testowania kodu.
Powiązane projekty
Azure SDK for JavaScript