az iot hub device-identity children

注意

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

管理 IoT Edge 裝置的子裝置關聯性。

命令

名稱	Description	類型	狀態
az iot hub device-identity children add	將裝置新增為目標邊緣裝置的子系。	擴充	GA
az iot hub device-identity children list	輸出指派子裝置的集合。	擴充	GA
az iot hub device-identity children remove	從目標邊緣裝置移除子裝置。	擴充	GA

az iot hub device-identity children add

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

az iot hub device-identity children add --child-list
                                        --device-id
                                        [--auth-type {key, login}]
                                        [--force]
                                        [--hub-name]
                                        [--login]
                                        [--resource-group]

範例

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

az iot hub device-identity children add -d {edge_device_id} --child-list {child_device_id_1} {child_device_id_2} -n {iothub_name}

將裝置新增為邊緣裝置，並覆寫子系裝置的現有父系。

az iot hub device-identity children add -d {edge_device_id} --child-list {child_device_id_1} {child_device_id_2} -n {iothub_name} -f

必要參數

--child-list --cl

子裝置清單（空格分隔）。

--device-id -d

邊緣裝置的識別碼。

選擇性參數

--auth-type

指出作業是否應該自動衍生原則金鑰，或使用目前的 Azure AD 會話。 如果驗證類型是登入，而且會提供資源主機名稱，除非需要，否則將會略過資源查閱。您可以使用 來設定預設值 az configure --defaults iothub-data-auth-type=<auth-type-value> 。

接受的值: key, login

預設值: key

--force -f

覆寫子裝置的父裝置。

預設值: False

--hub-name -n

IoT 中樞名稱或主機名稱。 如果未提供 --login，則為必要項。

--login -l

此命令支援具有執行動作許可權的實體連接字串。 使用 來避免透過 「az login」 的會話登入。 如果提供實體連接字串和名稱，則連接字串優先。 如果未提供 --hub-name，則為必要專案。

--resource-group -g

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

全域參數

--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 hub device-identity children list

輸出指派子裝置的集合。

az iot hub device-identity children list --device-id
                                         [--auth-type {key, login}]
                                         [--hub-name]
                                         [--login]
                                         [--resource-group]

範例

列出所有指派的子裝置。

az iot hub device-identity children list -d {edge_device_id} -n {iothub_name}

列出所有指派的子裝置，其裝置識別碼包含 'test' 的子字串。

az iot hub device-identity children list -d {edge_device_id} -n {iothub_name} --query "[?contains(@,'test')]"

必要參數

--device-id -d

邊緣裝置的識別碼。

選擇性參數

--auth-type

指出作業是否應該自動衍生原則金鑰，或使用目前的 Azure AD 會話。 如果驗證類型是登入，而且會提供資源主機名稱，除非需要，否則將會略過資源查閱。您可以使用 來設定預設值 az configure --defaults iothub-data-auth-type=<auth-type-value> 。

接受的值: key, login

預設值: key

--hub-name -n

IoT 中樞名稱或主機名稱。 如果未提供 --login，則為必要項。

--login -l

此命令支援具有執行動作許可權的實體連接字串。 使用 來避免透過 「az login」 的會話登入。 如果提供實體連接字串和名稱，則連接字串優先。 如果未提供 --hub-name，則為必要專案。

--resource-group -g

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

全域參數

--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 hub device-identity children remove

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

az iot hub device-identity children remove --device-id
                                           [--auth-type {key, login}]
                                           [--child-list]
                                           [--hub-name]
                                           [--login]
                                           [--remove-all]
                                           [--resource-group]

範例

從目標父裝置移除以空格分隔的子裝置清單。

az iot hub device-identity children remove -d {edge_device_id} --child-list {space_separated_device_id} -n {iothub_name}

從目標父裝置移除所有子裝置。

az iot hub device-identity children remove -d {edge_device_id} --remove-all

必要參數

--device-id -d

邊緣裝置的識別碼。

選擇性參數

--auth-type

指出作業是否應該自動衍生原則金鑰，或使用目前的 Azure AD 會話。 如果驗證類型是登入，而且會提供資源主機名稱，除非需要，否則將會略過資源查閱。您可以使用 來設定預設值 az configure --defaults iothub-data-auth-type=<auth-type-value> 。

接受的值: key, login

預設值: key

--child-list --cl

子裝置清單（空格分隔）。

--hub-name -n

IoT 中樞名稱或主機名稱。 如果未提供 --login，則為必要項。

--login -l

此命令支援具有執行動作許可權的實體連接字串。 使用 來避免透過 「az login」 的會話登入。 如果提供實體連接字串和名稱，則連接字串優先。 如果未提供 --hub-name，則為必要專案。

--remove-all -a

移除所有子系。

預設值: False

--resource-group -g

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

全域參數

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