az iot hub device-twin

參考

注意

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

管理 IoT 裝置對應項設定。

命令

名稱	Description	類型	狀態
az iot hub device-twin list	列出 IoT 中樞中的裝置對應項。	副檔名	GA
az iot hub device-twin replace	以目標 json 取代裝置對應項定義。	副檔名	GA
az iot hub device-twin show	取得裝置對應項定義。	副檔名	GA
az iot hub device-twin update	更新裝置對應項所需的屬性和標籤。	副檔名	GA

az iot hub device-twin list

列出 IoT 中樞中的裝置對應項。

此命令與 iot 中樞查詢相同，其中包含所有裝置的查詢「選取 * 從裝置選取」，並針對邊緣裝置選取 *，其中 capabilities.iotEdge = true“。

az iot hub device-twin 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-twin replace

以目標 json 取代裝置對應項定義。

直接輸入 json 或使用檔案路徑。

az iot hub device-twin replace --device-id
                               --json
                               [--auth-type {key, login}]
                               [--etag]
                               [--hub-name]
                               [--login]
                               [--resource-group]

範例

將裝置對應項取代為檔案內容。

az iot hub device-twin replace -d {device_id} -n {iothub_name} -j ../mydevicetwin.json

必要參數

--device-id -d

目標裝置標識碼。

--json -j

用來取代現有對應項的 Json。提供檔案路徑或原始 JSON。

選擇性參數

--auth-type

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

取得裝置對應項定義。

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

必要參數

--device-id -d

目標裝置標識碼。

選擇性參數

--auth-type

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

更新裝置對應項所需的屬性和標籤。

提供 PATCH 行為的 --desired 或 --tags 自變數。這兩個參數都支援內嵌 json 或 json 內容的檔案路徑。一般更新自變數的使用方式（亦即 --set）會反映PUT行為，且已被取代。

az iot hub device-twin update --device-id
                              [--add]
                              [--auth-type {key, login}]
                              [--desired]
                              [--etag]
                              [--force-string]
                              [--hub-name]
                              [--login]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--tags]

範例

修補裝置對應項所需的屬性。

az iot hub device-twin update -n {iothub_name} -d {device_id} --desired '{"conditions":{"temperature":{"warning":70, "critical":100}}}'

修補裝置對應項標籤。

az iot hub device-twin update -n {iothub_name} -d {device_id} --tags '{"country": "USA"}'

使用 json 檔案內容修補裝置對應項標籤。

az iot hub device-twin update -n {iothub_name} -d {device_id} --tags /path/to/file

從父系 'temperature' 移除 'critical' 所需屬性的修補程式

az iot hub device-twin update -n {iothub_name} -d {device_id} --desired '{"condition":{"temperature":{"critical": null}}}'

必要參數

--device-id -d

目標裝置標識碼。

選擇性參數

--add

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

預設值: []

--auth-type

接受的值: key, login

預設值: key

--desired

對應項所需的屬性。

--etag -e

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

--force-string

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

預設值: False

--hub-name -n

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

--login -l

--remove

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

預設值: []

--resource-group -g

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

--set

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

預設值: []

--tags

對應項標籤。

全域參數

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

命令

az iot hub device-twin list

選擇性參數

az iot hub device-twin replace

範例

必要參數

選擇性參數

az iot hub device-twin show

必要參數

選擇性參數

az iot hub device-twin update

範例

必要參數

選擇性參數

其他資源