az iot central device edge children

注意

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

管理 IoT Edge 裝置子裝置。

命令

名稱 Description 類型 狀態
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 children add

預覽

此命令處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

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

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

範例

將裝置識別碼的空間分隔清單新增為目標邊緣裝置的子系。

az iot central device edge children add --app-id {appid} --device-id {deviceId} --children-ids {child_1} {child_2}

必要參數

--app-id -n

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

--children-ids

子裝置識別碼的空間分隔清單。

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

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

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

範例

列出裝置的所有子系。

az iot central device edge children list --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 edge children remove

預覽

此命令處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

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

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

範例

移除子系。

az iot central device edge children remove --app-id {appid} --device-id {deviceId} --children-ids {child_1} {child_2}

必要參數

--app-id -n

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

--children-ids

子裝置識別碼的空間分隔清單。

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