az iot adr ns su instance

Note

此參考文獻是 Azure CLI(版本 2.73.0 或更高版本)azure-iot 擴充的一部分。 這個擴充功能會在你第一次執行 az IoT adr ns su 實例 指令時自動安裝。 深入了解擴充功能。

指揮組「iot adr ns」目前處於預覽階段並正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

管理驅動軟體更新的更新實例。

Update Instances 是頂級的 Microsoft。DeviceUpdate 資源。 它們在此被歸類為裝置登錄檔的可發現性,但並非命名空間子節點。

命令

名稱 Description 類型 狀態
az iot adr ns su instance check-name

請檢查是否有可用的更新實例名稱。

Extension Preview
az iot adr ns su instance create

建立一個更新實例。

Extension Preview
az iot adr ns su instance delete

刪除一個更新實例。

Extension Preview
az iot adr ns su instance list

列表更新實例。

Extension Preview
az iot adr ns su instance show

顯示更新實例。

Extension Preview
az iot adr ns su instance update

更新更新實例的標籤或管理身份。

Extension Preview
az iot adr ns su instance wait

等待更新實例條件。

Extension Preview

az iot adr ns su instance check-name

預覽

指令群組「iot adr ns su instance」目前處於預覽階段並正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

請檢查是否有可用的更新實例名稱。

az iot adr ns su instance check-name --name
                                     [--acquire-policy-token]
                                     [--change-reference]

範例

查個名字

az iot adr ns su instance check-name -n myUpdateInstance

必要參數

--name -n

更新實例的名稱。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az iot adr ns su instance create

預覽

指令群組「iot adr ns su instance」目前處於預覽階段並正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

建立一個更新實例。

創造了 Microsoft。DeviceUpdate/updateInstances 資源。 管理身份參數可組合並描述完整的期望身份狀態。 重新執行未啟用任何身份選項的建立,可保留現有實例的 SAMI/UAMI 設定、標籤及服務管理狀態。

az iot adr ns su instance create --name
                                 --resource-group
                                 [--acquire-policy-token]
                                 [--change-reference]
                                 [--location]
                                 [--mi-sa --system-assigned-mi {false, true}]
                                 [--mi-ua --user-assigned-mi]
                                 [--no-wait]
                                 [--tags]

範例

建立一個系統指派身份的實例

az iot adr ns su instance create -n myUpdateInstance -g myResourceGroup --location eastus2 --system-assigned-mi

建立一個由系統和使用者指派身份的實例

az iot adr ns su instance create -n myUpdateInstance -g myResourceGroup \
  --system-assigned-mi --user-assigned-mi /subscriptions/<sub>/resourceGroups/<rg>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/<identity>

將現有的實例身份替換為僅限使用者指派的設定

az iot adr ns su instance create -n myUpdateInstance -g myResourceGroup \
  --user-assigned-mi /subscriptions/<sub>/resourceGroups/<rg>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/<identity>

必要參數

--name -n

更新實例的名稱。

--resource-group -g

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

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--location -l

Location. 值的來源:az account list-locations。 您可以使用 az configure --defaults location=<location>來設定預設位置。

--mi-sa --system-assigned-mi

包含或移除系統指派的管理身份。 在建立或更新時,省略所有受管理身份選項可保留現有身份。

屬性 值
接受的值: false, true
--mi-ua --user-assigned-mi

完整的使用者指派管理身份資源識別碼(Managed Identity Resource ID)一組。 在建立或更新時,省略所有受管理身份選項可保留現有身份。

--no-wait

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

屬性 值
預設值: False
--tags

以空格分隔的標記:key[=value] [key[=value] ...]。使用 「清除現有的標記」。

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az iot adr ns su instance delete

預覽

指令群組「iot adr ns su instance」目前處於預覽階段並正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

刪除一個更新實例。

az iot adr ns su instance delete --name
                                 --resource-group
                                 [--acquire-policy-token]
                                 [--change-reference]
                                 [--no-wait]
                                 [--yes {false, true}]

範例

無需提示即可刪除

az iot adr ns su instance delete -n myUpdateInstance -g myResourceGroup --yes

必要參數

--name -n

更新實例的名稱。

--resource-group -g

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

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--no-wait

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

屬性 值
預設值: False
--yes -y

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

屬性 值
接受的值: false, true
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az iot adr ns su instance list

預覽

指令群組「iot adr ns su instance」目前處於預覽階段並正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

列表更新實例。

az iot adr ns su instance list [--resource-group]

範例

資源群組中的實例列表

az iot adr ns su instance list -g myResourceGroup

在訂閱中列出實例

az iot adr ns su instance list

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--resource-group -g

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

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az iot adr ns su instance show

預覽

指令群組「iot adr ns su instance」目前處於預覽階段並正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

顯示更新實例。

az iot adr ns su instance show --name
                               --resource-group

範例

舉例說明

az iot adr ns su instance show -n myUpdateInstance -g myResourceGroup

必要參數

--name -n

更新實例的名稱。

--resource-group -g

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

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az iot adr ns su instance update

預覽

指令群組「iot adr ns su instance」目前處於預覽階段並正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

更新更新實例的標籤或管理身份。

身份選項描述完整的所需身份狀態:--system-assigned-mi 控制 SAMI,--user-assigned-mi 提供 UAMI 集合。 省略兩個身份選項,保持現有身份不變。

az iot adr ns su instance update --name
                                 --resource-group
                                 [--acquire-policy-token]
                                 [--change-reference]
                                 [--mi-sa --system-assigned-mi {false, true}]
                                 [--mi-ua --user-assigned-mi]
                                 [--no-wait]
                                 [--tags]

範例

更新標籤

az iot adr ns su instance update -n myUpdateInstance -g myResourceGroup --tags environment=test

將身份設定為系統分配

az iot adr ns su instance update -n myUpdateInstance -g myResourceGroup --system-assigned-mi

必要參數

--name -n

更新實例的名稱。

--resource-group -g

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

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--mi-sa --system-assigned-mi

包含或移除系統指派的管理身份。 在建立或更新時,省略所有受管理身份選項可保留現有身份。

屬性 值
接受的值: false, true
--mi-ua --user-assigned-mi

完整的使用者指派管理身份資源識別碼(Managed Identity Resource ID)一組。 在建立或更新時,省略所有受管理身份選項可保留現有身份。

--no-wait

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

屬性 值
預設值: False
--tags

以空格分隔的標記:key[=value] [key[=value] ...]。使用 「清除現有的標記」。

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az iot adr ns su instance wait

預覽

指令群組「iot adr ns su instance」目前處於預覽階段並正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

等待更新實例條件。

若無明確的等待謂詞,則等待 provisioningState Succeeded。

az iot adr ns su instance wait --name
                               --resource-group
                               [--acquire-policy-token]
                               [--change-reference]
                               [--created]
                               [--custom]
                               [--deleted]
                               [--exists]
                               [--interval]
                               [--timeout]
                               [--updated]

範例

等到配置成功

az iot adr ns su instance wait -n myUpdateInstance -g myResourceGroup

必要參數

--name -n

更新實例的名稱。

--resource-group -g

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

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--created

等 provisioningState 成功後再說。

屬性 值
參數群組: Wait Condition Arguments
預設值: False
--custom

等自訂的 JMESPath 表達式被評估為真時再說。

屬性 值
參數群組: Wait Condition Arguments
--deleted

等資源被刪除後再說。

屬性 值
參數群組: Wait Condition Arguments
預設值: False
--exists

等候資源存在。

屬性 值
參數群組: Wait Condition Arguments
預設值: False
--interval

輪詢間隔以秒為單位。

屬性 值
參數群組: Wait Condition Arguments
預設值: 30
--timeout

投票預算只需幾秒鐘,包括獲得時間。 在飛行中的 GET 受傳輸逾時限制,且不得在此輪詢截止時間內中斷。

屬性 值
參數群組: Wait Condition Arguments
預設值: 3600
--updated

等 provisioningState 成功後再說。

屬性 值
參數群組: Wait Condition Arguments
預設值: False
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False