az iot dps enrollment-group

  • 參考

注意

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

管理Azure IoT 中樞裝置布建服務中的註冊群組。

命令

名稱 Description 類型 狀態
az iot dps enrollment-group compute-device-key

為Azure IoT 中樞裝置布建服務中的註冊群組產生衍生裝置 SAS 金鑰。

 擴充 GA
az iot dps enrollment-group create

在Azure IoT 中樞裝置布建服務中建立註冊群組。

 擴充 GA
az iot dps enrollment-group delete

刪除Azure IoT 中樞裝置布建服務中的註冊群組。

 擴充 GA
az iot dps enrollment-group list

列出Azure IoT 中樞裝置布建服務中的註冊群組。

 擴充 GA
az iot dps enrollment-group registration

在Azure IoT 中樞裝置布建服務中管理註冊群組的服務端裝置註冊。

 擴充 GA
az iot dps enrollment-group registration delete

刪除Azure IoT 中樞裝置布建服務中註冊群組的裝置註冊。

 擴充 GA
az iot dps enrollment-group registration list

列出Azure IoT 中樞裝置布建服務中註冊群組的裝置註冊。

 擴充 GA
az iot dps enrollment-group registration show

取得Azure IoT 中樞裝置布建服務中註冊群組的裝置註冊。

 擴充 GA
az iot dps enrollment-group show

在Azure IoT 中樞裝置布建服務中取得註冊群組的詳細資料。

 擴充 GA
az iot dps enrollment-group update

更新Azure IoT 中樞裝置布建服務中的註冊群組。

 擴充 GA

az iot dps enrollment-group compute-device-key

為Azure IoT 中樞裝置布建服務中的註冊群組產生衍生裝置 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}

必要參數

--registration-id --rid

裝置註冊的識別碼。

選擇性參數

--auth-type

指出作業是否應該自動衍生原則金鑰，或使用目前的 Azure AD 會話。 如果驗證類型是登入，而且會提供資源主機名稱，除非需要，否則將會略過資源查閱。您可以使用 來設定預設值 az configure --defaults iotdps-data-auth-type=<auth-type-value> 。

接受的值: key, login
預設值: key
--dps-name -n

Azure IoT 中樞裝置布建服務的名稱或主機名稱。 如果未提供 --login，則為必要項。

--eid --enrollment-id --gid --group-id

註冊群組識別碼。

--key --symmetric-key

註冊群組的對稱共用存取金鑰。 這會略過裝置布建服務登錄，並直接從提供的對稱金鑰產生 SAS 權杖，而不需進一步驗證。 除了註冊識別碼之外，所有其他命令參數都會被忽略。

--login -l

此命令支援具有執行動作許可權的實體連接字串。 使用 來避免透過 「az login」 的會話登入。 如果提供實體連接字串和名稱，則連接字串優先。 如果未提供 --dps-name，則為必要專案。

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name> 。

全域參數
--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 dps enrollment-group create

在Azure IoT 中樞裝置布建服務中建立註冊群組。

請使用 Base64 ASCII 編碼提供憑證格式，且憑證應該具有相符的 BEGIN 和 END 區段，例如：以 '-----BEGIN CERTIFICATE-----' 開頭，並以 '-----END CERTIFICATE-----' 結尾。

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 憑證 {certificate_name} 作為次要憑證，在資源群組 '{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} --secondary-ca-name {certificate_name}

使用中繼憑證作為主要憑證，在資源群組 '{resource_group_name}' 的 Azure IoT 布建服務 'MyDps' 中建立註冊群組 '{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'}"

在資源群組 '{resource_group_name} 中，使用證明類型 'symmetrickey' 在 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}

必要參數

--eid --enrollment-id --gid --group-id

註冊群組識別碼。

選擇性參數

--allocation-policy --ap

配置原則的類型，以判斷裝置如何指派給IoT 中樞。 如果未提供，則配置原則會是裝置布建服務實例目前的配置原則預設值。

接受的值: custom, geoLatency, hashed, static
--api-version --av

自訂配置要求中傳送之布建服務類型的 API 版本。 最低支援版本：2018-09-01-preview。

--auth-type

指出作業是否應該自動衍生原則金鑰，或使用目前的 Azure AD 會話。 如果驗證類型是登入，而且會提供資源主機名稱，除非需要，否則將會略過資源查閱。您可以使用 來設定預設值 az configure --defaults iotdps-data-auth-type=<auth-type-value> 。

接受的值: key, login
預設值: key
--ca-name --cn --root-ca-name

主要根 CA 憑證的名稱。 如果需要具有根 CA 憑證的證明，則必須提供根 CA 名稱。

--certificate-path --cp

包含主要憑證之檔案的路徑。 如果需要中繼憑證的證明，則必須提供憑證路徑。

--dps-name -n

Azure IoT 中樞裝置布建服務的名稱或主機名稱。 如果未提供 --login，則為必要項。

--edge-enabled --ee

指出邊緣啟用的旗標。

接受的值: false, true
預設值: False
--ih --iot-hubs

與配置原則相關聯的目標IoT 中樞主機名稱。 針對多個IoT 中樞使用空格分隔清單。

--initial-twin-properties --props

初始裝置對應項屬性。

--initial-twin-tags --tags

初始裝置對應項標籤。

--login -l

此命令支援具有執行動作許可權的實體連接字串。 使用 來避免透過 「az login」 的會話登入。 如果提供實體連接字串和名稱，則連接字串優先。 如果未提供 --dps-name，則為必要專案。

--pk --primary-key

以 base64 格式儲存的主要對稱共用存取金鑰。

--provisioning-status --ps

啟用或停用註冊專案。

接受的值: disabled, enabled
--reprovision-policy --rp

決定重新布建至不同IoT 中樞時應如何處理裝置資料的原則。

接受的值: never, reprovisionandmigratedata, reprovisionandresetdata
--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name> 。

--scn --secondary-ca-name --secondary-root-ca-name

次要根 CA 憑證的名稱。 如果需要具有根 CA 憑證的證明，則必須提供根 CA 名稱。

--scp --secondary-certificate-path

包含次要憑證之檔案的路徑。 如果需要中繼憑證的證明，則必須提供憑證路徑。

--secondary-key --sk

以 base64 格式儲存的次要對稱共用存取金鑰。

--webhook-url --wh

用於自訂配置要求的 Azure 函式 Webhook URL。

全域參數
--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 dps enrollment-group delete

刪除Azure IoT 中樞裝置布建服務中的註冊群組。

az iot dps enrollment-group delete --eid
                                   [--auth-type {key, login}]
                                   [--dps-name]
                                   [--etag]
                                   [--login]
                                   [--resource-group]

必要參數

--eid --enrollment-id --gid --group-id

註冊群組識別碼。

選擇性參數

--auth-type

指出作業是否應該自動衍生原則金鑰，或使用目前的 Azure AD 會話。 如果驗證類型是登入，而且會提供資源主機名稱，除非需要，否則將會略過資源查閱。您可以使用 來設定預設值 az configure --defaults iotdps-data-auth-type=<auth-type-value> 。

接受的值: key, login
預設值: key
--dps-name -n

Azure IoT 中樞裝置布建服務的名稱或主機名稱。 如果未提供 --login，則為必要項。

--etag -e

對應至資源最後狀態的 Etag 或實體標記。 如果未提供任何 etag，則會使用 '*' 值。

--login -l

此命令支援具有執行動作許可權的實體連接字串。 使用 來避免透過 「az login」 的會話登入。 如果提供實體連接字串和名稱，則連接字串優先。 如果未提供 --dps-name，則為必要專案。

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name> 。

全域參數
--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 dps enrollment-group list

列出Azure IoT 中樞裝置布建服務中的註冊群組。

az iot dps enrollment-group list [--auth-type {key, login}]
                                 [--dps-name]
                                 [--login]
                                 [--resource-group]
                                 [--top]

選擇性參數

--auth-type

指出作業是否應該自動衍生原則金鑰，或使用目前的 Azure AD 會話。 如果驗證類型是登入，而且會提供資源主機名稱，除非需要，否則將會略過資源查閱。您可以使用 來設定預設值 az configure --defaults iotdps-data-auth-type=<auth-type-value> 。

接受的值: key, login
預設值: key
--dps-name -n

Azure IoT 中樞裝置布建服務的名稱或主機名稱。 如果未提供 --login，則為必要項。

--login -l

此命令支援具有執行動作許可權的實體連接字串。 使用 來避免透過 「az login」 的會話登入。 如果提供實體連接字串和名稱，則連接字串優先。 如果未提供 --dps-name，則為必要專案。

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name> 。

--top

要傳回的專案數目上限。 針對無限制使用 -1。

全域參數
--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 dps enrollment-group show

在Azure IoT 中樞裝置布建服務中取得註冊群組的詳細資料。

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

必要參數

--eid --enrollment-id --gid --group-id

註冊群組識別碼。

選擇性參數

--auth-type

指出作業是否應該自動衍生原則金鑰，或使用目前的 Azure AD 會話。 如果驗證類型是登入，而且會提供資源主機名稱，除非需要，否則將會略過資源查閱。您可以使用 來設定預設值 az configure --defaults iotdps-data-auth-type=<auth-type-value> 。

接受的值: key, login
預設值: key
--dps-name -n

Azure IoT 中樞裝置布建服務的名稱或主機名稱。 如果未提供 --login，則為必要項。

--keys --show-keys

在註冊群組結果中包含證明金鑰和資訊。

接受的值: false, true
--login -l

此命令支援具有執行動作許可權的實體連接字串。 使用 來避免透過 「az login」 的會話登入。 如果提供實體連接字串和名稱，則連接字串優先。 如果未提供 --dps-name，則為必要專案。

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name> 。

全域參數
--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 dps enrollment-group update

更新Azure IoT 中樞裝置布建服務中的註冊群組。

請使用 Base64 ASCII 編碼提供憑證格式，且憑證應該具有相符的 BEGIN 和 END 區段，例如：以 '-----BEGIN CERTIFICATE-----' 開頭，並以 '-----END CERTIFICATE-----' 結尾。

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=

使用新的次要 CA 憑證 '{enrollment_id certificate_name}' 更新資源群組 '{resource_group_name}' 資源群組 '{resource_group_name}' 中的 Azure IoT 布建服務 '{dps_name}' 中的註冊群組 '{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=

必要參數

--eid --enrollment-id --gid --group-id

註冊群組識別碼。

選擇性參數

--allocation-policy --ap

配置原則的類型，以判斷裝置如何指派給IoT 中樞。 如果未提供，則配置原則會是裝置布建服務實例目前的配置原則預設值。

接受的值: custom, geoLatency, hashed, static
--api-version --av

自訂配置要求中傳送之布建服務類型的 API 版本。 最低支援版本：2018-09-01-preview。

--auth-type

指出作業是否應該自動衍生原則金鑰，或使用目前的 Azure AD 會話。 如果驗證類型是登入，而且會提供資源主機名稱，除非需要，否則將會略過資源查閱。您可以使用 來設定預設值 az configure --defaults iotdps-data-auth-type=<auth-type-value> 。

接受的值: key, login
預設值: key
--ca-name --cn --root-ca-name

主要根 CA 憑證的名稱。 如果需要具有根 CA 憑證的證明，則必須提供根 CA 名稱。

--certificate-path --cp

包含主要憑證之檔案的路徑。 如果需要中繼憑證的證明，則必須提供憑證路徑。

--dps-name -n

Azure IoT 中樞裝置布建服務的名稱或主機名稱。 如果未提供 --login，則為必要項。

--edge-enabled --ee

指出邊緣啟用的旗標。

接受的值: false, true
--etag -e

對應至資源最後狀態的 Etag 或實體標記。 如果未提供任何 etag，則會使用 '*' 值。

--ih --iot-hubs

與配置原則相關聯的目標IoT 中樞主機名稱。 針對多個IoT 中樞使用空格分隔清單。

--initial-twin-properties --props

初始裝置對應項屬性。

--initial-twin-tags --tags

初始裝置對應項標籤。

--login -l

此命令支援具有執行動作許可權的實體連接字串。 使用 來避免透過 「az login」 的會話登入。 如果提供實體連接字串和名稱，則連接字串優先。 如果未提供 --dps-name，則為必要專案。

--pk --primary-key

以 base64 格式儲存的主要對稱共用存取金鑰。

--provisioning-status --ps

啟用或停用註冊專案。

接受的值: disabled, enabled
--rc --remove-certificate

要移除目前主要憑證的旗標。

接受的值: false, true
--remove-secondary-certificate --rsc

要移除目前次要憑證的旗標。

接受的值: false, true
--reprovision-policy --rp

決定重新布建至不同IoT 中樞時應如何處理裝置資料的原則。

接受的值: never, reprovisionandmigratedata, reprovisionandresetdata
--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name> 。

--scn --secondary-ca-name --secondary-root-ca-name

次要根 CA 憑證的名稱。 如果需要具有根 CA 憑證的證明，則必須提供根 CA 名稱。

--scp --secondary-certificate-path

包含次要憑證之檔案的路徑。 如果需要中繼憑證的證明，則必須提供憑證路徑。

--secondary-key --sk

以 base64 格式儲存的次要對稱共用存取金鑰。

--webhook-url --wh

用於自訂配置要求的 Azure 函式 Webhook URL。

全域參數
--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 來取得完整偵錯記錄。