Azure DeviceUpdate bibliothèque client pour JavaScript - version 1.1.0

Ce paquet contient un SDK isomorphe (exécuté à la fois dans Node.js et dans les navigateurs) pour Azure client DeviceUpdate.

Device Update for IoT Hub est un service Azure qui permet aux clients de publier les mises à jour de leurs appareils IoT dans le cloud, puis de déployer cette mise à jour sur leurs appareils (approuver les mises à jour de groupes d’appareils gérés et provisionnés dans IoT Hub). Elle mise à profit la sécurité et la fiabilité éprouvées de la plateforme Windows Update, optimisée pour les appareils IoT. Il fonctionne à l’échelle mondiale et sait quand et comment mettre à jour les appareils, permettant aux clients de se concentrer sur leurs objectifs métier et de laisser Device Update for IoT Hub gérer les mises à jour.

Liens clés :

Premiers pas

Environnements actuellement pris en charge

Pour plus d’informations, consultez notre de stratégie de support .

Prerequisites

Installer le package @azure/iot-device-update

Installez la bibliothèque client Azure DeviceUpdate pour JavaScript avec npm:

npm install @azure/iot-device-update

Créer et authentifier un DeviceUpdateClient

Pour créer un objet client afin d’accéder à l’API Azure DeviceUpdate, vous aurez besoin de la endpoint ressource Azure DeviceUpdate et d’un credentialfichier . Le client Azure DeviceUpdate peut utiliser les identifiants Azure Active Directory pour s’authentifier. Vous pouvez trouver le point de terminaison pour votre ressource Azure DeviceUpdate dans le Portail Azure.

Vous pouvez vous authentifier auprès d’Azure Active Directory à l’aide d’informations d’identification à partir de la bibliothèque de @azure/identité ou un jeton AAD existant.

Pour utiliser le fournisseur DefaultAzureCredential indiqué ci-dessous ou d’autres fournisseurs d’informations d’identification fournis avec le Kit de développement logiciel (SDK) Azure, installez le package :

npm install @azure/identity

Vous devrez également enregistrer une nouvelle application AAD et accorder l’accès à Azure DeviceUpdate en attribuant le rôle approprié à votre responsable de service (note : des rôles tels "Owner" que ne délivreront pas les autorisations nécessaires).

Pour plus d’informations sur la création d’une application Azure AD, consultez ce guide.

À l’aide de Node.js et d’environnements de type Nœud, vous pouvez utiliser la classe DefaultAzureCredential pour authentifier le client.

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

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

Pour les environnements de navigateur, utilisez le InteractiveBrowserCredential à partir du package @azure/identity pour l’authentification.

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

Offre groupée JavaScript

Pour utiliser cette bibliothèque cliente dans le navigateur, vous devez d’abord utiliser un bundler. Pour plus d’informations sur la procédure à suivre, reportez-vous à notre documentation de regroupement .

Concepts clés

DeviceUpdateClient

DeviceUpdateClientest l’interface principale pour les développeurs utilisant la bibliothèque client Azure DeviceUpdate. Explorez les méthodes sur cet objet client pour comprendre les différentes fonctionnalités du service Azure DeviceUpdate auxquelles vous pouvez accéder.

Résolution des problèmes

Logging

L’activation de la journalisation peut vous aider à découvrir des informations utiles sur les échecs. Pour afficher un journal des requêtes et réponses HTTP, définissez la variable d’environnement AZURE_LOG_LEVEL sur info. Vous pouvez également activer la journalisation au moment de l’exécution en appelant setLogLevel dans la @azure/logger:

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

setLogLevel("info");

Pour obtenir des instructions plus détaillées sur l’activation des journaux, vous pouvez consulter la documentationdu package @azure/enregistreur d’événements.

Contribuer

Si vous souhaitez contribuer à cette bibliothèque, lisez le guide de contribution pour en savoir plus sur la génération et le test du code.

  • Last updated on