az iot central device

注意

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

管理及設定 IoT Central 裝置。

命令

名稱 Description 類型 狀態
az iot central device attestation

管理和設定 IoT Central 裝置證明。

副檔名 GA
az iot central device attestation create

建立個別裝置證明。

副檔名 GA
az iot central device attestation delete

移除個別裝置證明。

副檔名 GA
az iot central device attestation show

取得裝置證明。

副檔名 GA
az iot central device attestation update

透過修補程式更新個別裝置證明。

副檔名 GA
az iot central device c2d-message

執行裝置雲端到裝置傳訊命令。

副檔名 GA
az iot central device c2d-message purge

清除目標裝置的雲端到裝置訊息佇列。

副檔名 GA
az iot central device command

執行裝置命令。

副檔名 GA
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 compute-device-key

產生衍生裝置 SAS 金鑰。

副檔名 GA
az iot central device create

在 IoT Central 中建立裝置。

副檔名 GA
az iot central device delete

從 IoT Central 刪除裝置。

副檔名 GA
az iot central device edge

管理及設定 IoT Central Edge 裝置。

副檔名 GA
az iot central device edge children

管理 IoT Edge 裝置子裝置。

副檔名 GA
az iot central device edge children add

將裝置新增為目標邊緣裝置的子系。

副檔名 預覽版
az iot central device edge children list

取得 IoT Edge 裝置的子系列表。

副檔名 GA
az iot central device edge children remove

從目標邊緣裝置移除子裝置。

副檔名 預覽版
az iot central device edge manifest

管理 IoT Edge 裝置資訊清單。

副檔名 預覽版
az iot central device edge manifest show

取得與指定 IoT Edge 裝置相關聯的部署資訊清單。

副檔名 預覽版
az iot central device edge module

管理 IoT Edge 裝置模組。

副檔名 預覽版
az iot central device edge module list

取得 IoT Edge 裝置中的模組清單。

副檔名 預覽版
az iot central device edge module restart

在 IoT Edge 裝置中重新開機模組。

副檔名 預覽版
az iot central device edge module show

在 IoT Edge 裝置中取得模組。

副檔名 預覽版
az iot central device list

取得 IoT Central 應用程式的裝置清單。

副檔名 GA
az iot central device list-components

列出裝置中存在的元件。

副檔名 GA
az iot central device list-modules

列出裝置中的模組。

副檔名 GA
az iot central device manual-failback

將裝置移回原始IoT 中樞,以還原先前執行的容錯移轉命令。

副檔名 GA
az iot central device manual-failover

跨多個IoT 中樞執行裝置的手動容錯移轉,以驗證裝置韌體使用 DPS 重新連線到不同IoT 中樞的能力。

副檔名 GA
az iot central device registration-info

從 IoT Central 取得裝置的註冊資訊。

副檔名 GA
az iot central device show

從 IoT Central 取得裝置。

副檔名 GA
az iot central device show-credentials

從 IoT Central 取得裝置認證。

副檔名 GA
az iot central device telemetry

查詢 IoT Central 裝置上一個遙測值。

副檔名 GA
az iot central device telemetry show

從裝置取得最後一個遙測值。

副檔名 GA
az iot central device twin

管理 IoT Central 裝置對應項。

副檔名 GA
az iot central device twin replace

取代裝置、裝置元件或裝置模組或裝置模組元件的可寫入屬性值。

副檔名 GA
az iot central device twin show

取得裝置、裝置元件、裝置模組或裝置模組元件的所有屬性值。

副檔名 GA
az iot central device twin update

更新裝置、裝置元件、裝置模組或裝置模組元件的可寫入屬性值。

副檔名 GA
az iot central device update

更新 IoT Central 中的裝置。

副檔名 GA

az iot central device compute-device-key

產生衍生裝置 SAS 金鑰。

從群組層級 SAS 金鑰產生衍生的裝置金鑰。

az iot central device compute-device-key --device-id
                                         --pk

範例

基本使用方式

az iot central device compute-device-key --pk {primaryKey} --device-id {deviceid}

必要參數

--device-id -d

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

--pk --primary-key

以 base64 格式儲存的主要對稱共用存取金鑰。

全域參數
--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 create

在 IoT Central 中建立裝置。

az iot central device create --app-id
                             --device-id
                             [--api-version {2022-06-30-preview, 2022-07-31}]
                             [--central-api-uri]
                             [--device-name]
                             [--organizations]
                             [--simulated {false, true}]
                             [--template]
                             [--token]

範例

建立裝置

az iot central device create --app-id {appid} --device-id {deviceid}

建立模擬裝置

az iot central device create --app-id {appid} --device-id {deviceid} --template {devicetemplateid} --simulated

必要參數

--app-id -n

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

--device-id -d

裝置的唯一識別碼。 區分大小寫的字串 (最長為 128 個字元),可使用 ASCII 7 位元英數字元和某些特殊字元:-。 + % _ # * ? ! ( ) , : = @ $ '.

選擇性參數

--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
--device-name

人類可讀取的裝置名稱。 範例:冰箱。

--organizations --orgs

將裝置指派給指定的組織。 以逗號分隔的組織識別碼清單。 最低支援版本:1.1-preview。

--simulated

如果您想要將 IoT Central 設定為模擬裝置,請新增此旗標。 如果這是 true,則需要 --template。

接受的值: false, true
預設值: False
--template

中央範本識別碼。範例:dtmi:ojpkindbz:modelDefinition:iild3tm_uo。

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

從 IoT Central 刪除裝置。

az iot central device delete --app-id
                             --device-id
                             [--api-version {2022-06-30-preview, 2022-07-31}]
                             [--central-api-uri]
                             [--token]

範例

刪除裝置

az iot central device delete --app-id {appid} --device-id {deviceid}

必要參數

--app-id -n

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

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

取得 IoT Central 應用程式的裝置清單。

az iot central device list --app-id
                           [--api-version {2022-06-30-preview, 2022-07-31}]
                           [--central-api-uri]
                           [--edge-only]
                           [--token]

範例

列出應用程式中的所有裝置,依裝置識別碼排序 (預設值)

az iot central device list --app-id {appid}

必要參數

--app-id -n

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

選擇性參數

--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
--edge-only -e

僅列出 IoT Edge 裝置。

預設值: False
--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 list-components

列出裝置中存在的元件。

az iot central device list-components --app-id
                                      --device-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--mn]
                                      [--token]

範例

列出裝置中存在的元件

az iot central device list-components --app-id {appid} --device-id {deviceid}

列出裝置模組中存在的元件

az iot central device list-components --app-id {appid} --module-name {modulename} --device-id {deviceid}

必要參數

--app-id -n

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

--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
--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 list-modules

列出裝置中的模組。

az iot central device list-modules --app-id
                                   --device-id
                                   [--api-version {2022-06-30-preview, 2022-07-31}]
                                   [--central-api-uri]
                                   [--token]

範例

列出裝置中的模組

az iot central device list-modules --app-id {appid} --device-id {deviceid}

必要參數

--app-id -n

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

--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
--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 manual-failback

將裝置移回原始IoT 中樞,以還原先前執行的容錯移轉命令。

如需高可用性的詳細資訊,請造訪 https://github.com/iot-for-all/iot-central-high-availability-clients#readme

az iot central device manual-failback --app-id
                                      --device-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--token]

範例

將裝置移回原始IoT 中樞來還原先前執行的容錯移轉命令

az iot central device manual-failback --app-id {appid} --device-id {deviceid}

必要參數

--app-id -n

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

--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
--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 manual-failover

跨多個IoT 中樞執行裝置的手動容錯移轉,以驗證裝置韌體使用 DPS 重新連線到不同IoT 中樞的能力。

如需有關 ttl-minutes 高可用性和預設值的詳細資訊,請造訪 https://github.com/iot-for-all/iot-central-high-availability-clients#readme

az iot central device manual-failover --app-id
                                      --device-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--token]
                                      [--ttl]

範例

跨多個IoT 中樞執行裝置的手動容錯移轉,以驗證裝置韌體使用 DPS 重新連線到不同IoT 中樞的能力。

az iot central device manual-failover --app-id {appid} --device-id {deviceid} --ttl-minutes {ttl_minutes}

必要參數

--app-id -n

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

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

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

--ttl --ttl-minutes

正整數。 在幾分鐘內將裝置移回原始中樞的 TTL。在後端中具有預設值。 請參閱有關造訪 的最新後端預設存留時間 https://github.com/iot-for-all/iot-central-high-availability-clients#readme 檔。

全域參數
--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 registration-info

從 IoT Central 取得裝置的註冊資訊。

注意:如果未指定任何裝置識別碼,且您的應用程式包含大量裝置,此命令可能需要大量時間才能傳回。

az iot central device registration-info --app-id
                                        --device-id
                                        [--api-version {2022-06-30-preview, 2022-07-31}]
                                        [--central-api-uri]
                                        [--token]

範例

取得指定裝置上的註冊資訊

az iot central device registration-info --app-id {appid} --device-id {deviceid}

必要參數

--app-id -n

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

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

從 IoT Central 取得裝置。

az iot central device show --app-id
                           --device-id
                           [--api-version {2022-06-30-preview, 2022-07-31}]
                           [--central-api-uri]
                           [--token]

範例

取得裝置

az iot central device show --app-id {appid} --device-id {deviceid}

必要參數

--app-id -n

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

--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
--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 show-credentials

從 IoT Central 取得裝置認證。

az iot central device show-credentials --app-id
                                       --device-id
                                       [--api-version {2022-06-30-preview, 2022-07-31}]
                                       [--central-api-uri]
                                       [--token]

範例

取得裝置的裝置認證

az iot central device show-credentials --app-id {appid} --device-id {deviceid}

必要參數

--app-id -n

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

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

更新 IoT Central 中的裝置。

允許變更裝置的下列屬性:「displayName」、「template」、「simulated」、「enabled」 和 「organizations」。 無法變更裝置識別碼。

az iot central device update --app-id
                             --device-id
                             [--api-version {2022-06-30-preview, 2022-07-31}]
                             [--central-api-uri]
                             [--device-name]
                             [--enable {false, true}]
                             [--organizations]
                             [--simulated {false, true}]
                             [--template]
                             [--token]

範例

更新裝置顯示名稱

az iot central device update --app-id {appid} --device-id {deviceid} --device-name {deviceName}

將模擬裝置轉換成實際裝置

az iot central device update --app-id {appid} --device-id {deviceid} --simulated false

更新裝置的組織

az iot central device update --app-id {appid} --device-id {deviceid} --organizations {organizations}

停用裝置

az iot central device update --app-id {appid} --device-id {deviceid} --enable false

必要參數

--app-id -n

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

--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
--device-name

人類可讀取的裝置名稱。 範例:冰箱。

--enable

如果您想要 IoT Central 啟用或停用裝置,請新增此旗標。

接受的值: false, true
--organizations --orgs

將裝置指派給指定的組織。 以逗號分隔的組織識別碼清單。 最低支援版本:1.1-preview。

--simulated

如果您想要將 IoT Central 設定為模擬裝置,請新增此旗標。 如果這是 true,則需要 --template。

接受的值: false, true
--template

中央範本識別碼。範例:dtmi:ojpkindbz:modelDefinition:iild3tm_uo。

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