az iot central device
注意
此參考是 Azure CLI 的 azure-iot 延伸模組的一部分 (2.37.0 版或更高版本)。 擴充功能會在您第一次執行 az iot central device 命令時自動安裝。 深入了解擴充功能。
管理及設定 IoT Central 裝置。
命令
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}
必要參數
目標裝置的裝置識別碼。按一下 [裝置詳細資料] 頁面上的 [連線] 按鈕,即可找到裝置識別碼。
以 base64 格式儲存的主要對稱共用存取金鑰。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --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
必要參數
您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。
裝置的唯一識別碼。 區分大小寫的字串 (最長為 128 個字元),可使用 ASCII 7 位元英數字元和某些特殊字元:-。 + % _ # * ? ! ( ) , : = @ $ '.
選擇性參數
引數 'api_version' 已被取代,並將在未來版本中移除。
此命令參數已被取代,將會忽略。在未來版本中,我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作,我們將呼叫最新的預覽版本。
與您的應用程式相關聯的 IoT Central DNS 尾碼。
人類可讀取的裝置名稱。 範例:冰箱。
將裝置指派給指定的組織。 以逗號分隔的組織識別碼清單。 最低支援版本:1.1-preview。
如果您想要將 IoT Central 設定為模擬裝置,請新增此旗標。 如果這是 true,則需要 --template。
中央範本識別碼。範例:dtmi:ojpkindbz:modelDefinition:iild3tm_uo。
如果您想要提交要求而不向 Azure CLI 進行驗證,您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi,即可深入瞭解。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --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}
必要參數
您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。
目標裝置的裝置識別碼。按一下 [裝置詳細資料] 頁面上的 [連線] 按鈕,即可找到裝置識別碼。
選擇性參數
引數 'api_version' 已被取代,並將在未來版本中移除。
此命令參數已被取代,將會忽略。在未來版本中,我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作,我們將呼叫最新的預覽版本。
與您的應用程式相關聯的 IoT Central DNS 尾碼。
如果您想要提交要求而不向 Azure CLI 進行驗證,您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi,即可深入瞭解。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --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}
必要參數
您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。
選擇性參數
引數 'api_version' 已被取代,並將在未來版本中移除。
此命令參數已被取代,將會忽略。在未來版本中,我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作,我們將呼叫最新的預覽版本。
與您的應用程式相關聯的 IoT Central DNS 尾碼。
僅列出 IoT Edge 裝置。
如果您想要提交要求而不向 Azure CLI 進行驗證,您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi,即可深入瞭解。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --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}
必要參數
您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。
目標裝置的裝置識別碼。按一下 [裝置詳細資料] 頁面上的 [連線] 按鈕,即可找到裝置識別碼。
選擇性參數
引數 'api_version' 已被取代,並將在未來版本中移除。
此命令參數已被取代,將會忽略。在未來版本中,我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作,我們將呼叫最新的預覽版本。
與您的應用程式相關聯的 IoT Central DNS 尾碼。
裝置模組的名稱。
如果您想要提交要求而不向 Azure CLI 進行驗證,您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi,即可深入瞭解。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --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}
必要參數
您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。
目標裝置的裝置識別碼。按一下 [裝置詳細資料] 頁面上的 [連線] 按鈕,即可找到裝置識別碼。
選擇性參數
引數 'api_version' 已被取代,並將在未來版本中移除。
此命令參數已被取代,將會忽略。在未來版本中,我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作,我們將呼叫最新的預覽版本。
與您的應用程式相關聯的 IoT Central DNS 尾碼。
如果您想要提交要求而不向 Azure CLI 進行驗證,您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi,即可深入瞭解。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --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}
必要參數
您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。
目標裝置的裝置識別碼。按一下 [裝置詳細資料] 頁面上的 [連線] 按鈕,即可找到裝置識別碼。
選擇性參數
引數 'api_version' 已被取代,並將在未來版本中移除。
此命令參數已被取代,將會忽略。在未來版本中,我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作,我們將呼叫最新的預覽版本。
與您的應用程式相關聯的 IoT Central DNS 尾碼。
如果您想要提交要求而不向 Azure CLI 進行驗證,您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi,即可深入瞭解。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --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}
必要參數
您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。
目標裝置的裝置識別碼。按一下 [裝置詳細資料] 頁面上的 [連線] 按鈕,即可找到裝置識別碼。
選擇性參數
引數 'api_version' 已被取代,並將在未來版本中移除。
此命令參數已被取代,將會忽略。在未來版本中,我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作,我們將呼叫最新的預覽版本。
與您的應用程式相關聯的 IoT Central DNS 尾碼。
如果您想要提交要求而不向 Azure CLI 進行驗證,您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi,即可深入瞭解。
正整數。 在幾分鐘內將裝置移回原始中樞的 TTL。在後端中具有預設值。 請參閱有關造訪 的最新後端預設存留時間 https://github.com/iot-for-all/iot-central-high-availability-clients#readme 檔。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --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}
必要參數
您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。
目標裝置的裝置識別碼。按一下 [裝置詳細資料] 頁面上的 [連線] 按鈕,即可找到裝置識別碼。
選擇性參數
引數 'api_version' 已被取代,並將在未來版本中移除。
此命令參數已被取代,將會忽略。在未來版本中,我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作,我們將呼叫最新的預覽版本。
與您的應用程式相關聯的 IoT Central DNS 尾碼。
如果您想要提交要求而不向 Azure CLI 進行驗證,您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi,即可深入瞭解。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --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}
必要參數
您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。
目標裝置的裝置識別碼。按一下 [裝置詳細資料] 頁面上的 [連線] 按鈕,即可找到裝置識別碼。
選擇性參數
引數 'api_version' 已被取代,並將在未來版本中移除。
此命令參數已被取代,將會忽略。在未來版本中,我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作,我們將呼叫最新的預覽版本。
與您的應用程式相關聯的 IoT Central DNS 尾碼。
如果您想要提交要求而不向 Azure CLI 進行驗證,您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi,即可深入瞭解。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --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}
必要參數
您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。
目標裝置的裝置識別碼。按一下 [裝置詳細資料] 頁面上的 [連線] 按鈕,即可找到裝置識別碼。
選擇性參數
引數 'api_version' 已被取代,並將在未來版本中移除。
此命令參數已被取代,將會忽略。在未來版本中,我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作,我們將呼叫最新的預覽版本。
與您的應用程式相關聯的 IoT Central DNS 尾碼。
如果您想要提交要求而不向 Azure CLI 進行驗證,您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi,即可深入瞭解。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --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
必要參數
您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。
目標裝置的裝置識別碼。按一下 [裝置詳細資料] 頁面上的 [連線] 按鈕,即可找到裝置識別碼。
選擇性參數
引數 'api_version' 已被取代,並將在未來版本中移除。
此命令參數已被取代,將會忽略。在未來版本中,我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作,我們將呼叫最新的預覽版本。
與您的應用程式相關聯的 IoT Central DNS 尾碼。
人類可讀取的裝置名稱。 範例:冰箱。
如果您想要 IoT Central 啟用或停用裝置,請新增此旗標。
將裝置指派給指定的組織。 以逗號分隔的組織識別碼清單。 最低支援版本:1.1-preview。
如果您想要將 IoT Central 設定為模擬裝置,請新增此旗標。 如果這是 true,則需要 --template。
中央範本識別碼。範例:dtmi:ojpkindbz:modelDefinition:iild3tm_uo。
如果您想要提交要求而不向 Azure CLI 進行驗證,您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi,即可深入瞭解。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
意見反應
https://aka.ms/ContentUserFeedback。
即將登場:在 2024 年,我們將逐步淘汰 GitHub 問題作為內容的意見反應機制,並將它取代為新的意見反應系統。 如需詳細資訊,請參閱:提交並檢視相關的意見反應