az iot device-update instance

注意

此參考是 Azure CLI (2.30.0 版或更新版本的 azure-iot 擴充功能的一部分) 。 當您第一次執行 az iot device-update 實例 命令時,擴充功能會自動安裝。 深入了解延伸模組。

裝置更新實例管理。

命令

az iot device-update instance create

建立裝置更新實例。

az iot device-update instance delete

刪除裝置更新實例。

az iot device-update instance list

列出裝置更新實例。

az iot device-update instance show

顯示裝置更新實例。

az iot device-update instance update

更新裝置更新實例。

az iot device-update instance wait

封鎖直到符合所需的實例資源狀態為止。

az iot device-update instance create

建立裝置更新實例。

此命令也可以用來更新現有實例的狀態。

az iot device-update instance create --account
                                     --instance
                                     --iothub-ids
                                     [--diagnostics-storage-id]
                                     [--enable-diagnostics {false, true}]
                                     [--no-wait]
                                     [--resource-group]
                                     [--tags]

範例

建立具有最小組態的實例。

az iot device-update instance create -n {account_name} -i {instance_name} --iothub-ids {iothub_resource_id}

建立已啟用診斷的實例,並與使用者提供的儲存體帳戶配對。 包含標籤。

az iot device-update instance create -n {account_name} -i {instance_name} --iothub-ids {iothub_resource_id} --enable-diagnostics --diagnostics-storage-id {storage_account_resource_id} --tags a=b

必要參數

--account -n

裝置更新帳戶名稱。 您可以使用 來設定預設帳戶名稱 az config set defaults.adu_account=<name>

--instance -i

裝置更新實例名稱。您可以使用 來設定預設實例名稱 az config set defaults.adu_instance=<name>

--iothub-ids

以空格分隔IoT 中樞資源識別碼。

選擇性參數

--diagnostics-storage-id

使用者提供的儲存體帳戶資源識別碼用於診斷記錄收集。

--enable-diagnostics

啟用診斷記錄收集。

接受的值: false, true
--no-wait

不等候長時間執行的作業完成。

--resource-group -g

裝置更新帳戶資源組名。 您可以使用 az config set defaults.adu_group=<name> 來設定預設群組。

--tags

資源標籤。 索引鍵/值組中的屬性包,格式如下:a=b c=d。

az iot device-update instance delete

刪除裝置更新實例。

az iot device-update instance delete --account
                                     --instance
                                     [--no-wait]
                                     [--resource-group]
                                     [--yes {false, true}]

範例

刪除與目標帳戶相關聯的實例。

az iot device-update instance delete -n {account_name} -i {instance_name}

刪除與目標帳戶相關聯的實例,並略過確認提示。

az iot device-update instance delete -n {account_name} -i {instance_name} -y

必要參數

--account -n

裝置更新帳戶名稱。 您可以使用 來設定預設帳戶名稱 az config set defaults.adu_account=<name>

--instance -i

裝置更新實例名稱。您可以使用 來設定預設實例名稱 az config set defaults.adu_instance=<name>

選擇性參數

--no-wait

不等候長時間執行的作業完成。

--resource-group -g

裝置更新帳戶資源組名。 您可以使用 az config set defaults.adu_group=<name> 來設定預設群組。

--yes -y

略過使用者提示。 表示接受動作。 主要用於自動化案例。 預設:false。

接受的值: false, true

az iot device-update instance list

列出裝置更新實例。

az iot device-update instance list --account
                                   [--resource-group]

範例

列出與目標帳戶相關聯的實例。

az iot device-update instance list -n {account_name}

必要參數

--account -n

裝置更新帳戶名稱。 您可以使用 來設定預設帳戶名稱 az config set defaults.adu_account=<name>

選擇性參數

--resource-group -g

裝置更新帳戶資源組名。 您可以使用 az config set defaults.adu_group=<name> 來設定預設群組。

az iot device-update instance show

顯示裝置更新實例。

az iot device-update instance show --account
                                   --instance
                                   [--resource-group]

範例

顯示與目標帳戶相關聯的實例詳細資料。

az iot device-update instance show -n {account_name} -i {instance_name}

必要參數

--account -n

裝置更新帳戶名稱。 您可以使用 來設定預設帳戶名稱 az config set defaults.adu_account=<name>

--instance -i

裝置更新實例名稱。您可以使用 來設定預設實例名稱 az config set defaults.adu_instance=<name>

選擇性參數

--resource-group -g

裝置更新帳戶資源組名。 您可以使用 az config set defaults.adu_group=<name> 來設定預設群組。

az iot device-update instance update

更新裝置更新實例。

目前可以更新下列實例屬性 - iotHubs、enableDiagnostics、diagnosticStorageProperties 和標記。

az iot device-update instance update --account
                                     --instance
                                     [--add]
                                     [--force-string]
                                     [--no-wait]
                                     [--remove]
                                     [--resource-group]
                                     [--set]

範例

設定特定的實例標記屬性。

az iot device-update instance update -n {account_name} -i {instance_name} --set tags.env='test'

啟用診斷並設定用於記錄收集的儲存體帳戶。

az iot device-update instance update -n {account_name} -i {instance_name} --set enableDiagnostics=true diagnosticStorageProperties.resourceId={storage_account_resource_id}

必要參數

--account -n

裝置更新帳戶名稱。 您可以使用 來設定預設帳戶名稱 az config set defaults.adu_account=<name>

--instance -i

裝置更新實例名稱。您可以使用 來設定預設實例名稱 az config set defaults.adu_instance=<name>

選擇性參數

--add

藉由指定路徑和索引鍵值組,將物件新增至物件清單。 範例:--add property.listProperty < key=value、string 或 JSON 字串 > 。

--force-string

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

--no-wait

不等候長時間執行的作業完成。

--remove

從清單中移除屬性或專案。 範例:--remove property.list OR --remove propertyToRemove。

--resource-group -g

裝置更新帳戶資源組名。 您可以使用 az config set defaults.adu_group=<name> 來設定預設群組。

--set

指定要設定的屬性路徑和值來更新 物件。 範例:--set property1.property2=。

az iot device-update instance wait

封鎖直到符合所需的實例資源狀態為止。

az iot device-update instance wait --account
                                   --instance
                                   [--created]
                                   [--custom]
                                   [--deleted]
                                   [--exists]
                                   [--interval]
                                   [--resource-group]
                                   [--timeout]
                                   [--updated]

範例

封鎖直到目標實例已刪除為止。

az iot device-update instance wait -n {account_name} -i {instance_name} --deleted

必要參數

--account -n

裝置更新帳戶名稱。 您可以使用 來設定預設帳戶名稱 az config set defaults.adu_account=<name>

--instance -i

裝置更新實例名稱。您可以使用 來設定預設實例名稱 az config set defaults.adu_instance=<name>

選擇性參數

--created

等候在 'Succeeded' 使用 'provisioningState' 建立。

--custom

等候條件符合自訂 JMESPath 查詢。 例如 provisioningState!='InProgress',instanceView.statuses[?code=='PowerState/running']。

--deleted

等到刪除為止。

--exists

等候資源存在。

--interval

以秒為單位輪詢間隔。

預設值: 30
--resource-group -g

裝置更新帳戶資源組名。 您可以使用 az config set defaults.adu_group=<name> 來設定預設群組。

--timeout

等候時間上限,以秒為單位。

預設值: 3600
--updated

等候在 'Succeeded' 上使用 provisioningState 進行更新。