az iot device registration

プレビュー

Note

このリファレンスは、Azure CLI (バージョン 2.73.0 以降) の azure-iot 拡張機能の一部です。拡張機能は、az iot device registration コマンドを初めて実行すると、自動的にインストールされます。拡張機能の詳細については、を参照してください。

このコマンドグループはプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

Azure IoT Hub Device Provisioning Service (DPS) を使用してデバイスを登録します。

個人またはグループの登録に対して作成を使用し、承認された登録に従う操作の状態を使用します。対称キーまたは X.509 証明書を使用してデバイスを認証します。サービス登録レコードと登録状態管理は、 az iot dpsの下に残ります。

コマンド

Name	説明	型	状態
az iot device registration create	デバイスを登録し、必要に応じてその操作証明書を発行します。	Extension	Preview
az iot device registration operation-status	DPS デバイス登録操作の状態を表示します。	Extension	Preview

az iot device registration create

プレビュー

コマンドグループ "IoT デバイスの登録" はプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

デバイスを登録し、必要に応じてその操作証明書を発行します。

個々の登録の場合は、そのデバイスの --symmetric-key を指定します。グループ登録の場合は、--compute-key を使用してグループキーを指定するか、既に派生したデバイスキーを --compute-key なしで指定します。または、--dps-name と --auth-type ログインを使用して ID スコープ/エンドポイントを検出し、登録キーを取得します。グループ登録の --group-id と --compute-key を追加します。 Entra ログインは、デバイス登録要求ではなく、このブートストラップ検索を承認します。

明示的なデバイス資格情報と共に --id-scope を使用して、DPS リソースの検出をスキップします。既定以外のプロビジョニングエンドポイントを使用する場合は、--host を設定します。 X.509 認証の場合は、--certificate-file-path と --key-file-path を指定します。秘密キーが暗号化されている場合にのみ、--パスフレーズを追加します。

--csr (エイリアス --csr-file-path) を追加して、運用証明書を要求します。 PEM または base64 DER PKCS #10 をインラインまたはファイルから受け入れます。 CSR 署名は有効で、共通名は --registration-id と一致している必要があります。CSR では、デバイスの対称キーまたは X.509 認証は置き換えられません。

このコマンドは、受け入れられた登録をポーリングし、Retry-After を受け入れます。操作 ID を受信した後にタイムアウトになる場合は、その ID と同じ登録 ID、ID スコープ、エンドポイント、デバイス認証で操作状態を使用します。タイムアウトはバックエンド操作を取り消しません。作成を盲目的に再実行しないでください。 --timeout は、事前 ID スコープとブートストラップ資格情報の検出後に、CSR と非 CSR の両方の登録 (ワーカーの起動、HTTP 再試行、ポーリングなど) に対して、同じ REST フローにハード期限を適用します。タイムアウトがないと、既存の境界付き 5 分間のポーリング動作が保持されます。

JSON 出力では、DPS から返されたときに発行されたCertificateChain と connectionProfile と、レジストリデバイスの相関関係に対する registryDeviceExternalId が保持されます。 2026-11-02-preview RegisterDeviceAndIssueCertificate コントラクトは、発行されたCertificateChain をバイトの配列としてのみ記述し、ワイヤエンコードまたは証明書の順序を定義しません。したがって、このコマンドは JSON 出力でそのフィールドを保持しますが、証明書ファイル出力オプションは提供しません。推測チェーンを記述すると、TLS 対応ではないバンドルまたは誤って順序付けられたバンドルが生成される可能性があります。 --endorsement-key と --storage-root-key は高度な要求スキーマフィールドとして保持されますが、このコントラクトにはクライアント TPM チャレンジプロトコルがないため、TPM のみの認証は明示的にサポートされていません。

az iot device registration create --registration-id --rid
                                  [--acquire-policy-token]
                                  [--auth-type {key, login}]
                                  [--certificate-file-path --cp]
                                  [--change-reference]
                                  [--ck --compute-key]
                                  [--csr --csr-file-path]
                                  [--dps-name]
                                  [--endorsement-key]
                                  [--enrollment-group-id --gid --group-id]
                                  [--host --provisioning-host]
                                  [--id-scope --scope]
                                  [--key --symmetric-key]
                                  [--key-file-path --kp]
                                  [--login]
                                  [--pass --passphrase]
                                  [--payload]
                                  [--resource-group]
                                  [--storage-root-key]
                                  [--timeout]

例

Entra で承認されたブートストラップキー参照を使用して個々の登録を登録する

az iot device registration create --dps-name MyDps --resource-group MyResourceGroup \
  --registration-id device-01 --auth-type login

Entra で承認されたブートストラップキー参照を使用してグループメンバーを登録する

az iot device registration create --dps-name MyDps --registration-id device-01 \
  --group-id MyEnrollmentGroup --compute-key --auth-type login

ブートストラップ検索を使用せずに、デバイスキーと既知の ID スコープに登録する

az iot device registration create --id-scope 0ne00000000 \
  --registration-id device-01 --symmetric-key DEVICE_KEY

登録グループキーからデバイスキーを派生させ、登録する

az iot device registration create --id-scope 0ne00000000 \
  --registration-id device-01 --symmetric-key GROUP_KEY --compute-key

PEM CSR に対する運用証明書の登録と要求

az iot device registration create --id-scope 0ne00000000 --registration-id device-01 \
  --symmetric-key DEVICE_KEY --csr ./device-01.csr --timeout 120

X.509 デバイス証明書に登録する

az iot device registration create --id-scope 0ne00000000 \
  --registration-id device-01 --certificate-file-path ./device.pem \
  --key-file-path ./device-key.pem

必須パラメーター

--registration-id --rid

デバイス登録 ID または個々の登録 ID。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ	値
パラメーターグループ:	Global Policy Arguments

--auth-type

操作でポリシーキーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。既定値は、 az configure --defaults iothub-data-auth-type={auth-type-value}を使用して構成できます。

プロパティ	値
パラメーターグループ:	Access Control Arguments
規定値:	key
指定可能な値:	key, login

--certificate-file-path --cp

証明書 PEM ファイルへのパス。 x509 の登録に必要です。

プロパティ	値
パラメーターグループ:	x509 Authentication Arguments

--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ	値
パラメーターグループ:	Global Policy Arguments

--ck --compute-key

--symmetric-key から、または --dps-name/-login で --group-id で解決された登録グループキーから、デバイスごとのキーを計算します。 X.509 入力と組み合わせることはできません。

プロパティ	値
パラメーターグループ:	Symmetric Key Authentication Arguments
規定値:	False

--csr --csr-file-path

インライン PEM/base64 DER PKCS #10 CSR または CSR ファイルへのパス。署名は有効で、共通名は登録 ID と一致している必要があります。要求は、PEM ヘッダーなしで base64 DER を送信します。

プロパティ	値
パラメーターグループ:	Certificate Issuance Arguments

--dps-name -n

Azure IoT Hub Device Provisioning Service の名前。 --login が指定されていない場合、または認証引数と --id-scope が指定されていない場合は必須です。

プロパティ	値
パラメーターグループ:	DPS Identifier Arguments

--endorsement-key

サービススキーマによって保持される高度な TPM 要求フィールド。 --storage-root-key と共に使用する必要があります。 TPM のみのクライアント認証は、このコマンドではサポートされていません。

プロパティ	値
パラメーターグループ:	TPM Arguments

--enrollment-group-id --gid --group-id

登録グループ ID。認証引数を取得するためにのみ必要です。

--host --provisioning-host

DPS デバイスエンドポイント。省略すると、エンドポイントは選択した DPS リソースから派生し、グローバルエンドポイントにフォールバックします。

--id-scope --scope

Azure IoT Hub Device Provisioning Service の ID スコープ。 ID スコープは、デバイスエンドポイントを識別しません。--dps-name または --login は指定された場合でも解決されます。 --id-scope と明示的なデバイス資格情報のみで、文書化されたグローバルエンドポイントフォールバックが使用されます。

プロパティ	値
パラメーターグループ:	DPS Identifier Arguments

--key --symmetric-key

デバイス登録の対称共有アクセスキー。

プロパティ	値
パラメーターグループ:	Symmetric Key Authentication Arguments

--key-file-path --kp

キー PEM ファイルへのパス。 x509 の登録に必要です。

プロパティ	値
パラメーターグループ:	x509 Authentication Arguments

--login -l

このコマンドは、アクションを実行する権限を持つエンティティ接続文字列をサポートします。 "az login" によるセッションログインを回避するために使用します。エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --dps-name が指定されていない場合、または認証引数と --id-scope が指定されていない場合は必須です。

プロパティ	値
パラメーターグループ:	DPS Identifier Arguments

--pass --passphrase

X.509 秘密キーのパスフレーズ。 --certificate-file-path と --key-file-path の両方でのみ有効です。

プロパティ	値
パラメーターグループ:	x509 Authentication Arguments

--payload

JSON オブジェクトとしての登録ペイロードまたは JSON ファイルへのパス。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--storage-root-key

サービススキーマによって保持される高度な TPM 要求フィールド。 --endorsement-key と共に使用する必要があります。 TPM のみのクライアント認証は、このコマンドではサポートされていません。

プロパティ	値
パラメーターグループ:	TPM Arguments

--timeout

ワーカーの起動、HTTP、ポーリングなど、正の整数のハード REST 登録タイムアウト (秒単位)。予備 ID スコープとブートストラップ資格情報検出を除外します。

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az iot device registration operation-status