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