Azure CLI を使用して IoT Hub ファイルのアップロードを構成する

この記事では、Azure CLI を使用して IoT ハブ上でファイルのアップロードを構成する方法を示します。

IoT Hub でファイルのアップロード機能を使用するには、最初に Azure ストレージ アカウントと BLOB コンテナーを IoT Hub に関連付ける必要があります。 IoT Hub により、ファイルをアップロードするときにデバイスで使用する、この BLOB コンテナーへの書き込みアクセス許可を含む SAS URI が自動的に生成します。 ストレージ アカウントと BLOB コンテナーに加えて、SAS URI の有効期限と、Azure Storage で IoT Hub が使用する認証の種類を設定できます。 IoT Hub でバックエンド サービスに配信できる、オプションのファイル アップロード通知の設定を構成することもできます。

前提条件

• アクティブな Azure アカウントアカウントがない場合、Azure 試用版にサインアップして、最大 10 件の無料 Mobile Apps を入手できます。 アカウントがない場合は、 無料アカウント を数分で作成することができます。

• Azure サブスクリプション内の IoT ハブ。 ハブがまだない場合は、「IoT ハブの作成」の手順に従うことができます。

• Azure Storage のアカウント Azure Storage アカウントを持っていない場合は、Azure CLI を使用して作成できます。 詳しくは、「ストレージ アカウントの作成」をご覧ください。

• Azure Cloud Shell で Bash 環境を使用します。 詳細については、「Azure Cloud Shell の Bash のクイックスタート」を参照してください。

  

• CLI リファレンス コマンドをローカルで実行する場合、Azure CLI をインストールします。 Windows または macOS で実行している場合は、Docker コンテナーで Azure CLI を実行することを検討してください。 詳細については、「Docker コンテナーで Azure CLI を実行する方法」を参照してください。

  • ローカル インストールを使用する場合は、az login コマンドを使用して Azure CLI にサインインします。 認証プロセスを完了するには、ターミナルに表示される手順に従います。 その他のサインイン オプションについては、Azure CLI でのサインインに関するページを参照してください。

  • 初回使用時にインストールを求められたら、Azure CLI 拡張機能をインストールします。 拡張機能の詳細については、Azure CLI で拡張機能を使用する方法に関するページを参照してください。

  • az version を実行し、インストールされているバージョンおよび依存ライブラリを検索します。 最新バージョンにアップグレードするには、az upgrade を実行します。

サインインして Azure アカウントを設定する

Azure アカウントにサインインしてサブスクリプションを選択します。 Azure Cloud Shell を使用している場合は、既にサインインしているはずです。ただし、複数のサブスクリプションがある場合は、引き続き Azure サブスクリプションの選択が必要になる場合があります。

1. コマンド プロンプトで、ログイン コマンドを実行します。

   az login
   

   指示に従って、コードを使用して認証し、Web ブラウザーで Azure アカウントにサインインします。

2. 複数の Azure サブスクリプションがある場合は、Azure にサインインすると、資格情報に関連付けられているすべてのAzure アカウントへのアクセスが許可されます。 以下の、利用できる Azure アカウントを一覧表示するコマンドを使用します。

   az account list
   

   以下のコマンドを使用して、コマンドを実行して IoT ハブを作成するために使用するサブスクリプションを選択します。 前のコマンドの出力から、サブスクリプション名または ID のいずれかを使用できます。

   az account set --subscription {your subscription name or id}
   

ストレージ アカウントの詳細を取得する

次の手順は、ストレージ アカウントが、クラシック デプロイ モデルではなく Resource Manager デプロイ モデルを使用して作成されていることを前提としています。

デバイスからファイル アップロードを構成するには、Azure Storage アカウント用の接続文字列が必要です。 Azure Storage アカウントは、IoT Hub と同じサブスクリプション内にある必要があります。 また、ストレージ アカウントには BLOB コンテナーの名前も必要です。 ストレージ アカウント キーを取得するには、次のコマンドを使用します。

az storage account show-connection-string --name {your storage account name} \
  --resource-group {your storage account resource group}

接続文字列は、次の出力のようになります。

{
  "connectionString": "DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName={your storage account name};AccountKey={your storage account key}"
}

connectionString の値を書き留めておきます。 これは、以降の手順で必要です。

ファイル アップロード用の既存の BLOB コンテナーを使用するか、新しいものを作成します。

• ストレージ アカウントの既存の BLOB コンテナーの一覧を表示するには、次のコマンドを使用します。

  az storage container list --connection-string "{your storage account connection string}"
  

• ストレージ アカウントに BLOB コンテナーを作成するには、次のコマンドを使用します。

  az storage container create --name {container name} \
    --connection-string "{your storage account connection string}"
  

IoT Hub を構成する

これでストレージ アカウントの詳細を使用して、IoT Hub を構成することで、ファイルを IoT Hub にアップロードする機能を有効化できるようになりました。

構成するには次の値が必要です。

• ストレージ コンテナー: IoT Hub に関連付ける、現在の Azure サブスクリプションの Azure ストレージ アカウントの BLOB コンテナー。 必要なストレージ アカウント情報は、前のセクションで取得しました。 IoT Hub により、ファイルをアップロードするときにデバイスで使用する、この BLOB コンテナーへの書き込みアクセス許可を含む SAS URI が自動的に生成します。

• Receive notifications for uploaded files (アップロードされたファイルに関する通知を受け取る) : ファイルのアップロードに関する通知を有効または無効にします。

• SAS TTL: IoT Hub によりデバイスに返される SAS URI の有効期間を設定します。 既定では 1 時間に設定されています。

• File notification settings default TTL (ファイルの通知設定 既定の TTL) : 有効期限が切れるまでのファイルのアップロード通知の有効期限です。 既定では 1 日に設定されています。

• File notification maximum delivery count (ファイルの通知設定 最大配信回数) : IoT Hub がファイルのアップロード通知の配信を試行する回数です。 既定では 10 に設定されています。

• File notification lock duration (ファイルの通知設定 ロック期間) : ファイル通知キューのロック期間です。 既定では 60 秒に設定されています。

• 認証の種類: Azure Storage で使用する IoT Hub の認証の種類です。 この設定により、IoT ハブが Azure Storage で認証および認可する方法が決定します。 既定値はキーベースの認証です。ただし、システム割り当ておよびユーザー割り当てマネージド ID も使用できます。 マネージド ID は、Microsoft Entra ID で自動的に管理される ID を安全な方法で Azure サービスに提供します。 IoT ハブと Azure Storage アカウントでマネージド ID を構成する方法については、「IoT Hub でのマネージド ID のサポート」を参照してください。 構成が完了したら、Azure Storage での認証に使用するためにマネージド ID のいずれかを設定できます。

  注意

  認証の種類の設定は、IoT ハブが Azure Storage アカウントで認証する方法を構成します。 デバイスは、IoT ハブから取得した SAS URI を使用して、常に Azure Storage で認証されます。

次のコマンドでは、IoT ハブでファイルのアップロード設定を構成する方法を示しています。 これらのコマンドはわかりやすくするために個別に示されますが、通常は、シナリオに必要なすべてのパラメーターを含めて 1 つのコマンドを発行します。 コマンド ラインに表示する引用符を含めます。 中かっこは含めません。 各パラメーターの詳細については、Azure CLI ドキュメントで az iot hub update コマンドについて参照してください。

次のコマンドでは、ストレージ アカウントと BLOB コンテナーを構成します。

az iot hub update --name {your iot hub name} \
    --fileupload-storage-connectionstring "{your storage account connection string}" \
    --fileupload-storage-container-name "{your container name}" 

次のコマンドでは、SAS URI の有効期限を既定値 (1 時間) に設定します。

az iot hub update --name {your iot hub name} \
    --fileupload-sas-ttl 1 

次のコマンドでは、ファイル通知を有効にし、ファイル通知プロパティを既定値に設定します。 (ファイル アップロード通知の有効期限は 1 時間に設定され、ロック期間は 60 秒に設定されます。)

az iot hub update --name {your iot hub name} \
    --fileupload-notifications true  \
    --fileupload-notification-max-delivery-count 10 \
    --fileupload-notification-ttl 1 \
    --fileupload-notification-lock-duration 60

次のコマンドでは、キーベースの認証を構成します。

az iot hub update --name {your iot hub name} \
    --fileupload-storage-auth-type keyBased

次のコマンドでは、IoT ハブのシステム割り当てマネージド ID を使用して認証を構成します。 このコマンドを実行する前に、IoT ハブのシステム割り当てマネージド ID を有効にして、Azure Storage アカウントに適切な RBAC ロールを付与する必要があります。 詳細については、「IoT Hub でのマネージド ID のサポート」を参照してください。

az iot hub update --name {your iot hub name} \
    --fileupload-storage-auth-type identityBased \
    --fileupload-storage-identity [system] 

次のコマンドでは、IoT ハブで構成されているユーザー割り当てマネージド ID を取得し、そのうちのいずれかを使用した認証を構成します。 ユーザー割り当てマネージド ID を使用して認証するには、事前にそれを IoT ハブで構成し、Azure Storage アカウントに適切な RBAC ロールを付与する必要があります。 詳細と手順については、「IoT Hub でのマネージド ID のサポート」を参照してください。

IoT ハブでユーザー割り当てマネージド ID を照会するには、az iot hub identity show コマンドを使用します。

az iot hub identity show --name {your iot hub name} --query userAssignedIdentities

このコマンドでは、IoT ハブで構成されたユーザー割り当てマネージド ID のコレクションを返します。 次の出力では、1 つのユーザー割り当てマネージド ID を含むコレクションを示しています。

{
  "/subscriptions/{your subscription ID}/resourcegroups/{your resource group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{your user-assigned managed identity name}": 
  {
    "clientId": "<client ID GUID>",
    "principalId": "<principal ID GUID>"
  }
}

次のコマンドでは、上記のユーザー割り当て ID を使用する認証を構成します。

az iot hub update --name {your iot hub name} \
    --fileupload-storage-auth-type identityBased \
    --fileupload-storage-identity  "/subscriptions/{your subscription ID}/resourcegroups/{your resource group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{your user-assigned managed identity name}"

次のコマンドを使用して、IoT ハブの設定を確認できます。

az iot hub show --name {your iot hub name}

ファイルのアップロード設定のみを確認するには、次のコマンドを使用します。

az iot hub show --name {your iot hub name}
    --query '[properties.storageEndpoints, properties.enableFileUploadNotifications, properties.messagingEndpoints.fileNotifications]'

Azure CLI のコマンドで名前付きパラメーターを使用するのが最も簡単です。ただし、--set パラメーターを使用してファイルのアップロード設定を構成することもできます。 次のコマンドは、その方法を理解するために役立ちます。

az iot hub update --name {your iot hub name} \
  --set properties.storageEndpoints.'$default'.connectionString="{your storage account connection string}"

az iot hub update --name {your iot hub name} \
  --set properties.storageEndpoints.'$default'.containerName="{your storage container name}"

az iot hub update --name {your iot hub name} \
  --set properties.storageEndpoints.'$default'.sasTtlAsIso8601=PT1H0M0S

az iot hub update --name {your iot hub name} \
  --set properties.enableFileUploadNotifications=true

az iot hub update --name {your iot hub name} \
  --set properties.messagingEndpoints.fileNotifications.maxDeliveryCount=10

az iot hub update --name {your iot hub name} \
  --set properties.messagingEndpoints.fileNotifications.ttlAsIso8601=PT1H0M0S

次のステップ

• デバイス概要からファイルをアップロードする
• IoT Hub でのマネージド ID のサポート
• ファイル アップロードのハウツー ガイド
• Azure CLI の az iot hub update、az iot hub identity show、az iot hub create コマンド