Biblioteca de cliente do Azure iotHub para JavaScript – versão 6.3.0

  • Artigo

Este pacote contém um SDK isomórfico (executado tanto em Node.js como em browsers) para o cliente do Azure iotHub.

Utilize esta API para gerir os hubs IoT na sua subscrição do Azure.

Código fonte | Pacote (NPM) | Documentação | de referência da APIExemplos

Introdução

Ambientes atualmente suportados

Veja a nossa política de suporte para obter mais detalhes.

Pré-requisitos

Instalar o pacote @azure/arm-iothub

Instale a biblioteca de cliente do Azure iotHub para JavaScript com npm:

npm install @azure/arm-iothub

Criar e autenticar um IotHubClient

Para criar um objeto de cliente para aceder à API do IotHub do Azure, precisará do recurso do endpoint Azure iotHub e de um credential. O cliente do Azure iotHub pode utilizar as credenciais do Azure Active Directory para autenticar. Pode encontrar o ponto final do recurso do Azure iotHub no portal do Azure.

Pode autenticar com o Azure Active Directory com uma credencial da biblioteca de @azure/identidade ou de um Token do AAD existente.

Para utilizar o fornecedor DefaultAzureCredential mostrado abaixo ou outros fornecedores de credenciais fornecidos com o SDK do Azure, instale o @azure/identity pacote:

npm install @azure/identity

Também terá de registar uma nova aplicação do AAD e conceder acesso ao IotHub do Azure ao atribuir a função adequada ao principal de serviço (nota: funções como "Owner" não concederão as permissões necessárias). 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_IDAZURE_CLIENT_SECRET.

Para obter mais informações sobre como criar uma Aplicação Azure AD veja este guia.

const { IotHubClient } = require("@azure/arm-iothub");
const { DefaultAzureCredential } = require("@azure/identity");
// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new IotHubClient(new DefaultAzureCredential(), subscriptionId);

// For client-side applications running in the browser, use this code instead:
// const credential = new InteractiveBrowserCredential({
//   tenantId: "<YOUR_TENANT_ID>",
//   clientId: "<YOUR_CLIENT_ID>"
// });
// const client = new IotHubClient(credential, subscriptionId);

Pacote JavaScript

Para utilizar esta biblioteca de cliente no browser, primeiro tem de utilizar um bundler. Para obter detalhes sobre como fazê-lo, veja a nossa documentação de agrupamento.

Conceitos-chave

IotHubClient

IotHubClient é a interface principal para programadores que utilizam a biblioteca de cliente do Azure iotHub. Explore os métodos neste objeto de cliente para compreender as diferentes funcionalidades do serviço IotHub do Azure a que pode aceder.

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:

const { setLogLevel } = require("@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

Veja o diretório de exemplos para obter exemplos detalhados sobre como utilizar esta biblioteca.

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