az iot hub device-identity children

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). A extensão será instalada automaticamente na primeira vez que você executar um comando filhos de identidade de dispositivo az iot hub. Learn more about extensions.

Gerencie relacionamentos de dispositivos filhos para dispositivos de borda IoT.

Comandos

Name	Description	Tipo	Status
az iot hub device-identity children add	Adicione dispositivos como crianças a um dispositivo de borda de destino.	Extension	disponibilidade geral
az iot hub device-identity children list	Produz a coleção de dispositivos filho atribuídos.	Extension	disponibilidade geral
az iot hub device-identity children remove	Remova dispositivos filho de um dispositivo de borda de destino.	Extension	disponibilidade geral

az iot hub device-identity children add

Adicione dispositivos como crianças a um dispositivo de borda de destino.

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

Exemplos

Adicione uma lista separada por espaço de Ids de dispositivo como filhos ao dispositivo de borda de destino.

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

Adicione dispositivos como filhos ao dispositivo de borda e substitua o pai existente dos dispositivos filhos.

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

Parâmetros Obrigatórios

--child-list --cl

Lista de dispositivos filho (espaço separado).

--device-id -d

Id do dispositivo de borda.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão atual do Azure AD. Se o tipo de autenticação for login e o nome de host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que necessário. Você pode configurar o padrão usando az configure --defaults iothub-data-auth-type={auth-type-value}.

Propriedade	Valor
Parameter group:	Access Control Arguments
Default value:	key
Valores aceites:	key, login

--force -f

Substitui o dispositivo pai do dispositivo filho.

Propriedade	Valor
Default value:	False

--hub-name -n

Nome ou nome do host do Hub IoT. Obrigatório se --login não for fornecido.

Propriedade	Valor
Parameter group:	IoT Hub Identifier Arguments

--login -l

Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar login de sessão via "az login". Se uma cadeia de conexão de entidade e um nome forem fornecidos, a cadeia de conexão terá prioridade. Obrigatório se --hub-name não for fornecido.

Propriedade	Valor
Parameter group:	IoT Hub Identifier Arguments

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Output format.

Propriedade	Valor
Default value:	json
Valores aceites:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade	Valor
Default value:	False

az iot hub device-identity children list

Produz a coleção de dispositivos filho atribuídos.

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

Exemplos

Liste todos os dispositivos filhos atribuídos.

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

Liste todos os dispositivos atribuídos às crianças cujo ID do dispositivo contenha uma substring de 'teste'.

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

Parâmetros Obrigatórios

--device-id -d

Id do dispositivo de borda.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão atual do Azure AD. Se o tipo de autenticação for login e o nome de host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que necessário. Você pode configurar o padrão usando az configure --defaults iothub-data-auth-type={auth-type-value}.

Propriedade	Valor
Parameter group:	Access Control Arguments
Default value:	key
Valores aceites:	key, login

--hub-name -n

Nome ou nome do host do Hub IoT. Obrigatório se --login não for fornecido.

Propriedade	Valor
Parameter group:	IoT Hub Identifier Arguments

--login -l

Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar login de sessão via "az login". Se uma cadeia de conexão de entidade e um nome forem fornecidos, a cadeia de conexão terá prioridade. Obrigatório se --hub-name não for fornecido.

Propriedade	Valor
Parameter group:	IoT Hub Identifier Arguments

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Output format.

Propriedade	Valor
Default value:	json
Valores aceites:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade	Valor
Default value:	False

az iot hub device-identity children remove

Remova dispositivos filho de um dispositivo de borda de destino.

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

Exemplos

Remova uma lista separada por espaço de dispositivos filho de um dispositivo pai de destino.

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

Remova todos os dispositivos filho de um dispositivo pai de destino.

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

Parâmetros Obrigatórios

--device-id -d

Id do dispositivo de borda.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão atual do Azure AD. Se o tipo de autenticação for login e o nome de host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que necessário. Você pode configurar o padrão usando az configure --defaults iothub-data-auth-type={auth-type-value}.

Propriedade	Valor
Parameter group:	Access Control Arguments
Default value:	key
Valores aceites:	key, login

--child-list --cl

Lista de dispositivos filho (espaço separado).

--hub-name -n

Nome ou nome do host do Hub IoT. Obrigatório se --login não for fornecido.

Propriedade	Valor
Parameter group:	IoT Hub Identifier Arguments

--login -l

Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar login de sessão via "az login". Se uma cadeia de conexão de entidade e um nome forem fornecidos, a cadeia de conexão terá prioridade. Obrigatório se --hub-name não for fornecido.

Propriedade	Valor
Parameter group:	IoT Hub Identifier Arguments

--remove-all -a

Para remover todas as crianças.

Propriedade	Valor
Default value:	False

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Output format.

Propriedade	Valor
Default value:	json
Valores aceites:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade	Valor
Default value:	False