az iot device registration

プレビュー
リファレンス

Note

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

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

IoT Device Provisioning Service の IoT デバイス登録を管理します。

登録を表示および削除する場合に使用 az iot dps enrollment registration または az iot dps enrollment-group registration 削除します。

コマンド

名前	説明	型	状態
az iot device registration create	IoT デバイスを IoT Device Provisioning Service に登録します。	拡張子	プレビュー

az iot device registration create

プレビュー

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

IoT デバイスを IoT Device Provisioning Service に登録します。

次の構成証明メカニズムがサポートされています。

対称キー
x509 証明書 x509 認証方法を使用する場合は、証明書とキーファイル (および必要に応じてパスフレーズ) を指定する必要があります。

az iot device registration create --registration-id
                                  [--auth-type {key, login}]
                                  [--certificate-file-path]
                                  [--ck]
                                  [--dps-name]
                                  [--enrollment-group-id]
                                  [--host]
                                  [--id-scope]
                                  [--key]
                                  [--key-file-path]
                                  [--login]
                                  [--pass]
                                  [--payload]
                                  [--resource-group]

例

個々の登録を使用して IoT デバイスを登録します。

az iot device registration create -n {dps_name} --rid {registration_id}

グループ登録を使用して IoT デバイスを登録します。

az iot device registration create -n {dps_name} --rid {registration_id} --gid {group_enrollment_id}

個々の登録、Device Provisioning Service ID スコープ、および指定された対称キーを使用して IoT デバイスを登録します。これにより、ID スコープと個別登録対称キーの取得がバイパスされます。

az iot device registration create --id-scope {id_scope} --rid {registration_id} --key {symmetric_key}

グループ登録、Device Provisioning Service ID スコープ、および指定された登録グループ対称キーを使用して IoT デバイスを登録します。これにより、ID スコープと登録グループの対称キーの取得がバイパスされます。デバイス登録に使用される対称キーは、指定された対称キーから計算されます。

az iot device registration create --id-scope {id_scope} --rid {registration_id} --gid {group_enrollment_id} --key {symmetric_key} --ck

グループ登録、Device Provisioning Service ID スコープ、および指定された対称キーを使用して IoT デバイスを登録します。これにより、ID スコープの取得はバイパスされます。対称キーは計算されたデバイスキーである必要があるため、登録グループ ID は必要ありません。

az iot device registration create --id-scope {id_scope} --rid {registration_id} --key {symmetric_key}

個々の登録、Device Provisioning Service ID スコープ、および指定された証明書とキーファイルを使用して IoT デバイスを登録します。これにより、ID スコープの取得はバイパスされます。

az iot device registration create --id-scope {id_scope} --rid {registration_id} --cp {certificate_file} --kp {key_file}

個々の登録、Device Provisioning Service ID スコープ、およびキーファイルの証明書とキーファイルとパスフレーズを使用して IoT デバイスを登録します。これにより、ID スコープの取得はバイパスされます。

az iot device registration create --id-scope {id_scope} --rid {registration_id} --cp {certificate_file} --kp {key_file} --pass {passphrase}

グループ登録、Device Provisioning Service ID スコープ、および指定された証明書とキーファイルを使用して IoT デバイスを登録します。これにより、ID スコープの取得はバイパスされます。 x509 構成証明にはグループ登録 ID は必要なく、証明書ファイルのサブジェクトは登録 ID であることに注意してください。

az iot device registration create --id-scope {id_scope} --rid {registration_id} --cp {certificate_file} --kp {key_file}

必須のパラメーター

--registration-id --rid

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

省略可能のパラメーター

--auth-type

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

指定可能な値: key, login

規定値: key

--certificate-file-path --cp

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

--ck --compute-key

--symmetric-key を使用して、指定されたキーからデバイス登録の対称キーを計算する必要があることを示すフラグ。

規定値: False

--dps-name -n

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

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

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

--host --provisioning-host

使用するプロビジョニングホストを指すエンドポイント。

規定値: global.azure-devices-provisioning.net

--id-scope --scope

Azure IoT Hub Device Provisioning Service の ID スコープ。認証引数を指定すると、セッションログインは回避されます。

--key --symmetric-key

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

--key-file-path --kp

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

--login -l

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

--pass --passphrase

証明書のパスフレーズ。

--payload

JSON としてのカスタム割り当てペイロード。特に、Azure Functions を使用するカスタム割り当てポリシーで使用します。

--resource-group -g

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

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

次の方法で共有

az iot device registration

コマンド

az iot device registration create

例

必須のパラメーター

省略可能のパラメーター

その他のリソース