Partilhar via

Azure Device Update for Hub IoT Rest Client library for JavaScript - version 1.0.0

  • Artigo

A biblioteca fornece acesso à Atualização de Dispositivos para Hub IoT serviço que permite aos clientes publicar atualizações para os respetivos dispositivos IoT na nuvem e, em seguida, implementar estas atualizações nos respetivos dispositivos (aprovar atualizações para grupos de dispositivos geridos e aprovisionados no Hub IoT).

Confie fortemente na documentação do serviço e nos nossos documentos de cliente REST para utilizar esta biblioteca

Ligações principais:

Introdução

Ambientes atualmente suportados

  • Node.js versão 14.x.x ou superior

Pré-requisitos

  • Subscrição do Microsoft Azure: para chamar os serviços do Microsoft Azure, tem de criar uma subscrição do Azure
  • Atualização de Dispositivos para Hub IoT instância
  • Hub IoT do Azure instância

Instalar o pacote @azure-rest/iot-device-update

Instale a biblioteca de cliente do Azure Iot Device Update para JavaScript com npm:

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

Criar e autenticar um DeviceUpdate

Para utilizar uma credencial de token do Azure Active Directory (AAD), forneça uma instância do tipo de credencial pretendido obtido a partir da biblioteca de @azure/identidade .

Para autenticar com o AAD, primeiro tem de npm instalar @azure/identity.

Após a instalação, pode escolher o tipo de credencial a utilizar @azure/identity . Por exemplo, DefaultAzureCredential pode ser utilizado para autenticar o cliente:

Defina os valores do ID de cliente, do ID do inquilino e do segredo do cliente da aplicação do AAD como variáveis de ambiente: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET

Utilize a credencial do token devolvido para autenticar o cliente:

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

Conceitos-chave

Cliente REST

Este cliente é um dos nossos clientes REST. Recomendamos vivamente que leia como utilizar um cliente REST aqui.

Exemplos

A secção seguinte mostra-lhe como inicializar e autenticar o cliente e, em seguida, obter todos os dispositivos.

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

Resolução de problemas

Registo

Ativar o registo pode ajudar a descobrir informações úteis sobre falhas. Para ver um registo de pedidos e respostas HTTP, defina a variável de AZURE_LOG_LEVEL ambiente como info. Em alternativa, o registo pode ser ativado no runtime ao chamar setLogLevel no @azure/logger:

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

setLogLevel("info");

Para obter instruções mais detalhadas sobre como ativar os registos, pode ver os documentos do pacote @azure/logger.

Passos seguintes

Contribuir

Se quiser contribuir para esta biblioteca, leia o guia de contribuição para saber mais sobre como criar e testar o código.

Impressões