Azure Device Update for IoT Hub Rest Client library for JavaScript - バージョン 1.0.0

  • [アーティクル]

このライブラリは、お客様が IoT デバイスの更新プログラムをクラウドに発行し、それらの更新プログラムをデバイスに展開できるようにする IoT Hub サービスの Device Update にアクセスできるようにします (IoT Hubで管理およびプロビジョニングされたデバイスのグループに対する更新プログラムを承認します)。

このライブラリを使用するには、 サービスのドキュメント と REST クライアント ドキュメント に大きく依存してください

主要リンク:

作業の開始

現在サポートされている環境

  • バージョン 14.x.x 以降をNode.jsする

前提条件

  • Microsoft Azure サブスクリプション: Microsoft Azure サービスを呼び出すには、Azure サブスクリプションを作成する必要があります
  • IoT Hub インスタンスの Device Update
  • Azure IoT Hub インスタンス

@azure-rest/iot-device-update パッケージのインストール

を使用して、JavaScript 用の Azure Iot Device Update クライアント ライブラリを npmインストールします。

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

DeviceUpdate を作成して認証する

Azure Active Directory (AAD) トークン資格情報を使用するには、@azure/ID ライブラリから取得した目的の資格情報の種類のインスタンスを指定します。

AAD で認証するには、まず npm をインストール @azure/identityする必要があります。

インストール後、使用する 資格情報 の種類を @azure/identity 選択できます。 たとえば、 DefaultAzureCredential を使用してクライアントを認証できます。

AAD アプリケーションのクライアント ID、テナント ID、クライアント シークレットの値を環境変数として設定します(AZURE_CLIENT_ID、AZURE_TENANT_ID、AZURE_CLIENT_SECRET

返されたトークン資格情報を使用して、クライアントを認証します。

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

主要な概念

REST クライアント

このクライアントは、REST クライアントの 1 つです。 REST クライアントの使用方法については、 こちらを参照することを強くお勧めします。

例

次のセクションでは、クライアントを初期化して認証し、すべてのデバイスを取得する方法を示します。

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

トラブルシューティング

ログの記録

ログの記録を有効にすると、エラーに関する有用な情報を明らかにするのに役立つ場合があります。 HTTP 要求と応答のログを表示するには、環境変数 AZURE_LOG_LEVEL を info に設定します。 または、@azure/logger で setLogLevel を呼び出して、実行時にログ記録を有効にすることもできます。

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

setLogLevel("info");

ログを有効にする方法の詳細については、@azure/logger パッケージに関するドキュメントを参照してください。

次の手順

共同作成

このライブラリに投稿する場合、コードをビルドしてテストする方法の詳細については、投稿ガイドを参照してください。

インプレッション数