az iot hub device-identity

注意

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

管理 IoT 裝置。

命令

名稱	Description	類型	狀態
az iot hub device-identity children	管理 IoT Edge 裝置的子裝置關聯性。	副檔名	GA
az iot hub device-identity children add	將裝置新增為目標邊緣裝置的子系。	副檔名	GA
az iot hub device-identity children list	輸出指派子裝置的集合。	副檔名	GA
az iot hub device-identity children remove	從目標邊緣裝置移除子裝置。	副檔名	GA
az iot hub device-identity connection-string	管理IoT裝置的 連接字串。	副檔名	GA
az iot hub device-identity connection-string show	顯示指定的 IoT 中樞 裝置 連接字串。	副檔名	GA
az iot hub device-identity create	在 IoT 中樞 中建立裝置。	副檔名	GA
az iot hub device-identity delete	刪除 IoT 中樞 裝置。	副檔名	GA
az iot hub device-identity export	將所有裝置身分識別從 IoT 中樞 導出至 Azure 儲存體 Blob 容器。	副檔名	GA
az iot hub device-identity import	從記憶體容器 Blob 將裝置身分識別匯入至 IoT 中樞。	副檔名	GA
az iot hub device-identity list	列出 IoT 中樞 中的裝置。	副檔名	GA
az iot hub device-identity parent	管理IoT裝置的父裝置關聯性。	副檔名	GA
az iot hub device-identity parent set	設定目標裝置的父裝置。	副檔名	GA
az iot hub device-identity parent show	取得目標裝置的父裝置。	副檔名	GA
az iot hub device-identity renew-key	使用 sas 驗證更新 IoT 中樞 裝置的目標金鑰。	副檔名	GA
az iot hub device-identity show	取得 IoT 中樞 裝置的詳細數據。	副檔名	GA
az iot hub device-identity update	更新 IoT 中樞 裝置。	副檔名	GA

az iot hub device-identity create

在 IoT 中樞 中建立裝置。

使用shared_private_key驗證方法時（也稱為對稱密鑰），如果沒有提供任何自定義金鑰，服務就會為裝置產生它們。

如果為邊緣裝置提供裝置範圍，則值會自動轉換成父範圍。

az iot hub device-identity create --device-id
                                  [--am {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--device-scope]
                                  [--edge-enabled {false, true}]
                                  [--hub-name]
                                  [--login]
                                  [--od]
                                  [--pk]
                                  [--primary-thumbprint]
                                  [--resource-group]
                                  [--secondary-key]
                                  [--secondary-thumbprint]
                                  [--sta {disabled, enabled}]
                                  [--star]
                                  [--valid-days]

範例

使用預設授權建立已啟用邊緣的IoT裝置（共用私鑰）。

az iot hub device-identity create -n {iothub_name} -d {device_id} --ee

建立具有自我簽署憑證授權的IoT裝置，產生有效的憑證10天，然後使用其指紋。

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --valid-days 10

建立具有自我簽署憑證授權的IoT裝置、產生預設到期憑證（365天）和目標目錄的輸出。

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --output-dir /path/to/output

建立具有自我簽署憑證授權的IoT裝置，並明確提供主要和次要指紋。

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --ptp {thumbprint_1} --stp {thumbprint_2}

建立具有已停用狀態和原因之根 CA 授權的 IoT 裝置。

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_ca --status disabled --status-reason 'for reasons'

建立具有裝置範圍的IoT裝置。

az iot hub device-identity create -n {iothub_name} -d {device_id} --device-scope 'ms-azure-iot-edge://edge0-123456789123456789'

必要參數

--device-id -d

目標裝置標識碼。

選擇性參數

--am --auth-method

要建立實體的授權方法。

接受的值: shared_private_key, x509_ca, x509_thumbprint

預設值: shared_private_key

--auth-type

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

接受的值: key, login

預設值: key

--device-scope

裝置的範圍。 針對邊緣裝置，這是自動產生且不可變的。 若為分葉裝置，請將此設定為建立子系/父系關聯性。

--edge-enabled --ee

指出邊緣啟用的旗標。

接受的值: false, true

預設值: False

--hub-name -n

IoT 中樞 名稱或主機名。 如果未提供 --login，則為必要項。

--login -l

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

--od --output-dir

產生自我簽署憑證，並使用其指紋。 輸出至指定的目標目錄。

--pk --primary-key

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

--primary-thumbprint --ptp

要用於主要指紋的自我簽署憑證指紋。

--resource-group -g

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

--secondary-key --sk

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

--secondary-thumbprint --stp

要用於次要指紋的自我簽署憑證指紋。

--sta --status

在建立時設定裝置狀態。

接受的值: disabled, enabled

預設值: enabled

--star --status-reason

裝置狀態的描述。

--valid-days --vd

產生自我簽署憑證，並使用其指紋。 有效期限為指定的天數。 默認值：365。

全域參數

--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 hub device-identity delete

刪除 IoT 中樞 裝置。

az iot hub device-identity delete --device-id
                                  [--auth-type {key, login}]
                                  [--etag]
                                  [--hub-name]
                                  [--login]
                                  [--resource-group]

必要參數

--device-id -d

目標裝置標識碼。

選擇性參數

--auth-type

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

接受的值: key, login

預設值: key

--etag -e

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

--hub-name -n

IoT 中樞 名稱或主機名。 如果未提供 --login，則為必要項。

--login -l

此命令支援具有執行動作許可權的實體 連接字串。 使用來避免透過 「az login」 的工作階段登入。 如果提供實體 連接字串 和名稱，則 連接字串 優先使用。 如果未提供 --hub-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 hub device-identity export

將所有裝置身分識別從 IoT 中樞 導出至 Azure 儲存體 Blob 容器。

包含裝置身分識別的輸出 Blob 是名為 『devices.txt』 的文字檔。

需要的許可權 - IoT 中樞 支援「登錄讀取和登錄寫入」的共用存取原則，或 IoT 中樞 上具有「IoT 中樞 數據參與者」角色的主體。

儲存體 帳戶名稱和 Blob 容器名稱參數只能在記憶體帳戶與輸入 IoT 中樞 位於相同的訂用帳戶時使用。 如需內嵌 Blob 容器 SAS URI 輸入，請檢閱環境的輸入規則。

如需詳細資訊，請參閱https://aka.ms/iothub-device-exportimport。

az iot hub device-identity export [--auth-type {key, login}]
                                  [--bc]
                                  [--bcu]
                                  [--hub-name]
                                  [--identity]
                                  [--ik {false, true}]
                                  [--login]
                                  [--resource-group]
                                  [--sa]

範例

將所有裝置身分識別導出至已設定的 Blob 容器，並包含裝置密鑰。 Blob 容器名稱和記憶體帳戶名稱會以命令的參數的形式提供。

az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name}

將所有裝置身分識別導出至已設定的 Blob 容器，並包含裝置密鑰。 使用內嵌SAS URI範例。

az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices?sv=2019-02-02&st=2020-08-23T22%3A35%3A00Z&se=2020-08-24T22%3A35%3A00Z&sr=c&sp=rwd&sig=VrmJ5sQtW3kLzYg10VqmALGCp4vtYKSLNjZDDJBSh9s%3D'

使用包含 SAS URI 的檔案路徑，將所有裝置身分識別匯出至已設定的 Blob 容器。

az iot hub device-identity export -n {iothub_name} --bcu {sas_uri_filepath}

將所有裝置身分識別導出至已設定的 Blob 容器，並包含裝置密鑰。 使用系統指派的身分識別，其具有記憶體帳戶 儲存體 Blob 數據參與者角色。 Blob 容器名稱和記憶體帳戶名稱會以命令的參數的形式提供。

az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name} --identity [system]

將所有裝置身分識別導出至已設定的 Blob 容器，並包含裝置密鑰。 使用具有記憶體帳戶 儲存體 Blob 數據參與者角色的系統指派身分識別。 Blob 容器 URI 不需要 Blob SAS 令牌。

az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices' --identity [system]

將所有裝置身分識別導出至已設定的 Blob 容器，並包含裝置密鑰。 使用具有記憶體帳戶 儲存體 Blob 數據參與者角色的使用者指派受控識別。 Blob 容器名稱和記憶體帳戶名稱會以命令的參數的形式提供。

az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name} --identity {managed_identity_resource_id}

將所有裝置身分識別導出至已設定的 Blob 容器，並包含裝置密鑰。 使用具有記憶體帳戶 儲存體 Blob 數據參與者角色的使用者指派受控識別。 Blob 容器 URI 不需要 Blob SAS 令牌。

az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices' --identity {managed_identity_resource_id}

選擇性參數

--auth-type

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

接受的值: key, login

預設值: key

--bc --blob-container

此 Blob 容器可用來輸出裝置身分識別匯入作業和結果的狀態。 提供blob_container_uri時會忽略參數。 此 Blob 容器需要寫入、讀取和刪除存取權。

--bcu --blob-container-uri

具有 Blob 容器寫入、讀取和刪除存取權的 Blob 共用存取簽章 URI。 這是用來輸出作業和結果的狀態。 注意：使用身分識別型驗證時，仍然需要 https:// URI，但不需要 SAS 令牌。 這個自變數的輸入可以是內嵌或來自檔案路徑。

--hub-name -n

IoT 中樞 名稱或主機名。 如果未提供 --login，則為必要項。

--identity

受控識別類型，以判斷是否使用系統指派的受控識別或使用者指派的受控識別。 針對系統指派的受控識別，請使用 [system]。 針對使用者指派的受控識別，請提供使用者指派的受控識別資源標識符。此身分識別需要 儲存體 帳戶的 儲存體 Blob 數據參與者角色。

--ik --include-keys

如果設定，則會正常匯出索引鍵。 否則，導出輸出中的索引鍵會設定為 null。

接受的值: false, true

預設值: False

--login -l

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

--resource-group -g

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

--sa --storage-account

包含輸出 Blob 容器的 Azure 儲存體 帳戶名稱。提供blob_container_uri時會忽略參數。 需要寫入、讀取和刪除存取權。

全域參數

--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 hub device-identity import

從記憶體容器 Blob 將裝置身分識別匯入至 IoT 中樞。

包含裝置身分識別的預期輸入檔應命名為 『devices.txt』。 匯入成功時，輸出記錄檔 『importErrors.log』 是空的，並在匯入失敗時包含錯誤記錄檔。

需要許可權 - IoT 中樞 支援「登錄讀取和登錄寫入」的共用存取原則，或 IoT 中樞 上具有「IoT 中樞 數據參與者」角色的主體。

儲存體 帳戶名稱和 Blob 容器名稱參數只能在記憶體帳戶與輸入 IoT 中樞 位於相同的訂用帳戶時使用。 如需內嵌 Blob 容器 SAS URI 輸入，請檢閱環境的輸入規則。

如需詳細資訊，請參閱https://aka.ms/iothub-device-exportimport。

az iot hub device-identity import [--auth-type {key, login}]
                                  [--hub-name]
                                  [--ibc]
                                  [--ibcu]
                                  [--identity]
                                  [--input-storage-account]
                                  [--login]
                                  [--obc]
                                  [--obcu]
                                  [--osa]
                                  [--resource-group]

範例

藉由提供輸入 Blob 容器和記憶體帳戶以及輸出 Blob 容器和記憶體帳戶的命令參數，從 Blob 匯入所有裝置身分識別。

az iot hub device-identity import -n {iothub_name} --ibc {input_blob_container_name} --isa {input_storage_account_name} --obc {output_blob_container_name} --osa {output_storage_account_name}

使用內嵌SAS URI 從 Blob 匯入所有裝置身分識別。

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri}

使用包含 SAS URI 的檔案路徑，從 Blob 匯入所有裝置身分識別。

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri_filepath} --obcu {output_sas_uri_filepath}

使用具有兩個記憶體帳戶 儲存體 Blob 數據參與者角色的系統指派身分識別，從 Blob 匯入所有裝置身分識別。 輸入 Blob 容器和記憶體帳戶以及輸出 Blob 容器和記憶體帳戶會以命令的參數的形式提供

az iot hub device-identity import -n {iothub_name} --ibc {input_blob_container_name} --isa {input_storage_account_name} --obc {output_blob_container_name} --osa {output_storage_account_name} --identity [system]

使用具有兩個記憶體帳戶 儲存體 Blob 數據參與者角色的系統指派身分識別，從 Blob 匯入所有裝置身分識別。 Blob 容器 URI 不需要 Blob SAS 令牌。

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri} --identity [system]

使用使用者指派的受控識別，從 Blob 匯入所有裝置身分識別，該受控識別 儲存體 兩個記憶體帳戶的 Blob 數據參與者角色。 輸入 Blob 容器和記憶體帳戶以及輸出 Blob 容器和記憶體帳戶會以命令的參數的形式提供

az iot hub device-identity import -n {iothub_name} --ibc {input_blob_container_name} --isa {input_storage_account_name} --obc {output_blob_container_name} --osa {output_storage_account_name} --identity {managed_identity_resource_id}

使用使用者指派的受控識別，從 Blob 匯入所有裝置身分識別，該受控識別 儲存體 兩個記憶體帳戶的 Blob 數據參與者角色。 Blob 容器 URI 不需要 Blob SAS 令牌。

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri} --identity {managed_identity_resource_id}

選擇性參數

--auth-type

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

接受的值: key, login

預設值: key

--hub-name -n

IoT 中樞 名稱或主機名。 如果未提供 --login，則為必要項。

--ibc --input-blob-container

此 Blob 容器會儲存檔案，該檔案會定義要對身分識別登錄執行的作業。 提供input_blob_container_uri時會忽略參數。 此 Blob 容器需要讀取許可權。

--ibcu --input-blob-container-uri

具有 Blob 容器讀取許可權的 Blob 共用存取簽章 URI。 此 Blob 包含要對身分識別登錄執行的作業。 注意：使用身分識別型驗證時，仍然需要 https:// URI，但不需要 SAS 令牌。 這個自變數的輸入可以是內嵌或來自檔案路徑。

--identity

受控識別類型，以判斷是否使用系統指派的受控識別或使用者指派的受控識別。 針對系統指派的受控識別，請使用 [system]。 針對使用者指派的受控識別，請提供使用者指派的受控識別資源標識符。此身分識別需要 IoT 中樞 的目標 儲存體 帳戶和參與者角色 儲存體 Blob 數據參與者角色。

--input-storage-account --isa

包含輸入 Blob 容器的 Azure 儲存體 帳戶名稱。只有在未提供input_blob_container_uri時才需要。 需要讀取許可權。

--login -l

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

--obc --output-blob-container

此 Blob 容器可用來輸出裝置身分識別匯入作業和結果的狀態。 只有在未提供input_blob_container_uri時才需要。 此 Blob 容器需要寫入存取權。

--obcu --output-blob-container-uri

具有 Blob 容器寫入許可權的 Blob 共用存取簽章 URI。 這是用來輸出作業和結果的狀態。 注意：使用身分識別型驗證時，仍然需要沒有 SAS 令牌的 https:// URI。 這個自變數的輸入可以是內嵌或來自檔案路徑。

--osa --output-storage-account

包含輸出 Blob 容器的 Azure 儲存體 帳戶名稱。提供output_blob_container_uri時會忽略參數。 需要寫入許可權。

--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 hub device-identity list

列出 IoT 中樞 中的裝置。

此命令是 的 az iot hub device-twin list別名，強烈建議您使用此命令。 在未來，此命令 az iot hub device-identity list 可能會遭到變更或取代。

az iot hub device-identity list [--auth-type {key, login}]
                                [--edge-enabled {false, true}]
                                [--hub-name]
                                [--login]
                                [--resource-group]
                                [--top]

選擇性參數

--auth-type

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

接受的值: key, login

預設值: key

--edge-enabled --ee

指出邊緣啟用的旗標。

接受的值: false, true

預設值: False

--hub-name -n

IoT 中樞 名稱或主機名。 如果未提供 --login，則為必要項。

--login -l

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

--resource-group -g

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

--top

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

預設值: 1000

全域參數

--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 hub device-identity renew-key

使用 sas 驗證更新 IoT 中樞 裝置的目標金鑰。

az iot hub device-identity renew-key --device-id
                                     --hub-name
                                     --key-type {primary, secondary, swap}
                                     [--auth-type {key, login}]
                                     [--etag]
                                     [--login]
                                     [--resource-group]

範例

更新主鍵。

az iot hub device-identity renew-key -d {device_id} -n {iothub_name} --kt primary

交換主要和次要金鑰。

az iot hub device-identity renew-key -d {device_id} -n {iothub_name} --kt swap

必要參數

--device-id -d

目標裝置標識碼。

--hub-name -n

IoT 中樞 名稱或主機名。 如果未提供 --login，則為必要項。

--key-type --kt

要重新產生的目標索引鍵類型。

接受的值: primary, secondary, swap

選擇性參數

--auth-type

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

接受的值: key, login

預設值: key

--etag -e

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

--login -l

此命令支援具有執行動作許可權的實體 連接字串。 使用來避免透過 「az login」 的工作階段登入。 如果提供實體 連接字串 和名稱，則 連接字串 優先。 如果未提供 --hub-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 hub device-identity show

取得 IoT 中樞 裝置的詳細數據。

az iot hub device-identity show --device-id
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--resource-group]

必要參數

--device-id -d

目標裝置標識碼。

選擇性參數

--auth-type

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

接受的值: key, login

預設值: key

--hub-name -n

IoT 中樞 名稱或主機名。 如果未提供 --login，則為必要項。

--login -l

此命令支援具有執行動作許可權的實體 連接字串。 使用來避免透過 「az login」 的工作階段登入。 如果提供實體 連接字串 和名稱，則 連接字串 優先使用。 如果未提供 --hub-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 hub device-identity update

更新 IoT 中樞 裝置。

使用 --set 後面接著屬性指派來更新裝置。 利用從 「iot 中樞裝置身分識別顯示」傳回的參數。

az iot hub device-identity update --device-id
                                  [--add]
                                  [--am {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--edge-enabled {false, true}]
                                  [--etag]
                                  [--force-string]
                                  [--hub-name]
                                  [--login]
                                  [--pk]
                                  [--primary-thumbprint]
                                  [--remove]
                                  [--resource-group]
                                  [--secondary-key]
                                  [--secondary-thumbprint]
                                  [--set]
                                  [--sta {disabled, enabled}]
                                  [--star]

範例

開啟裝置的邊緣功能

az iot hub device-identity update -d {device_id} -n {iothub_name} --set capabilities.iotEdge=true

使用便利自變數開啟裝置的邊緣功能。

az iot hub device-identity update -d {device_id} -n {iothub_name} --ee

停用裝置狀態

az iot hub device-identity update -d {device_id} -n {iothub_name} --set status=disabled

使用便利自變數停用裝置狀態。

az iot hub device-identity update -d {device_id} -n {iothub_name} --status disabled

在一個命令中

az iot hub device-identity update -d {device_id} -n {iothub_name} --set status=disabled capabilities.iotEdge=true

必要參數

--device-id -d

目標裝置標識碼。

選擇性參數

--add

藉由指定路徑和索引鍵值組，將物件加入物件清單。 範例：--add property.listProperty <key=value, string or JSON string>。

預設值: []

--am --auth-method

要建立實體的授權方法。

接受的值: shared_private_key, x509_ca, x509_thumbprint

--auth-type

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

接受的值: key, login

預設值: key

--edge-enabled --ee

指出邊緣啟用的旗標。

接受的值: false, true

--etag -e

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

--force-string

使用 'set' 或 'add' 時，請保留字串常值，而不是嘗試轉換成 JSON。

預設值: False

--hub-name -n

IoT 中樞 名稱或主機名。 如果未提供 --login，則為必要項。

--login -l

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

--pk --primary-key

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

--primary-thumbprint --ptp

要用於主要指紋的自我簽署憑證指紋。

--remove

從清單中移除屬性或專案。 範例： --remove property.list <indexToRemove> 或 --remove propertyToRemove。

預設值: []

--resource-group -g

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

--secondary-key --sk

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

--secondary-thumbprint --stp

要用於次要指紋的自我簽署憑證指紋。

--set

指定要設定的屬性路徑和值，以更新物件。 範例：--set property1.property2=<value>。

預設值: []

--sta --status

在建立時設定裝置狀態。

接受的值: disabled, enabled

--star --status-reason

裝置狀態的描述。

全域參數

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