az iot central device-group

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). A extensão instalará automaticamente na primeira vez que você executar um comando az iot central device-group. Learn more about extensions.

Gerencie e configure grupos de dispositivos do IoT Central.

Comandos

Nome	Description	Tipo	Status
az iot central device-group create	Criar um grupo de dispositivos.	Extension	GA
az iot central device-group delete	Exclua um grupo de dispositivos.	Extension	GA
az iot central device-group list	Obtenha a lista de grupos de dispositivos para um aplicativo do IoT Central.	Extension	GA
az iot central device-group show	Obtenha o grupo de dispositivos por ID.	Extension	GA
az iot central device-group update	Atualize um grupo de dispositivos existente.	Extension	GA

az iot central device-group create

Criar um grupo de dispositivos.

Observação: 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 --av {2022-06-30-preview, 2022-07-31}]
                                   [--central-api-uri --central-dns-suffix]
                                   [--description]
                                   [--organizations]
                                   [--token]

Exemplos

Criar 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 Exigidos

--app-id -n

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

--device-group-id

ID exclusiva do grupo de dispositivos.

--display-name

Nome de 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

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

--api-version --av

Preterido

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

Esse parâmetro de comando foi preterido e será ignorado. Na versão futura, só ofereceremos suporte a APIs do IoT Central da versão mais recente da GA. Se alguma API ainda não for GA, chamaremos a versão prévia mais recente.

Propriedade	Valor
Valor padrão:	2022-07-31
Valores aceitos:	2022-06-30-preview, 2022-07-31

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade	Valor
Valor padrão:	azureiotcentral.com

--description

Resumo curto do grupo de dispositivos.

--organizations

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

--token

Se preferir enviar sua solicitação sem se autenticar na CLI do Azure, você poderá 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 Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Output format.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade	Valor
Valor padrão:	False

az iot central device-group delete

Exclua um grupo de dispositivos.

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

Exemplos

Excluir um grupo de dispositivos

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

Parâmetros Exigidos

--app-id -n

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

--device-group-id

ID exclusiva do grupo de dispositivos.

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.

--api-version --av

Preterido

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

Esse parâmetro de comando foi preterido e será ignorado. Na versão futura, só ofereceremos suporte a APIs do IoT Central da versão mais recente da GA. Se alguma API ainda não for GA, chamaremos a versão prévia mais recente.

Propriedade	Valor
Valor padrão:	2022-07-31
Valores aceitos:	2022-06-30-preview, 2022-07-31

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade	Valor
Valor padrão:	azureiotcentral.com

--token

Se preferir enviar sua solicitação sem se autenticar na CLI do Azure, você poderá 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 Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Output format.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade	Valor
Valor padrão:	False

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 --av {2022-06-30-preview, 2022-07-31}]
                                 [--central-api-uri --central-dns-suffix]
                                 [--token]

Exemplos

Listar grupos de dispositivos em um aplicativo

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

Parâmetros Exigidos

--app-id -n

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

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.

--api-version --av

Preterido

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

Esse parâmetro de comando foi preterido e será ignorado. Na versão futura, só ofereceremos suporte a APIs do IoT Central da versão mais recente da GA. Se alguma API ainda não for GA, chamaremos a versão prévia mais recente.

Propriedade	Valor
Valor padrão:	2022-07-31
Valores aceitos:	2022-06-30-preview, 2022-07-31

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade	Valor
Valor padrão:	azureiotcentral.com

--token

Se preferir enviar sua solicitação sem se autenticar na CLI do Azure, você poderá 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 Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Output format.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade	Valor
Valor padrão:	False

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 --av {2022-06-30-preview, 2022-07-31}]
                                 [--central-api-uri --central-dns-suffix]
                                 [--token]

Exemplos

Obtenha o grupo de dispositivos por ID.

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

Parâmetros Exigidos

--app-id -n

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

--device-group-id

ID exclusiva do grupo de dispositivos.

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.

--api-version --av

Preterido

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

Esse parâmetro de comando foi preterido e será ignorado. Na versão futura, só ofereceremos suporte a APIs do IoT Central da versão mais recente da GA. Se alguma API ainda não for GA, chamaremos a versão prévia mais recente.

Propriedade	Valor
Valor padrão:	2022-07-31
Valores aceitos:	2022-06-30-preview, 2022-07-31

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade	Valor
Valor padrão:	azureiotcentral.com

--token

Se preferir enviar sua solicitação sem se autenticar na CLI do Azure, você poderá 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 Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Output format.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade	Valor
Valor padrão:	False

az iot central device-group update

Atualize um grupo de dispositivos existente.

Observação: 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 --av {2022-06-30-preview, 2022-07-31}]
                                   [--central-api-uri --central-dns-suffix]
                                   [--description]
                                   [--display-name]
                                   [--filter]
                                   [--organizations]
                                   [--token]

Exemplos

Atualizar um grupo de dispositivos por meio de 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 Exigidos

--app-id -n

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

--device-group-id

ID exclusiva do grupo de dispositivos.

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.

--api-version --av

Preterido

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

Esse parâmetro de comando foi preterido e será ignorado. Na versão futura, só ofereceremos suporte a APIs do IoT Central da versão mais recente da GA. Se alguma API ainda não for GA, chamaremos a versão prévia mais recente.

Propriedade	Valor
Valor padrão:	2022-07-31
Valores aceitos:	2022-06-30-preview, 2022-07-31

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade	Valor
Valor padrão:	azureiotcentral.com

--description

Resumo curto do grupo de dispositivos.

--display-name

Nome de 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 se autenticar na CLI do Azure, você poderá 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 Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Output format.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade	Valor
Valor padrão:	False