Share via

az iot dps enrollment

  • 參考

注意

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

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

命令

名稱 Description 類型 狀態
az iot dps enrollment create

在Azure IoT 中樞裝置布建服務中建立個別裝置註冊。

 擴充 GA
az iot dps enrollment delete

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

 擴充 GA
az iot dps enrollment list

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

 擴充 GA
az iot dps enrollment registration

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

 擴充 GA
az iot dps enrollment registration delete

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

 擴充 GA
az iot dps enrollment registration show

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

 擴充 GA
az iot dps enrollment show

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

 擴充 GA
az iot dps enrollment update

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

 擴充 GA

az iot dps enrollment create

在Azure IoT 中樞裝置布建服務中建立個別裝置註冊。

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

az iot dps enrollment create --at {symmetricKey, tpm, x509}
                             --eid
                             [--allocation-policy {custom, geoLatency, hashed, static}]
                             [--api-version]
                             [--auth-type {key, login}]
                             [--certificate-path]
                             [--device-id]
                             [--device-information]
                             [--dps-name]
                             [--edge-enabled {false, true}]
                             [--ek]
                             [--ih]
                             [--initial-twin-properties]
                             [--initial-twin-tags]
                             [--login]
                             [--pk]
                             [--provisioning-status {disabled, enabled}]
                             [--reprovision-policy {never, reprovisionandmigratedata, reprovisionandresetdata}]
                             [--resource-group]
                             [--scp]
                             [--secondary-key]
                             [--webhook-url]

範例

使用布建狀態為 'disabled' 的資源群組 '{resource_group_name}' 中的 Azure IoT 裝置布建服務 '{dps_name}' 中，建立具有證明類型 'x509' 的註冊 '{enrollment_id}'， 裝置識別碼 '{device_id}'，初始對應項屬性 '{「location」：{「region」：「US」}}'，初始對應項標記 '{「version」：「1」}'，以及裝置資訊 '{「color」：「red」}'。

az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type x509 --certificate-path /certificates/Certificate.pem --provisioning-status disabled --initial-twin-properties "{'location':{'region':'US'}}" --initial-twin-tags "{'version':'1'}" --device-info "{'color':'red'}" --device-id {device_id}

在資源群組 '{resource_group_name}' 的 Azure IoT 裝置布建服務 '{dps_name}' 中，建立具有證明類型 'tpm' 的註冊 'MyEnrollment'。

az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89

在資源群組 '{resource_group_name}' 的 Azure IoT 裝置布建服務 '{dps_name}' 中，建立具有證明類型 'symmetrickey' 的註冊 'MyEnrollment'。

az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type symmetrickey --primary-key {primary_key} --secondary-key {secondary_key}

在資源群組 '{resource_group_name}' 的 Azure IoT 裝置布建服務 '{dps_name}' 中建立註冊 'MyEnrollment'。

az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --reprovision-policy {reprovision_type} --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89

在資源群組 '{resource_group_name}' 的 Azure IoT 裝置布建服務 '{dps_name}' 中建立具有靜態配置原則的註冊 'MyEnrollment'。

az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --allocation-policy static --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89 --iot-hubs {iot_hub_host_name}

在資源群組 '{resource_group_name}' 的 Azure IoT 裝置布建服務 '{dps_name}' 中，建立具有雜湊配置原則和多個中樞的註冊 'MyEnrollment'。

az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --allocation-policy hashed --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89 --iot-hubs "{iot_hub_host_name1} {iot_hub_host_name2}"

使用自訂配置原則建立註冊 'MyEnrollment'，

az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type symmetrickey --allocation-policy custom --webhook-url {webhook_url} --api-version {api_version}

必要參數

--at --attestation-type

用於向 DPS 驗證的證明機制。

接受的值: symmetricKey, tpm, x509
--eid --enrollment-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
--certificate-path --cp

包含主要憑證之檔案的路徑。 選擇 x509 做為證明類型，且未提供次要憑證路徑時的必要專案。

--device-id -d

在IoT 中樞中註冊的裝置識別碼。

--device-information --info

選擇性裝置資訊。

--dps-name -n

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

--edge-enabled --ee

指出邊緣啟用的旗標。

接受的值: false, true
預設值: False
--ek --endorsement-key

TPM 裝置的 TPM 簽署金鑰。 選擇 tpm 作為證明類型時，需要簽署金鑰。

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

--scp --secondary-certificate-path

包含次要憑證之檔案的路徑。 選擇 x509 做為證明類型，且未提供主要憑證路徑時的必要專案。

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

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

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

必要參數

--eid --enrollment-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 list

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

az iot dps enrollment 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 show

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

az iot dps enrollment show --eid
                           [--auth-type {key, login}]
                           [--dps-name]
                           [--keys {false, true}]
                           [--login]
                           [--resource-group]

範例

基本使用方式

az iot dps enrollment show --dps-name {dps_name} -g {resource_group} --enrollment-id {enrollment_id}

在對稱金鑰註冊的結果中包含完整的證明信息

az iot dps enrollment show --dps-name {dps_name} -g {resource_group} --enrollment-id {symmetric_key_enrollment_id} --show-keys

必要參數

--eid --enrollment-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 update

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

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

az iot dps enrollment update --eid
                             [--allocation-policy {custom, geoLatency, hashed, static}]
                             [--api-version]
                             [--auth-type {key, login}]
                             [--certificate-path]
                             [--device-id]
                             [--device-information]
                             [--dps-name]
                             [--edge-enabled {false, true}]
                             [--ek]
                             [--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]
                             [--scp]
                             [--secondary-key]
                             [--webhook-url]

範例

在資源群組 '{resource_group_name}' 的 Azure IoT 裝置布建服務 '{dps_name}' 中，以新的 x509 憑證更新註冊 '{enrollment_id}'。

az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --certificate-path /certificates/NewCertificate.pem --etag AAAAAAAAAAA=

在資源群組 '{resource_group_name}' 的 Azure IoT 裝置布建服務 '{dps_name}' 中，以新的簽署金鑰更新註冊 '{enrollment_id}'。

az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89 --etag AAAAAAAAAAA=

使用資源群組 '{resource_group_name}' 中的 Azure IoT 裝置布建服務 '{dps_name}' 中的新主鍵更新註冊 '{enrollment_id}'。

az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --primary-key {new_primary_key} --etag AAAAAAAAAAA=

在資源群組 '{resource_group_name}' 的 Azure IoT 裝置布建服務 '{dps_name}' 中，以新的重新布建類型更新註冊 '{enrollment_id}'。

az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --reprovision-policy {reprovision_type} --etag AAAAAAAAAAA=

使用資源群組 '{resource_group_name}' 中的 Azure IoT 裝置布建服務 '{dps_name}' 中的新配置原則更新註冊 '{enrollment_id}'。

az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --allocation-policy geolatency --etag AAAAAAAAAAA= --iot-hubs "{iot_hub_host_name1} {iot_hub_host_name2} {iot_hub_host_name3}"

使用初始對應項屬性 'enrollment_id{「location」：{「region」：「USA」}'，在資源群組 '{resource_group_name}' 中更新 Azure IoT 裝置布建服務 '{dps_name}' 中的註冊 '{「region」：「USA」}}'、初始對應項標記 '{「version」：「2」}'，以及裝置資訊 '{「color」：「red」}'。

az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --initial-twin-properties "{'location':{'region':'USA'}}" --initial-twin-tags "{'version1':'2'}" --device-info "{'color':'red'}"

必要參數

--eid --enrollment-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
--certificate-path --cp

包含主要憑證之檔案的路徑。

--device-id -d

在IoT 中樞中註冊的裝置識別碼。

--device-information --info

選擇性裝置資訊。

--dps-name -n

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

--edge-enabled --ee

指出邊緣啟用的旗標。

接受的值: false, true
--ek --endorsement-key

TPM 裝置的 TPM 簽署金鑰。

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

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