az iot central enrollment-group

リファレンス

Note

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

IoT Central 登録グループを管理および構成します。

コマンド

名前	説明	型	状態
az iot central enrollment-group create	登録グループを作成する。	拡張子	GA
az iot central enrollment-group delete	ID で登録グループを削除します。	拡張子	GA
az iot central enrollment-group generate-verification-code	登録グループのプライマリまたはセカンダリ x509 証明書の検証コードを生成します。	拡張子	GA
az iot central enrollment-group list	アプリケーション内の登録グループの一覧を取得します。	拡張子	GA
az iot central enrollment-group show	登録グループに関する詳細を ID で取得します。	拡張子	GA
az iot central enrollment-group update	登録グループを更新します。	拡張子	GA
az iot central enrollment-group verify-certificate	登録グループのプライマリまたはセカンダリ x509 証明書を確認します。	拡張子	GA

az iot central enrollment-group create

登録グループを作成する。

az iot central enrollment-group create --app-id
                                       --at {symmetricKey, x509}
                                       --display-name
                                       --group-id
                                       --type
                                       [--api-version {2022-06-30-preview, 2022-07-31}]
                                       [--central-api-uri]
                                       [--certificate-path]
                                       [--etag]
                                       [--pk]
                                       [--provisioning-status {disabled, enabled}]
                                       [--scp]
                                       [--secondary-key]
                                       [--token]

例

登録グループを作成する

az iot central enrollment-group create --app-id {appid} --id {enrollmentGroupId} --at {attestation} --display-name {displayName} --type {type}

x509 プライマリ認定を使用して登録グループを作成する

az iot central enrollment-group create --app-id {appid} --id {enrollmentGroupId} --at 'x509' --display-name {displayName} --type {type} --cp {primayCertPath}

指定された対称キー認定を使用して登録グループを作成する

az iot central enrollment-group create --app-id {appid} --id {enrollmentGroupId} --at 'symmetricKey' --display-name {displayName} --type {type} --pk {primaryKey} --sk {secondaryKey}

必須のパラメーター

--app-id -n

管理する IoT Central アプリのアプリ ID。アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプメニューにあります。

--at --attestation-type

登録グループの構成証明メカニズム。 'x509' または 'symmetricKey' のみが許可されます。既定では、構成証明には 'symmetricKey' が使用されます。

指定可能な値: symmetricKey, x509

規定値: symmetricKey

--display-name

登録グループの表示名。

--group-id --id

登録グループの一意の識別子。

--type

グループを介して接続するデバイスの種類。

省略可能のパラメーター

--api-version --av

非推奨

引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。

このコマンドパラメーターは非推奨となり、無視されます。今後のリリースでは、最新の GA バージョンの IoT Central API のみをサポートします。API がまだ GA でない場合は、最新のプレビューバージョンを呼び出します。

指定可能な値: 2022-06-30-preview, 2022-07-31

規定値: 2022-07-31

--central-api-uri --central-dns-suffix

アプリケーションに関連付けられている IoT Central DNS サフィックス。

規定値: azureiotcentral.com

--certificate-path --cp

プライマリ証明書を含むファイルへのパス。

--etag -e

リソースの最後の状態に対応する Etag またはエンティティタグ。 etag が指定されていない場合は、値 '*' が使用されます。

--pk --primary-key

base64 形式で格納されている主対称共有アクセスキー。

--provisioning-status --ps

グループを使用するデバイスが IoT Central への接続を許可されているかどうか。正誤問題。

指定可能な値: disabled, enabled

規定値: enabled

--scp --secondary-certificate-path

セカンダリ証明書を含むファイルへのパス。

--secondary-key --sk

base64 形式で格納されているセカンダリ対称共有アクセスキー。

--token

Azure CLI に対して認証せずに要求を送信する場合は、要求を認証するための有効なユーザートークンを指定できます。要求の一部としてキーの種類を指定する必要があります。詳細については、https://aka.ms/iotcentraldocsapi をご覧ください。

グローバルパラメーター

--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 central enrollment-group delete

ID で登録グループを削除します。

az iot central enrollment-group delete --app-id
                                       --group-id
                                       [--api-version {2022-06-30-preview, 2022-07-31}]
                                       [--central-api-uri]
                                       [--token]

例

ID で登録グループを削除する

az iot central enrollment-group delete --app-id {appid} --id {enrollmentGroupId}

必須のパラメーター

--app-id -n

管理する IoT Central アプリのアプリ ID。アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプメニューにあります。

--group-id --id

登録グループの一意の識別子。

省略可能のパラメーター

--api-version --av

非推奨

引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。

指定可能な値: 2022-06-30-preview, 2022-07-31

規定値: 2022-07-31

--central-api-uri --central-dns-suffix

アプリケーションに関連付けられている IoT Central DNS サフィックス。

規定値: azureiotcentral.com

--token

グローバルパラメーター

--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 central enrollment-group generate-verification-code

登録グループのプライマリまたはセカンダリ x509 証明書の検証コードを生成します。

az iot central enrollment-group generate-verification-code --app-id
                                                           --group-id
                                                           [--api-version {2022-06-30-preview, 2022-07-31}]
                                                           [--central-api-uri]
                                                           [--certificate-entry {primary, secondary}]
                                                           [--token]

例

登録グループのプライマリ x509 証明書の確認コードを生成する

az iot central enrollment-group generate-verification-code --app-id {appid} --id {enrollmentGroupId} --entry 'primary'

必須のパラメーター

--app-id -n

管理する IoT Central アプリのアプリ ID。アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプメニューにあります。

--group-id --id

登録グループの一意の識別子。

省略可能のパラメーター

--api-version --av

非推奨

引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。

指定可能な値: 2022-06-30-preview, 2022-07-31

規定値: 2022-07-31

--central-api-uri --central-dns-suffix

アプリケーションに関連付けられている IoT Central DNS サフィックス。

規定値: azureiotcentral.com

--certificate-entry --entry

'primary' と 'secondary' のみを許可する x509 証明書のエントリの種類。

指定可能な値: primary, secondary

--token

グローバルパラメーター

--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 central enrollment-group list

アプリケーション内の登録グループの一覧を取得します。

az iot central enrollment-group list --app-id
                                     [--api-version {2022-06-30-preview, 2022-07-31}]
                                     [--central-api-uri]
                                     [--token]

例

アプリケーション内の登録グループの一覧を取得する

az iot central enrollment-group list --app-id {appid}

必須のパラメーター

--app-id -n

管理する IoT Central アプリのアプリ ID。アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプメニューにあります。

省略可能のパラメーター

--api-version --av

非推奨

引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。

指定可能な値: 2022-06-30-preview, 2022-07-31

規定値: 2022-07-31

--central-api-uri --central-dns-suffix

アプリケーションに関連付けられている IoT Central DNS サフィックス。

規定値: azureiotcentral.com

--token

グローバルパラメーター

--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 central enrollment-group show

登録グループに関する詳細を ID で取得します。

az iot central enrollment-group show --app-id
                                     --group-id
                                     [--api-version {2022-06-30-preview, 2022-07-31}]
                                     [--central-api-uri]
                                     [--certificate-entry {primary, secondary}]
                                     [--token]

例

ID で登録グループに関する詳細を取得する

az iot central enrollment-group show --app-id {appid} --id {enrollmentGroupId}

必須のパラメーター

--app-id -n

管理する IoT Central アプリのアプリ ID。アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプメニューにあります。

--group-id --id

登録グループの一意の識別子。

省略可能のパラメーター

--api-version --av

非推奨

引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。

指定可能な値: 2022-06-30-preview, 2022-07-31

規定値: 2022-07-31

--central-api-uri --central-dns-suffix

アプリケーションに関連付けられている IoT Central DNS サフィックス。

規定値: azureiotcentral.com

--certificate-entry --entry

'primary' と 'secondary' のみを許可する x509 証明書のエントリの種類。

指定可能な値: primary, secondary

--token

グローバルパラメーター

--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 central enrollment-group update

登録グループを更新します。

az iot central enrollment-group update --app-id
                                       --group-id
                                       [--api-version {2022-06-30-preview, 2022-07-31}]
                                       [--central-api-uri]
                                       [--certificate-entry {primary, secondary}]
                                       [--certificate-path]
                                       [--display-name]
                                       [--etag]
                                       [--provisioning-status {disabled, enabled}]
                                       [--remove-x509 {false, true}]
                                       [--scp]
                                       [--token]
                                       [--type]

例

登録グループを更新する

az iot central enrollment-group update --app-id {appid} --id {enrollmentGroupId} --display-name {displayName} --type {type} --ps {enabled}

登録グループから x509 プライマリ証明書を削除する

az iot central enrollment-group update --app-id {appid} --id {enrollmentGroupId} --remove-x509 'true' --entry 'primary'

必須のパラメーター

--app-id -n

管理する IoT Central アプリのアプリ ID。アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプメニューにあります。

--group-id --id

登録グループの一意の識別子。

省略可能のパラメーター

--api-version --av

非推奨

引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。

指定可能な値: 2022-06-30-preview, 2022-07-31

規定値: 2022-07-31

--central-api-uri --central-dns-suffix

アプリケーションに関連付けられている IoT Central DNS サフィックス。

規定値: azureiotcentral.com

--certificate-entry --entry

'primary' と 'secondary' のみを許可する x509 証明書のエントリの種類。

指定可能な値: primary, secondary

--certificate-path --cp

プライマリ証明書を含むファイルへのパス。

--display-name

登録グループの表示名。

--etag

登録グループの更新での競合を防ぐために使用される ETag。

--provisioning-status --ps

グループを使用するデバイスが IoT Central への接続を許可されているかどうか。正誤問題。

指定可能な値: disabled, enabled

規定値: enabled

--remove-x509

x509 証明書をグループから削除する必要があるかどうか。正誤問題。

指定可能な値: false, true

--scp --secondary-certificate-path

セカンダリ証明書を含むファイルへのパス。

--token

--type

グループを介して接続するデバイスの種類。

グローバルパラメーター

--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 central enrollment-group verify-certificate

登録グループのプライマリまたはセカンダリ x509 証明書を確認します。

署名された検証コードを含む証明書を指定して、登録グループのプライマリまたはセカンダリ x509 証明書を確認します。

未確認の x509 証明書を使用して登録グループを作成した場合、このコマンドを使用する前に、未確認の x509 証明書と確認コードを使用して検証証明書を作成する必要があることに注意してください。検証コードは、'enrollment-group generate-verification-code' コマンドを使用して cli を使用して生成できます。確認コードを使用して検証証明書を作成する方法の詳細については、https://learn.microsoft.com/en-us/azure/iot-central/core/how-to-connect-devices-x509

az iot central enrollment-group verify-certificate --app-id
                                                   --group-id
                                                   [--api-version {2022-06-30-preview, 2022-07-31}]
                                                   [--central-api-uri]
                                                   [--certificate-path]
                                                   [--scp]
                                                   [--token]

例

登録グループのプライマリ x509 証明書を確認する

az iot central enrollment-group verify-certificate --app-id {appid} --id {enrollmentGroupId} --cp {primayCertPath}

必須のパラメーター

--app-id -n

管理する IoT Central アプリのアプリ ID。アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプメニューにあります。

--group-id --id

登録グループの一意の識別子。

省略可能のパラメーター

--api-version --av

非推奨

引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。

指定可能な値: 2022-06-30-preview, 2022-07-31

規定値: 2022-07-31

--central-api-uri --central-dns-suffix

アプリケーションに関連付けられている IoT Central DNS サフィックス。

規定値: azureiotcentral.com

--certificate-path --cp

プライマリ証明書を含むファイルへのパス。

--scp --secondary-certificate-path

セカンダリ証明書を含むファイルへのパス。

--token

グローバルパラメーター

--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 central enrollment-group

コマンド

az iot central enrollment-group create

例

必須のパラメーター

省略可能のパラメーター

az iot central enrollment-group delete

例

必須のパラメーター

省略可能のパラメーター

az iot central enrollment-group generate-verification-code

例

必須のパラメーター

省略可能のパラメーター

az iot central enrollment-group list

例

必須のパラメーター

省略可能のパラメーター

az iot central enrollment-group show

例

必須のパラメーター

省略可能のパラメーター

az iot central enrollment-group update

例

必須のパラメーター

省略可能のパラメーター

az iot central enrollment-group verify-certificate

例

必須のパラメーター

省略可能のパラメーター

その他のリソース