az iot central device-group

Nota

Essa referência faz parte da extensão azure-iot para a CLI do Azure (versão 2.46.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az iot central device-group . Saiba mais sobre extensões.

Gerencie e configure grupos de dispositivos do IoT Central.

Comandos

Name	Description	Tipo	Status
az iot central device-group create	Crie um grupo de dispositivos.	Extensão	GA
az iot central device-group delete	Excluir um grupo de dispositivos.	Extensão	GA
az iot central device-group list	Obtenha a lista de grupos de dispositivos para um aplicativo do IoT Central.	Extensão	GA
az iot central device-group show	Obtenha o grupo de dispositivos por ID.	Extensão	GA
az iot central device-group update	Atualizar um grupo de dispositivos existente.	Extensão	GA

az iot central device-group create

Crie um grupo de dispositivos.

Nota: Apenas uma organização é suportada hoje, várias organizações serão suportadas em breve.

az iot central device-group create --app-id
                                   --device-group-id
                                   --display-name
                                   --filter
                                   [--api-version {2022-06-30-preview, 2022-07-31}]
                                   [--central-api-uri]
                                   [--description]
                                   [--organizations]
                                   [--token]

Exemplos

Crie um grupo de dispositivos.

az iot central device-group create --app-id {appid} --device-group-id {devicegroupid} --display-name "DeviceGroup1" --filter "SELECT * FROM devices WHERE $provisioned = true" --description "This is a default device group." --organizations {organization}

Parâmetros Obrigatórios

--app-id -n

A ID do aplicativo IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--device-group-id

ID exclusivo do grupo de dispositivos.

--display-name

Nome para exibição do grupo de dispositivos.

--filter

Consulta definindo quais dispositivos devem estar nesse grupo. [Exemplo de filtro de consulta: SELECT * FROM devices WHERE $template = "dtmi:modelDefinition:dtdlv2"].

Parâmetros Opcionais

--api-version --av

Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Este parâmetro de comando foi preterido e será ignorado. Na versão futura, só suportaremos APIs do IoT Central a partir da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

Valores aceites: 2022-06-30-preview, 2022-07-31

Default value: 2022-07-31

--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Default value: azureiotcentral.com

--description

Breve resumo do grupo de dispositivos.

--organizations

Lista de IDs da organização do grupo de dispositivos.

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

Parâmetros de Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az iot central device-group delete

Excluir um grupo de dispositivos.

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

Exemplos

Excluir um grupo de dispositivos

az iot central device-group delete --app-id {appid} --device-group-id {devicegroupid}

Parâmetros Obrigatórios

--app-id -n

A ID do aplicativo IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--device-group-id

ID exclusivo do grupo de dispositivos.

Parâmetros Opcionais

--api-version --av

Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Este parâmetro de comando foi preterido e será ignorado. Na versão futura, só suportaremos APIs do IoT Central a partir da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

Valores aceites: 2022-06-30-preview, 2022-07-31

Default value: 2022-07-31

--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Default value: azureiotcentral.com

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

Parâmetros de Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az iot central device-group list

Obtenha a lista de grupos de dispositivos para um aplicativo do IoT Central.

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

Exemplos

Listar grupos de dispositivos em um aplicativo

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

Parâmetros Obrigatórios

--app-id -n

A ID do aplicativo IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

Parâmetros Opcionais

--api-version --av

Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Este parâmetro de comando foi preterido e será ignorado. Na versão futura, só suportaremos APIs do IoT Central a partir da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

Valores aceites: 2022-06-30-preview, 2022-07-31

Default value: 2022-07-31

--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Default value: azureiotcentral.com

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

Parâmetros de Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az iot central device-group show

Obtenha o grupo de dispositivos por ID.

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

Exemplos

Obtenha o grupo de dispositivos por ID.

az iot central device-group show --app-id {appid} --device-group-id {devicegroupid}

Parâmetros Obrigatórios

--app-id -n

A ID do aplicativo IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--device-group-id

ID exclusivo do grupo de dispositivos.

Parâmetros Opcionais

--api-version --av

Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Este parâmetro de comando foi preterido e será ignorado. Na versão futura, só suportaremos APIs do IoT Central a partir da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

Valores aceites: 2022-06-30-preview, 2022-07-31

Default value: 2022-07-31

--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Default value: azureiotcentral.com

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

Parâmetros de Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az iot central device-group update

Atualizar um grupo de dispositivos existente.

Nota: Apenas uma organização é suportada hoje, várias organizações serão suportadas em breve.

az iot central device-group update --app-id
                                   --device-group-id
                                   [--api-version {2022-06-30-preview, 2022-07-31}]
                                   [--central-api-uri]
                                   [--description]
                                   [--display-name]
                                   [--filter]
                                   [--organizations]
                                   [--token]

Exemplos

Atualizar um grupo de dispositivos via patch

az iot central device-group update --app-id {appid} --device-group-id {devicegroupid} --display-name {displayname} --filter {filter} --description {description} --organizations {organization}

Parâmetros Obrigatórios

--app-id -n

A ID do aplicativo IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--device-group-id

ID exclusivo do grupo de dispositivos.

Parâmetros Opcionais

--api-version --av

Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Este parâmetro de comando foi preterido e será ignorado. Na versão futura, só suportaremos APIs do IoT Central a partir da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

Valores aceites: 2022-06-30-preview, 2022-07-31

Default value: 2022-07-31

--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Default value: azureiotcentral.com

--description

Breve resumo do grupo de dispositivos.

--display-name

Nome para exibição do grupo de dispositivos.

--filter

Consulta definindo quais dispositivos devem estar nesse grupo. [Exemplo de filtro de consulta: SELECT * FROM devices WHERE $template = "dtmi:modelDefinition:dtdlv2"].

--organizations

Lista de IDs da organização do grupo de dispositivos.

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

Parâmetros de Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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