az iot du device deployment

參考

注意

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

裝置部署管理。

部署會針對目標裝置群組套用所需的相容更新，以將更新分散到群組內的裝置類別。您可以選擇性地設定雲端起始的回復原則。

命令

名稱	Description	類型	狀態
az iot du device deployment cancel	取消裝置類別子群組部署。	副檔名	GA
az iot du device deployment create	建立裝置群組的部署。部署將會針對目標群組內的每個裝置類別子群組進行多重轉換。	副檔名	GA
az iot du device deployment delete	依裝置群組或裝置類別子群組刪除部署。	副檔名	GA
az iot du device deployment list	列出裝置群組或裝置類別子群組的部署。	副檔名	GA
az iot du device deployment list-devices	列出裝置類別子群組部署中的裝置及其狀態。適用於取得失敗的裝置清單。	副檔名	GA
az iot du device deployment retry	重試裝置類別子群組部署。	副檔名	GA
az iot du device deployment show	顯示裝置群組或裝置類別子群組的部署，包括狀態，詳細說明部署中有多少裝置正在進行、已完成或失敗。	副檔名	GA

az iot du device deployment cancel

取消裝置類別子群組部署。

az iot du device deployment cancel --account
                                   --cid
                                   --deployment-id
                                   --gid
                                   --instance
                                   [--resource-group]

範例

取消目標裝置類別子群組部署。

az iot du device deployment cancel -n {account_name} -i {instance_name} --deployment-id {deployment_id} --group-id {device_group_id} --class-id {device_class_id}

必要參數

--account -n

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

--cid --class-id

裝置類別標識碼。這會從模型標識碼和裝置更新代理程式在 IoT 中樞中的裝置更新代理程式所報告的相容性屬性產生。這是十六進位編碼的SHA1哈希。

--deployment-id --did

呼叫端提供的部署標識碼。這不能超過 73 個字元，必須全部是小寫，而且不能包含 '&'、'^'、'['、']'、'{'、'}'、'|<>'、''、''、正斜線、反斜杠或雙引號。

--gid --group-id

裝置群組標識碼。這會從連線 IoT 中樞裝置/模組對應項中的 ADUGroup 標籤建立，或針對沒有標記的裝置$default。

--instance -i

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

選擇性參數

--resource-group -g

裝置更新帳戶資源組名。您可以使用 az config set defaults.adu_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 du device deployment create

建立裝置群組的部署。部署將會針對目標群組內的每個裝置類別子群組進行多重轉換。

az iot du device deployment create --account
                                   --deployment-id
                                   --gid
                                   --instance
                                   --un
                                   --up
                                   --update-version
                                   [--failed-count]
                                   [--failed-percentage]
                                   [--rbun]
                                   [--rbup]
                                   [--rbuv]
                                   [--resource-group]
                                   [--start-time]

範例

建立排定立即啟動的裝置群組部署（相對於 UTC 時間）。

az iot du device deployment create -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id} --update-name {update_name} --update-provider {update_provider} --update-version {update_version}

建立排程在所需 iso-8601 相容日期時間上啟動的裝置群組部署。

az iot du device deployment create -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id} --update-name {update_name} --update-provider {update_provider} --update-version {update_version} --start-time "2022-12-20T01:00:00"

建立排程的裝置群組部署，以使用已定義的雲端起始復原原則立即啟動。當符合失敗計數或失敗百分比目標時，就會起始雲端復原。

az iot du device deployment create -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id} --update-name {update_name} --update-provider {update_provider} --update-version {update_version} --failed-count 10 --failed-percentage 5 --rollback-update-name {rollback_update_name} --rollback-update-provider {rollback_update_provider} --rollback-update-version {rollback_update_version}

必要參數

--account -n

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

--deployment-id --did

--gid --group-id

裝置群組標識碼。這會從連線 IoT 中樞裝置/模組對應項中的 ADUGroup 標籤建立，或針對沒有標記的裝置建立$default。

--instance -i

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

--un --update-name

更新名稱。

--up --update-provider

更新提供者。

--update-version --uv

更新版本。

選擇性參數

--failed-count --fc

整數，表示在發生雲端初始化復原之前，部署中失敗的裝置數目。定義復原原則時需要。

--failed-percentage --fp

整數，表示在發生雲端初始化復原之前，部署中失敗裝置的百分比。定義復原原則時需要。

--rbun --rollback-update-name

復原更新名稱。

--rbup --rollback-update-provider

復原更新提供者。

--rbuv --rollback-update-version

復原更新版本。

--resource-group -g

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

--start-time

符合 iso-8601 規範的部署開始時間。如果未提供任何值，則會使用UTC 'now' 的對應值。

全域參數

--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 du device deployment delete

依裝置群組或裝置類別子群組刪除部署。

az iot du device deployment delete --account
                                   --deployment-id
                                   --gid
                                   --instance
                                   [--cid]
                                   [--resource-group]
                                   [--yes {false, true}]

範例

刪除目標裝置群組部署。

az iot du device deployment delete -n {account_name} -i {instance_name} --deployment-id {deployment_id} --group-id {device_group_id}

刪除目標裝置類別子群組部署。

az iot du device deployment delete -n {account_name} -i {instance_name} --deployment-id {deployment_id} --group-id {device_group_id} --class-id {device_class_id}

必要參數

--account -n

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

--deployment-id --did

--gid --group-id

裝置群組標識碼。這會從已連線 IoT 中樞裝置/模組對應項中的 ADUGroup 標籤建立，或針對沒有標記的裝置建立$default。

--instance -i

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

選擇性參數

--cid --class-id

裝置類別標識碼。這會從模型標識碼和裝置更新代理程式在 IoT 中樞的 Device Update PnP 介面中回報的相容性屬性產生。這是十六進位編碼的SHA1哈希。

--resource-group -g

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

--yes -y

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

接受的值: false, true

全域參數

--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 du device deployment list

列出裝置群組或裝置類別子群組的部署。

az iot du device deployment list --account
                                 --gid
                                 --instance
                                 [--cid]
                                 [--order-by]
                                 [--resource-group]

範例

列出裝置群組的部署。

az iot du device deployment list -n {account_name} -i {instance_name} --group-id {device_group_id}

依 startDateTime 遞減列出裝置群組排序結果的部署。

az iot du device deployment list -n {account_name} -i {instance_name} --group-id {device_group_id} --order-by "startDateTime desc"

列出裝置類別子群組的部署。

az iot du device deployment list -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id}

必要參數

--account -n

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

--gid --group-id

裝置群組標識碼。這會從連線 IoT 中樞裝置/模組對應項中的 ADUGroup 標籤建立，或針對沒有標記的裝置建立$default。

--instance -i

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

選擇性參數

--cid --class-id

裝置類別標識碼。這會從模型標識碼和裝置更新代理程式在 IoT 中樞中的裝置更新代理程式所報告的相容性屬性產生。這是十六進位編碼的SHA1哈希。

--order-by

排序傳回的一組部署。您可以依 startDateTime [desc/asc] 排序。

--resource-group -g

裝置更新帳戶資源組名。您可以使用 az config set defaults.adu_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 du device deployment list-devices

列出裝置類別子群組部署中的裝置及其狀態。適用於取得失敗的裝置清單。

az iot du device deployment list-devices --account
                                         --cid
                                         --deployment-id
                                         --gid
                                         --instance
                                         [--filter]
                                         [--resource-group]

範例

列出裝置類別子群組部署中的裝置。

az iot du device deployment list-devices -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id}

依 deviceId 和 deviceState 列出裝置類別子群組部署篩選中的裝置。

az iot du device deployment list-devices -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id} --filter "deviceId eq 'd0' and deviceState eq 'InProgress'"

必要參數

--account -n

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

--cid --class-id

裝置類別標識碼。這會從模型標識碼和裝置更新代理程式在 IoT 中樞的 Device Update PnP 介面中回報的相容性屬性產生。這是十六進位編碼的SHA1哈希。

--deployment-id --did

--gid --group-id

裝置群組標識碼。這會從連線 IoT 中樞裝置/模組對應項中的 ADUGroup 標籤建立，或針對沒有標記的裝置建立$default。

--instance -i

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

選擇性參數

--filter

限制傳回的一組部署裝置狀態。您可以篩選 deviceId 和 moduleId 和/或 deviceState。

--resource-group -g

裝置更新帳戶資源組名。您可以使用 az config set defaults.adu_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 du device deployment retry

重試裝置類別子群組部署。

az iot du device deployment retry --account
                                  --cid
                                  --deployment-id
                                  --gid
                                  --instance
                                  [--resource-group]

範例

重試目標裝置類別子群組部署。

az iot du device deployment retry -n {account_name} -i {instance_name} --deployment-id {deployment_id} --group-id {device_group_id} --class-id {device_class_id}

必要參數

--account -n

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

--cid --class-id

裝置類別標識碼。這會從模型標識碼和裝置更新代理程式在 IoT 中樞中的裝置更新代理程式所報告的相容性屬性產生。這是十六進位編碼的SHA1哈希。

--deployment-id --did

--gid --group-id

裝置群組標識碼。這會從連線 IoT 中樞裝置/模組對應項中的 ADUGroup 標籤建立，或針對沒有標記的裝置建立$default。

--instance -i

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

選擇性參數

--resource-group -g

裝置更新帳戶資源組名。您可以使用 az config set defaults.adu_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 du device deployment show

顯示裝置群組或裝置類別子群組的部署，包括狀態，詳細說明部署中有多少裝置正在進行、已完成或失敗。

az iot du device deployment show --account
                                 --deployment-id
                                 --gid
                                 --instance
                                 [--cid]
                                 [--resource-group]
                                 [--status {false, true}]

範例

顯示裝置群組的部署。

az iot du device deployment show -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id}

顯示裝置群組部署的狀態。

az iot du device deployment show -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id} --status

顯示裝置類別子群組的部署。

az iot du device deployment show -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id}

顯示裝置類別子群組部署的狀態。

az iot du device deployment show -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id} --status

必要參數

--account -n

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

--deployment-id --did

--gid --group-id

裝置群組標識碼。這會從連線 IoT 中樞裝置/模組對應項中的 ADUGroup 標籤值，或針對沒有標記的裝置建立$default。

--instance -i

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

選擇性參數

--cid --class-id

裝置類別標識碼。這會從模型標識碼和裝置更新代理程式在 IoT 中樞中的裝置更新代理程式所報告的相容性屬性產生。這是十六進位編碼的SHA1哈希。

--resource-group -g

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

--status

取得部署的狀態，包括部署中有多少裝置正在進行、完成或失敗的細目。

接受的值: false, true

全域參數

--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 du device deployment

命令

az iot du device deployment cancel

範例

必要參數

選擇性參數

az iot du device deployment create

範例

必要參數

選擇性參數

az iot du device deployment delete

範例

必要參數

選擇性參數

az iot du device deployment list

範例

必要參數

選擇性參數

az iot du device deployment list-devices

範例

必要參數

選擇性參數

az iot du device deployment retry

範例

必要參數

選擇性參數

az iot du device deployment show

範例

必要參數

選擇性參數

其他資源