az iot central enrollment-group

注意

此參考是 Azure CLI 的 azure-iot 延伸模組的一部分 （2.37.0 版或更高版本）。 擴充功能會在您第一次執行 az iot central enrollment-group 命令時自動安裝。 深入了解擴充功能。

管理及設定 IoT Central 註冊群組。

命令

名稱	Description	類型	狀態
az iot central enrollment-group create	建立註冊群組。	擴充	GA
az iot central enrollment-group delete	依識別碼刪除註冊群組。	擴充	GA
az iot central enrollment-group generate-verification-code	為註冊群組的主要或次要 x509 憑證產生驗證碼。	擴充	GA
az iot central enrollment-group list	取得應用程式中的註冊群組清單。	擴充	GA
az iot central enrollment-group show	依識別碼取得註冊群組的詳細資料。	擴充	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 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。

--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 尚未正式運作，我們將呼叫最新的預覽版本。

接受的值: 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az iot central enrollment-group delete

依識別碼刪除註冊群組。

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

範例

依識別碼刪除註冊群組

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

必要參數

--app-id -n

您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。

--group-id --id

註冊群組的唯一識別碼。

選擇性參數

--api-version --av

已被取代

引數 'api_version' 已被取代，並將在未來版本中移除。

此命令參數已被取代，將會忽略。在未來版本中，我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作，我們將呼叫最新的預覽版本。

接受的值: 2022-06-30-preview, 2022-07-31

預設值: 2022-07-31

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

與您的應用程式相關聯的 IoT Central DNS 尾碼。

預設值: azureiotcentral.com

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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。

--group-id --id

註冊群組的唯一識別碼。

選擇性參數

--api-version --av

已被取代

引數 'api_version' 已被取代，並將在未來版本中移除。

此命令參數已被取代，將會忽略。在未來版本中，我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作，我們將呼叫最新的預覽版本。

接受的值: 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

如果您想要提交要求而不向 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。

選擇性參數

--api-version --av

已被取代

引數 'api_version' 已被取代，並將在未來版本中移除。

此命令參數已被取代，將會忽略。在未來版本中，我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作，我們將呼叫最新的預覽版本。

接受的值: 2022-06-30-preview, 2022-07-31

預設值: 2022-07-31

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

與您的應用程式相關聯的 IoT Central DNS 尾碼。

預設值: azureiotcentral.com

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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az iot central enrollment-group show

依識別碼取得註冊群組的詳細資料。

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]

範例

依識別碼取得註冊群組的詳細資料

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

必要參數

--app-id -n

您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。

--group-id --id

註冊群組的唯一識別碼。

選擇性參數

--api-version --av

已被取代

引數 'api_version' 已被取代，並將在未來版本中移除。

此命令參數已被取代，將會忽略。在未來版本中，我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作，我們將呼叫最新的預覽版本。

接受的值: 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

如果您想要提交要求而不向 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。

--group-id --id

註冊群組的唯一識別碼。

選擇性參數

--api-version --av

已被取代

引數 'api_version' 已被取代，並將在未來版本中移除。

此命令參數已被取代，將會忽略。在未來版本中，我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作，我們將呼叫最新的預覽版本。

接受的值: 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

如果您想要提交要求而不向 Azure CLI 進行驗證，您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi，即可深入瞭解。

--type

透過群組連線的裝置類型。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。

--group-id --id

註冊群組的唯一識別碼。

選擇性參數

--api-version --av

已被取代

引數 'api_version' 已被取代，並將在未來版本中移除。

此命令參數已被取代，將會忽略。在未來版本中，我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作，我們將呼叫最新的預覽版本。

接受的值: 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

如果您想要提交要求而不向 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。