共用方式為

az iot central device command

  • 參考

注意

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

執行裝置命令。

命令

名稱 Description 類型 狀態
az iot central device command history

取得傳送至裝置的最新命令要求和回應的詳細數據。

 副檔名 GA
az iot central device command run

在裝置上執行命令，並檢視相關聯的回應。 Not monitor property updates that the command may perform.

 副檔名 GA

az iot central device command history

取得傳送至裝置的最新命令要求和回應的詳細數據。

列出從IoT Central傳送至裝置的最新命令要求和回應。 由於命令執行的結果，裝置對裝置屬性執行的任何更新都不會包含在回應中。

az iot central device command history --app-id
                                      --cn
                                      --device-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--co]
                                      [--interface-id]
                                      [--mn]
                                      [--token]

範例

顯示命令回應

az iot central device command history --app-id {appid} --device-id {deviceid} --interface-id {interfaceid} --command-name {commandname}

顯示元件命令回應

az iot central device command history --app-id {appid} --device-id {deviceid} --component-name {componentname} --command-name {commandname}

顯示模組元件命令回應

az iot central device command history --app-id {appid} --device-id {deviceid} --module-name {modulename} --component-name {componentname} --command-name {commandname}

必要參數

--app-id -n

您要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式[關於] 頁面的 [說明] 選單下找到應用程式識別碼。

--cn --command-name

裝置範本中指定的命令名稱。 命令名稱可能會與命令的 [顯示名稱] 不同。

--device-id -d

目標裝置的裝置識別碼。按兩下 [裝置詳細資料] 頁面上的 [連線] 按鈕，即可找到裝置標識碼。

選擇性參數

--api-version --av
已被取代

自變數 'api_version' 已被取代，並將在未來版本中移除。

此命令參數已被取代，將會忽略。在未來版本中，我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作，我們將呼叫最新的預覽版本。

接受的值: 2022-06-30-preview, 2022-07-31
預設值: 2022-07-31
--central-api-uri --central-dns-suffix

與您的應用程式相關聯的IoT Central DNS後綴。

預設值: azureiotcentral.com
--co --component-name

裝置元件的名稱。

--interface-id -i

裝置範本中指定的介面/元件名稱。您可以流覽至 [裝置範本]，並在對應的裝置功能下檢視介面/元件身分識別來找到它。

--mn --module-name

裝置模組的名稱。

--token

如果您想要提交要求而不向 Azure CLI 進行驗證，您可以指定有效的使用者令牌來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi，即可深入瞭解。

全域參數
--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 central device command run

在裝置上執行命令，並檢視相關聯的回應。 Not monitor property updates that the command may perform.

--content 可以是內嵌 json 或檔案路徑。

az iot central device command run --app-id
                                  --cn
                                  --content
                                  --device-id
                                  [--api-version {2022-06-30-preview, 2022-07-31}]
                                  [--central-api-uri]
                                  [--co]
                                  [--interface-id]
                                  [--mn]
                                  [--token]

範例

使用內嵌承載執行命令。 承載應位於 json 字串中的「要求」之下

az iot central device command run --app-id {appid} --device-id {deviceid} --interface-id {interfaceid} --command-name {commandname} --content '{"request": {payload}}'

使用 json 承載路徑的短期執行命令。

az iot central device command run -n {appid} -d {deviceid} -i {interfaceid} --cn {commandname} -k {payload_file_path}

執行元件命令。

az iot central device command run -n {appid} -d {deviceid} --co {componentname} --cn {commandname} -k {payload}

執行模組元件命令。

az iot central device command run -n {appid} -d {deviceid} --mn {modulename} --co {componentname} --cn {commandname} -k {payload}

必要參數

--app-id -n

您要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式[關於] 頁面的 [說明] 選單下找到應用程式識別碼。

--cn --command-name

裝置範本中指定的命令名稱。 命令名稱可能會與命令的 [顯示名稱] 不同。

--content -k

要求的組態。 提供 JSON 檔案或原始字串化 JSON 的路徑。 [檔案路徑範例：./path/to/file.json][字串化 JSON 範例： {'a'： 'b'}]。

--device-id -d

目標裝置的裝置識別碼。按兩下 [裝置詳細資料] 頁面上的 [連線] 按鈕，即可找到裝置標識碼。

選擇性參數

--api-version --av
已被取代

自變數 'api_version' 已被取代，並將在未來版本中移除。

此命令參數已被取代，將會忽略。在未來版本中，我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作，我們將呼叫最新的預覽版本。

接受的值: 2022-06-30-preview, 2022-07-31
預設值: 2022-07-31
--central-api-uri --central-dns-suffix

與您的應用程式相關聯的IoT Central DNS後綴。

預設值: azureiotcentral.com
--co --component-name

裝置元件的名稱。

--interface-id -i

裝置範本中指定的介面/元件名稱。您可以流覽至 [裝置範本]，並在對應的裝置功能下檢視介面/元件身分識別來找到它。

--mn --module-name

裝置模組的名稱。

--token

如果您想要提交要求而不向 Azure CLI 進行驗證，您可以指定有效的使用者令牌來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi，即可深入瞭解。

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