az iot dps enrollment
Note
このリファレンスは、Azure CLI (バージョン 2.46.0 以降) の azure-iot 拡張機能の一部です。 拡張機能は、az iot dps enrollment コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。
IoT Hub Device Provisioning Service 内の個々のデバイス登録を管理します。
コマンド
名前 | 説明 | 型 | Status |
---|---|---|---|
az iot dps enrollment create |
Azure IoT Hub Device Provisioning Service で個々のデバイス登録を作成します。 |
拡張子 | GA |
az iot dps enrollment delete |
Azure IoT Hub Device Provisioning Service で個々のデバイス登録を削除します。 |
拡張子 | GA |
az iot dps enrollment list |
Azure IoT Hub Device Provisioning Service で個々のデバイス登録を一覧表示します。 |
拡張子 | GA |
az iot dps enrollment registration |
Azure IoT Hub Device Provisioning Service での個々の登録のサービス側デバイス登録を管理します。 |
拡張子 | GA |
az iot dps enrollment registration delete |
Azure IoT Hub Device Provisioning Service での個々の登録のデバイス登録を削除します。 |
拡張子 | GA |
az iot dps enrollment registration show |
Azure IoT Hub Device Provisioning Service での個々の登録のデバイス登録を取得します。 |
拡張子 | GA |
az iot dps enrollment show |
Azure IoT Hub Device Provisioning Service で個々のデバイス登録の詳細を取得します。 |
拡張子 | GA |
az iot dps enrollment update |
Azure IoT Hub Device Provisioning Service で個々のデバイス登録を更新します。 |
拡張子 | GA |
az iot dps enrollment create
Azure IoT Hub Device Provisioning Service で個々のデバイス登録を作成します。
Base64 ASCII エンコードを使用して証明書の形式を指定してください。証明書には、"-----BEGIN CERTIFICATE-----" で始まり、"-----END CERTIFICATE-----' で終わるなど、一致する BEGIN セグメントと END セグメントが必要です。
az iot dps enrollment create --at {symmetricKey, tpm, x509}
--eid
[--allocation-policy {custom, geoLatency, hashed, static}]
[--api-version]
[--auth-type {key, login}]
[--certificate-path]
[--device-id]
[--device-information]
[--dps-name]
[--edge-enabled {false, true}]
[--ek]
[--ih]
[--initial-twin-properties]
[--initial-twin-tags]
[--login]
[--pk]
[--provisioning-status {disabled, enabled}]
[--reprovision-policy {never, reprovisionandmigratedata, reprovisionandresetdata}]
[--resource-group]
[--scp]
[--secondary-key]
[--webhook-url]
例
Azure IoT Device Provisioning Service '{dps_name}' の構成証明の種類が 'x509' の登録 '{enrollment_id}' をリソース グループ '{resource_group_name}' に作成し、プロビジョニングの状態を "無効" にします。 デバイス ID '{device_id}'、初期ツイン プロパティ '{"location":{"region":"US"}}'、初期ツイン タグ '{"version":"1"}'、デバイス情報 '{"color":"red"}'。
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type x509 --certificate-path /certificates/Certificate.pem --provisioning-status disabled --initial-twin-properties "{'location':{'region':'US'}}" --initial-twin-tags "{'version':'1'}" --device-info "{'color':'red'}" --device-id {device_id}
リソース グループ '{resource_group_name}' の Azure IoT Device Provisioning Service '{dps_name}' に、構成証明の種類が "tpm" の登録 'MyEnrollment' を作成します。
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89
リソース グループ '{resource_group_name}' の Azure IoT Device Provisioning サービス '{dps_name}' に、構成証明の種類が 'symmetrickey' の登録 'MyEnrollment' を作成します。
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type symmetrickey --primary-key {primary_key} --secondary-key {secondary_key}
リソース グループ '{resource_group_name}' の Azure IoT Device Provisioning サービス '{dps_name}' に再プロビジョニングを使用して、登録 'MyEnrollment' を作成します。
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --reprovision-policy {reprovision_type} --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89
リソース グループ '{resource_group_name}' の Azure IoT Device Provisioning サービス '{dps_name}' に、静的割り当てポリシーを使用して登録 'MyEnrollment' を作成します。
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --allocation-policy static --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89 --iot-hubs {iot_hub_host_name}
リソース グループ '{resource_group_name}' の Azure IoT Device Provisioning サービス '{dps_name}' に、ハッシュ割り当てポリシーと複数のハブを含む登録 'MyEnrollment' を作成します。
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --allocation-policy hashed --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89 --iot-hubs {iot_hub_host_name1} {iot_hub_host_name2}
カスタム割り当てポリシーを使用して登録 'MyEnrollment' を作成します。
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type symmetrickey --allocation-policy custom --webhook-url {webhook_url} --api-version {api_version}
必須のパラメーター
DPS への認証に使用される構成証明メカニズム。
個々のデバイス登録 ID。
省略可能のパラメーター
デバイスを IoT Hub に割り当てる方法を決定する割り当てポリシーの種類。 指定しない場合、割り当てポリシーは Device Provisioning Service インスタンスの現在の割り当てポリシーの既定のセットになります。
カスタム割り当て要求で送信されるプロビジョニング サービスの種類の API バージョン。 サポートされている最小バージョン: 2018-09-01-preview。
操作でポリシー キーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。 認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。を使用して az configure --defaults iotdps-data-auth-type=<auth-type-value>
既定値を構成できます。
プライマリ証明書を含むファイルへのパス。 構成証明の種類として x509 を選択し、セカンダリ証明書のパスが指定されていない場合に必要です。
IoT Hub に登録されているデバイス ID。
オプションのデバイス情報。
Azure IoT Hub Device Provisioning Service の名前またはホスト名。 --login が指定されていない場合は必須。
エッジの有効化を示すフラグ。
TPM デバイスの TPM 保証キー。 構成証明の種類として tpm を選択する場合は、保証キーが必要です。
割り当てポリシーに関連付けられているターゲット IoT Hub のホスト名。 複数の IoT Hub にスペース区切りリストを使用します。
デバイス ツインの初期プロパティ。
初期デバイス ツイン タグ。
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --dps-name が指定されていない場合は必須です。
base64 形式で格納されている主対称共有アクセス キー。
登録エントリを有効または無効にします。
別の IoT Hub への再プロビジョニング時にデバイス データを処理する方法を決定するポリシー。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
セカンダリ証明書を含むファイルへのパス。 構成証明の種類として x509 を選択し、プライマリ証明書のパスが指定されていない場合に必要です。
base64 形式で格納されているセカンダリ対称共有アクセス キー。
カスタム割り当て要求に使用される Azure 関数 webhook URL。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot dps enrollment delete
Azure IoT Hub Device Provisioning Service で個々のデバイス登録を削除します。
az iot dps enrollment delete --eid
[--auth-type {key, login}]
[--dps-name]
[--etag]
[--login]
[--resource-group]
必須のパラメーター
個々のデバイス登録 ID。
省略可能のパラメーター
操作でポリシー キーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。 認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。を使用して az configure --defaults iotdps-data-auth-type=<auth-type-value>
既定値を構成できます。
Azure IoT Hub Device Provisioning Service の名前またはホスト名。 --login が指定されていない場合は必須。
リソースの最後の状態に対応する Etag またはエンティティ タグ。 etag が指定されていない場合は、値 '*' が使用されます。
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --dps-name が指定されていない場合は必須です。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot dps enrollment list
Azure IoT Hub Device Provisioning Service で個々のデバイス登録を一覧表示します。
az iot dps enrollment list [--auth-type {key, login}]
[--dps-name]
[--login]
[--resource-group]
[--top]
省略可能のパラメーター
操作でポリシー キーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。 認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。を使用して az configure --defaults iotdps-data-auth-type=<auth-type-value>
既定値を構成できます。
Azure IoT Hub Device Provisioning Service の名前またはホスト名。 --login が指定されていない場合は必須。
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --dps-name が指定されていない場合は必須です。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
返される要素の最大数。 無制限の場合は -1 を使用します。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot dps enrollment show
Azure IoT Hub Device Provisioning Service で個々のデバイス登録の詳細を取得します。
az iot dps enrollment show --eid
[--auth-type {key, login}]
[--dps-name]
[--keys {false, true}]
[--login]
[--resource-group]
例
基本的な使用方法
az iot dps enrollment show --dps-name {dps_name} -g {resource_group} --enrollment-id {enrollment_id}
対称キー登録の結果に完全な構成証明情報を含める
az iot dps enrollment show --dps-name {dps_name} -g {resource_group} --enrollment-id {symmetric_key_enrollment_id} --show-keys
必須のパラメーター
個々のデバイス登録 ID。
省略可能のパラメーター
操作でポリシー キーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。 認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。を使用して az configure --defaults iotdps-data-auth-type=<auth-type-value>
既定値を構成できます。
Azure IoT Hub Device Provisioning Service の名前またはホスト名。 --login が指定されていない場合は必須。
登録結果に構成証明キーと情報を含めます。
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --dps-name が指定されていない場合は必須です。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot dps enrollment update
Azure IoT Hub Device Provisioning Service で個々のデバイス登録を更新します。
Base64 ASCII エンコードを使用して証明書の形式を指定してください。証明書には、"-----BEGIN CERTIFICATE-----" で始まり、"-----END CERTIFICATE-----' で終わるなど、一致する BEGIN セグメントと END セグメントが必要です。
az iot dps enrollment update --eid
[--allocation-policy {custom, geoLatency, hashed, static}]
[--api-version]
[--auth-type {key, login}]
[--certificate-path]
[--device-id]
[--device-information]
[--dps-name]
[--edge-enabled {false, true}]
[--ek]
[--etag]
[--ih]
[--initial-twin-properties]
[--initial-twin-tags]
[--login]
[--pk]
[--provisioning-status {disabled, enabled}]
[--rc {false, true}]
[--remove-secondary-certificate {false, true}]
[--reprovision-policy {never, reprovisionandmigratedata, reprovisionandresetdata}]
[--resource-group]
[--scp]
[--secondary-key]
[--webhook-url]
例
リソース グループ '{resource_group_name}' の Azure IoT Device Provisioning Service '{dps_name}' の新しい x509 証明書で登録 '{enrollment_id}' を更新します。
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --certificate-path /certificates/NewCertificate.pem --etag AAAAAAAAAAA=
リソース グループ '{resource_group_name}' の Azure IoT Device Provisioning Service '{dps_name}' の新しい保証キーを使用して、登録 '{enrollment_id}' を更新します。
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89 --etag AAAAAAAAAAA=
リソース グループ '{resource_group_name}' の Azure IoT Device Provisioning Service '{dps_name}' の新しい主キーを使用して、登録 '{enrollment_id}' を更新します。
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --primary-key {new_primary_key} --etag AAAAAAAAAAA=
リソース グループ '{enrollment_id}' の Azure IoT Device Provisioning Service '{dps_name}' の新しい再プロビジョニングの種類で登録 '{resource_group_name}' を更新します。
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --reprovision-policy {reprovision_type} --etag AAAAAAAAAAA=
リソース グループ '{resource_group_name}' の Azure IoT Device Provisioning Service '{dps_name}' の新しい割り当てポリシーを使用して、登録 '{enrollment_id}' を更新します。
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --allocation-policy geolatency --etag AAAAAAAAAAA= --iot-hubs {iot_hub_host_name1} {iot_hub_host_name2} {iot_hub_host_name3}
リソース グループ '{resource_group_name}' の Azure IoT Device Provisioning Service '{dps_name enrollment_id}' の登録 '{enrollment_id}' を、初期ツイン プロパティ '{"location":{"region":"USA"}}'、初期ツイン タグ '{"version":"2"}'、デバイス情報 '{"color":"red"}' で更新します。
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --initial-twin-properties "{'location':{'region':'USA'}}" --initial-twin-tags "{'version1':'2'}" --device-info "{'color':'red'}"
必須のパラメーター
個々のデバイス登録 ID。
省略可能のパラメーター
デバイスを IoT Hub に割り当てる方法を決定する割り当てポリシーの種類。 指定しない場合、割り当てポリシーは Device Provisioning Service インスタンスの現在の割り当てポリシーの既定のセットになります。
カスタム割り当て要求で送信されるプロビジョニング サービスの種類の API バージョン。 サポートされている最小バージョン: 2018-09-01-preview。
操作でポリシー キーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。 認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。を使用して az configure --defaults iotdps-data-auth-type=<auth-type-value>
既定値を構成できます。
プライマリ証明書を含むファイルへのパス。
IoT Hub に登録されているデバイス ID。
オプションのデバイス情報。
Azure IoT Hub Device Provisioning Service の名前またはホスト名。 --login が指定されていない場合は必須。
エッジの有効化を示すフラグ。
TPM デバイスの TPM 保証キー。
リソースの最後の状態に対応する Etag またはエンティティ タグ。 etag が指定されていない場合は、値 '*' が使用されます。
割り当てポリシーに関連付けられているターゲット IoT Hub のホスト名。 複数の IoT Hub にスペース区切りリストを使用します。
デバイス ツインの初期プロパティ。
初期デバイス ツイン タグ。
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --dps-name が指定されていない場合は必須です。
base64 形式で格納されている主対称共有アクセス キー。
登録エントリを有効または無効にします。
現在のプライマリ証明書を削除するフラグ。
現在のセカンダリ証明書を削除するフラグ。
別の IoT Hub への再プロビジョニング時にデバイス データを処理する方法を決定するポリシー。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
セカンダリ証明書を含むファイルへのパス。
base64 形式で格納されているセカンダリ対称共有アクセス キー。
カスタム割り当て要求に使用される Azure 関数 webhook URL。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
Azure CLI