Azure DeviceUpdate client library for JavaScript - verze 1.1.0

Tento balíček obsahuje izomorfní SDK (běží jak v Node.js, tak v prohlížečích) pro klienta Azure DeviceUpdate.

Device Update pro IoT Hub je služba Azure, která umožňuje zákazníkům publikovat aktualizace pro jejich IoT zařízení do cloudu a poté je nasazovat do svých zařízení (schvalovat aktualizace skupin zařízení spravovaných a zadaných v IoT Hub). Využívá ověřenou bezpečnost a spolehlivost platformy služba Windows Update, optimalizované pro IoT zařízení. Funguje globálně a ví, kdy a jak aktualizovat zařízení, což umožňuje zákazníkům soustředit se na své obchodní cíle a nechat Device Update for IoT Hub spravovat aktualizace.

Klíčové odkazy:

Začínáme

Aktuálně podporovaná prostředí

Další podrobnosti najdete v zásadách podpory.

Prerequisites

  • Předplatné služby Azure.

Nainstalujte balíček @azure/iot-device-update.

Nainstalujte klientskou knihovnu Azure DeviceUpdate pro JavaScript s npm:

npm install @azure/iot-device-update

Vytvořte a ověřte DeviceUpdateClient

Pro vytvoření klientského objektu pro přístup k Azure DeviceUpdate API budete potřebovat svůj endpoint Azure DeviceUpdate zdroj a .credential Klient Azure DeviceUpdate může použít přihlašovací údaje Azure Active Directory k autentizaci. Koncový bod pro váš zdroj Azure DeviceUpdate najdete v Azure Portal.

Pomocí Azure Active Directory se můžete ověřit pomocí přihlašovacích údajů z knihovny @azure/identity nebo existujícího tokenu AAD.

Pokud chcete použít poskytovatele DefaultAzureCredential zobrazené níže nebo jiné zprostředkovatele přihlašovacích údajů poskytnuté sadou Azure SDK, nainstalujte balíček @azure/identity:

npm install @azure/identity

Budete také muset zaregistrovat novou aplikaci AAD a udělit přístup k Azure DeviceUpdate přiřazením vhodné role vašemu principálovi služby (poznámka: role jako například "Owner" neudělí potřebná oprávnění).

Další informace o tom, jak vytvořit aplikaci Azure AD, najdete v této příručce.

Pomocí Node.js a prostředí podobných uzlům můžete k ověření klienta použít třídu DefaultAzureCredential.

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

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

Pro prostředí prohlížeče použijte k ověření InteractiveBrowserCredential z balíčku @azure/identity.

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

JavaScriptový balíček

Pokud chcete tuto klientskou knihovnu použít v prohlížeči, musíte nejprve použít bundler. Podrobnosti o tom, jak to udělat, najdete v naší dokumentaci sdružování.

Klíčové koncepty

DeviceUpdateClient

DeviceUpdateClientje hlavní rozhraní pro vývojáře využívající klientskou knihovnu Azure DeviceUpdate. Prozkoumejte metody na tomto klientském objektu, abyste pochopili různé funkce služby Azure DeviceUpdate, ke kterým máte přístup.

Troubleshooting

Logování

Povolení protokolování může pomoct odhalit užitečné informace o chybách. Pokud chcete zobrazit protokol požadavků a odpovědí HTTP, nastavte proměnnou prostředí AZURE_LOG_LEVEL na info. Případně můžete protokolování povolit za běhu voláním setLogLevel v @azure/logger:

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

setLogLevel("info");

Podrobnější pokyny k povolení protokolů najdete v dokumentaci k @azure/protokolovacímu balíčku.

Contributing

Pokud chcete přispívat do této knihovny, přečtěte si průvodce přispívání a přečtěte si další informace o vytváření a testování kódu.

  • Last updated on