az iot dps enrollment-group

コマンド

名前	説明	型	状態
az iot dps enrollment-group compute-device-key	Azure IoT Hub Device Provisioning Service の登録グループの派生デバイス SAS キーを生成します。	Extension	GA
az iot dps enrollment-group create	Azure IoT Hub Device Provisioning Service に登録グループを作成します。	Extension	GA
az iot dps enrollment-group delete	Azure IoT Hub Device Provisioning Service の登録グループを削除します。	Extension	GA
az iot dps enrollment-group list	Azure IoT Hub Device Provisioning Service の登録グループを一覧表示します。	Extension	GA
az iot dps enrollment-group registration	Azure IoT Hub Device Provisioning Service の登録グループのサービス側デバイス登録を管理します。	Extension	GA
az iot dps enrollment-group registration delete	Azure IoT Hub Device Provisioning Service の登録グループのデバイス登録を削除します。	Extension	GA
az iot dps enrollment-group registration list	Azure IoT Hub Device Provisioning Service の登録グループのデバイス登録を一覧表示します。	Extension	GA
az iot dps enrollment-group registration show	Azure IoT Hub Device Provisioning Service の登録グループのデバイス登録を取得します。	Extension	GA
az iot dps enrollment-group show	Azure IoT Hub Device Provisioning Service で登録グループの詳細を取得します。	Extension	GA
az iot dps enrollment-group update	Azure IoT Hub Device Provisioning Service の登録グループを更新します。	Extension	GA

az iot dps enrollment-group compute-device-key --registration-id --rid
                                               [--auth-type {key, login}]
                                               [--dps-name]
                                               [--eid --enrollment-id --gid --group-id]
                                               [--key --symmetric-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}

必須のパラメーター

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

グローバル パラメーター

--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 dps enrollment-group create --eid --enrollment-id --gid --group-id
                                   [--allocation-policy --ap {custom, geoLatency, hashed, static}]
                                   [--api-version --av]
                                   [--auth-type {key, login}]
                                   [--ca-name --cn --root-ca-name]
                                   [--certificate-path --cp]
                                   [--dps-name]
                                   [--edge-enabled --ee {false, true}]
                                   [--ih --iot-hubs]
                                   [--initial-twin-properties --props]
                                   [--initial-twin-tags --tags]
                                   [--login]
                                   [--pk --primary-key]
                                   [--provisioning-status --ps {disabled, enabled}]
                                   [--reprovision-policy --rp {never, reprovisionandmigratedata, reprovisionandresetdata}]
                                   [--resource-group]
                                   [--scn --secondary-ca-name --secondary-root-ca-name]
                                   [--scp --secondary-certificate-path]
                                   [--secondary-key --sk]
                                   [--webhook-url --wh]

例

中間証明書をプライマリ証明書として使用して、リソース グループ '{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}

必須のパラメーター

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

グローバル パラメーター

--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 dps enrollment-group delete --eid --enrollment-id --gid --group-id
                                   [--auth-type {key, login}]
                                   [--dps-name]
                                   [--etag]
                                   [--login]
                                   [--resource-group]

必須のパラメーター

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

グローバル パラメーター

--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 dps enrollment-group list [--auth-type {key, login}]
                                 [--dps-name]
                                 [--login]
                                 [--resource-group]
                                 [--top]

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

グローバル パラメーター

--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 dps enrollment-group show --eid --enrollment-id --gid --group-id
                                 [--auth-type {key, login}]
                                 [--dps-name]
                                 [--keys --show-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

必須のパラメーター

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

グローバル パラメーター

--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 dps enrollment-group update --eid --enrollment-id --gid --group-id
                                   [--allocation-policy --ap {custom, geoLatency, hashed, static}]
                                   [--api-version --av]
                                   [--auth-type {key, login}]
                                   [--ca-name --cn --root-ca-name]
                                   [--certificate-path --cp]
                                   [--dps-name]
                                   [--edge-enabled --ee {false, true}]
                                   [--etag]
                                   [--ih --iot-hubs]
                                   [--initial-twin-properties --props]
                                   [--initial-twin-tags --tags]
                                   [--login]
                                   [--pk --primary-key]
                                   [--provisioning-status --ps {disabled, enabled}]
                                   [--rc --remove-certificate {false, true}]
                                   [--remove-secondary-certificate --rsc {false, true}]
                                   [--reprovision-policy --rp {never, reprovisionandmigratedata, reprovisionandresetdata}]
                                   [--resource-group]
                                   [--scn --secondary-ca-name --secondary-root-ca-name]
                                   [--scp --secondary-certificate-path]
                                   [--secondary-key --sk]
                                   [--webhook-url --wh]

例

初期ツイン のプロパティと初期ツイン タグを使用して、リソース グループ '{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=

必須のパラメーター

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

グローバル パラメーター

--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