このライブラリは、IoT Hub 用の Device Update サービスへのアクセスを提供します。これにより、お客様は IoT デバイスの更新プログラムをクラウドに発行し、それらの更新プログラムを自分のデバイスにデプロイできます (IoT Hub で管理およびプロビジョニングされたデバイスのグループへの更新を承認します)。
このライブラリを使用するには、サービスのドキュメント と REST クライアント ドキュメント 大きく依存してください
主要なリンク:
- ソース コード の
- パッケージ (NPM)
- API リファレンス ドキュメントの
- 製品のドキュメント
はじめ
現在サポートされている環境
- Node.jsの LTS バージョンを する
前提 条件
- Microsoft Azure サブスクリプション: Microsoft Azure サービスを呼び出すには、Azure サブスクリプション を作成する必要があります
- Device Update for IoT Hub インスタンス
- Azure IoT Hub インスタンス
@azure-rest/iot-device-update パッケージをインストールする
npmを使用して JavaScript 用の Azure Iot Device Update クライアント ライブラリをインストールします。
npm install @azure-rest/iot-device-update
DeviceUpdate を作成して認証する
Azure Active Directory (AAD) トークン資格情報を使用するには、@azure/ID ライブラリから取得した目的の資格情報の種類のインスタンスを指定します。
AAD で認証するには、最初に @azure/identitynpm インストールする必要があります。
インストール後、使用する @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 endpoint = "https://<my-instance-id>.api.adu.microsoft.com";
const client = DeviceUpdate(endpoint, new DefaultAzureCredential());
主な概念
REST クライアント
このクライアントは、REST クライアントの 1 つです。 ここでは、REST クライアント の使用方法読み取うことを強くお勧めします。
例
次のセクションでは、クライアントを初期化して認証し、すべてのデバイスを取得する方法を示します。
import DeviceUpdate from "@azure-rest/iot-device-update";
import { DefaultAzureCredential } from "@azure/identity";
const endpoint = "https://<my-instance-id>.api.adu.microsoft.com";
const client = DeviceUpdate(endpoint, new DefaultAzureCredential());
const instanceId = "<my-instance-id>";
const result = await client.path("/deviceupdate/{instanceId}/management/devices", instanceId).get();
console.log(result);
トラブルシューティング
伐採
ログ記録を有効にすると、エラーに関する有用な情報を明らかにするのに役立つ場合があります。 HTTP 要求と応答のログを表示するには、AZURE_LOG_LEVEL 環境変数を infoに設定します。 または、@azure/loggerで setLogLevel を呼び出すことによって、実行時にログを有効にすることもできます。
import { setLogLevel } from "@azure/logger";
setLogLevel("info");
ログを有効にする方法の詳細な手順については、@azure/logger パッケージのドキュメントを参照してください。
次の手順
貢献
このライブラリに投稿する場合は、コードをビルドしてテストする方法の詳細については、投稿ガイド を参照してください。
関連プロジェクト
- Microsoft Azure SDK for JavaScript の
Azure SDK for JavaScript