az iot central diagnostics

Versão Prévia

Note

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

Esse grupo de comandos está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Execute diagnósticos no nível do aplicativo e do dispositivo.

Comandos

Nome	Description	Tipo	Status
az iot central diagnostics monitor-events	Exiba as mensagens de telemetria do dispositivo enviadas ao aplicativo IoT Central.	Extension	Preview
az iot central diagnostics monitor-properties	Exiba as propriedades desejadas e relatadas enviadas de/para o aplicativo IoT Central.	Extension	Preview
az iot central diagnostics registration-summary	Visualize o resumo de registro de todos os dispositivos em um aplicativo.	Extension	Preview
az iot central diagnostics validate-messages	Valide as mensagens enviadas ao Hub IoT para um aplicativo do IoT Central.	Extension	Preview
az iot central diagnostics validate-properties	Valide as propriedades relatadas enviadas ao aplicativo IoT Central.	Extension	Preview

az iot central diagnostics monitor-events

Versão Prévia

O grupo de comandos 'iot central diagnostics' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Exiba as mensagens de telemetria do dispositivo enviadas ao aplicativo IoT Central.

Mostra os dados de telemetria enviados para o aplicativo IoT Central. Por padrão, ele mostra todos os dados enviados por todos os dispositivos. Use o parâmetro --device-id para filtrar para um dispositivo específico.

az iot central diagnostics monitor-events --app-id
                                          [--central-api-uri --central-dns-suffix]
                                          [--cg --consumer-group]
                                          [--device-id]
                                          [--enqueued-time --et]
                                          [--module-id]
                                          [--properties --props {all, anno, app, sys}]
                                          [--repair {false, true}]
                                          [--timeout --to]
                                          [--token]
                                          [--yes {false, true}]

Exemplos

Uso Básico

az iot central diagnostics monitor-events --app-id {app_id}

Uso básico ao filtrar no dispositivo de destino

az iot central diagnostics monitor-events --app-id {app_id} -d {device_id}

Uso básico ao filtrar dispositivos de destino com um curinga na ID

az iot central diagnostics monitor-events --app-id {app_id} -d Device*d

Uso básico ao filtrar no módulo.

az iot central diagnostics monitor-events --app-id {app_id} -m {module_id}

Uso básico ao filtrar módulos de destino com um curinga na ID

az iot central diagnostics monitor-events --app-id {app_id} -m Module*

Filtre o dispositivo e especifique um grupo de consumidores do Hub de Eventos ao qual associar.

az iot central diagnostics monitor-events --app-id {app_id} -d {device_id} --cg {consumer_group_name}

Receber anotações de mensagem (cabeçalhos de mensagem)

az iot central diagnostics monitor-events --app-id {app_id} -d {device_id} --properties anno

Receber anotações de mensagem + propriedades do sistema. Nunca exceda o tempo limite.

az iot central diagnostics monitor-events --app-id {app_id} -d {device_id} --properties anno sys --timeout 0

Receber todos os atributos de mensagem de todas as mensagens do dispositivo

az iot central diagnostics monitor-events --app-id {app_id} --props all

Receber todas as mensagens e analisar o conteúdo da mensagem como JSON

az iot central diagnostics monitor-events --app-id {app_id} --output json

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade	Valor
Valor padrão:	azureiotcentral.com

--cg --consumer-group -c

Especifique o grupo de consumidores a ser usado ao se conectar ao ponto de extremidade do hub de eventos.

Propriedade	Valor
Valor padrão:	$Default

--device-id -d

A ID do dispositivo de destino. Você pode encontrar a ID do dispositivo clicando no botão Conectar na página Detalhes do Dispositivo.

--enqueued-time --et -e

Indica o tempo que deve ser usado como ponto de partida para ler mensagens das partições. As unidades são milissegundos desde a época do unix. Se nenhuma hora for indicada "agora" será usada.

--module-id -m

A ID do módulo do IoT Edge se o tipo de dispositivo for IoT Edge.

--properties --props -p

Indique as propriedades da mensagem de chave para a saída. sys = propriedades do sistema, aplicativo = propriedades do aplicativo, anno = anotações.

Propriedade	Valor
Valores aceitos:	all, anno, app, sys

--repair -r

Reinstale a dependência uamqp compatível com a versão de extensão. Padrão: false.

Propriedade	Valor
Valor padrão:	False
Valores aceitos:	false, true

--timeout --to -t

Máximo de segundos para manter a conexão sem receber mensagem. Use 0 para infinito.

Propriedade	Valor
Valor padrão:	300

--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.

--yes -y

Ignore as solicitações do usuário. Indica a aceitação da ação. Usado principalmente para cenários de automação. Padrão: false.

Propriedade	Valor
Valor padrão:	False
Valores aceitos:	false, true

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

Formato de saída.

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 diagnostics monitor-properties

Versão Prévia

O grupo de comandos 'iot central diagnostics' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Exiba as propriedades desejadas e relatadas enviadas de/para o aplicativo IoT Central.

Sonda o dispositivo gêmeo do centro e o compara com o último dispositivo gêmeo Analisa as propriedades do dispositivo gêmeo e detecta se foram feitas alterações Imprime o subconjunto de propriedades que foram alteradas dentro do intervalo de sondagem.

az iot central diagnostics monitor-properties --app-id
                                              --device-id
                                              [--central-api-uri --central-dns-suffix]
                                              [--token]

Exemplos

Uso Básico

az iot central diagnostics monitor-properties --app-id {app_id} -d {device_id}

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-id -d

A ID do dispositivo de destino. Você pode encontrar a ID do dispositivo clicando no botão Conectar na página Detalhes do Dispositivo.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade	Valor
Valor padrão:	azureiotcentral.com

--token

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

Formato de saída.

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 diagnostics registration-summary

Versão Prévia

O grupo de comandos 'iot central diagnostics' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Visualize o resumo de registro de todos os dispositivos em um aplicativo.

Observação: esse comando pode levar um tempo significativo para retornar se o aplicativo contiver muitos dispositivos.

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

Exemplos

Resumo do registro

az iot central diagnostics registration-summary --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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

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

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

Formato de saída.

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 diagnostics validate-messages

Versão Prévia

O grupo de comandos 'iot central diagnostics' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Valide as mensagens enviadas ao Hub IoT para um aplicativo do IoT Central.

Executa validações nas mensagens de telemetria e relata dados que não são modelados no modelo de dispositivo ou dados em que o tipo de dados não corresponde ao que está definido no modelo de dispositivo.

az iot central diagnostics validate-messages --app-id
                                             [--central-api-uri --central-dns-suffix]
                                             [--cg --consumer-group]
                                             [--device-id]
                                             [--dr --duration]
                                             [--enqueued-time --et]
                                             [--max-messages --mm]
                                             [--minimum-severity {error, info, warning}]
                                             [--module-id]
                                             [--properties --props {all, anno, app, sys}]
                                             [--repair {false, true}]
                                             [--style {csv, json, scroll}]
                                             [--timeout --to]
                                             [--token]
                                             [--yes {false, true}]

Exemplos

Uso Básico

az iot central diagnostics validate-messages --app-id {app_id}

Erros de saída conforme são detectados

az iot central diagnostics validate-messages --app-id {app_id} --style scroll

Uso básico ao filtrar no dispositivo de destino

az iot central diagnostics validate-messages --app-id {app_id} -d {device_id}

Uso básico ao filtrar dispositivos de destino com um curinga na ID

az iot central diagnostics validate-messages --app-id {app_id} -d Device*

Uso básico ao filtrar no módulo.

az iot central diagnostics validate-messages --app-id {app_id} -m {module_id}

Uso básico ao filtrar módulos de destino com um curinga na ID

az iot central diagnostics validate-messages --app-id {app_id} -m Module*

Filtre o dispositivo e especifique um grupo de consumidores do Hub de Eventos ao qual associar.

az iot central diagnostics validate-messages --app-id {app_id} -d {device_id} --cg {consumer_group_name}

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade	Valor
Valor padrão:	azureiotcentral.com

--cg --consumer-group -c

Especifique o grupo de consumidores a ser usado ao se conectar ao ponto de extremidade do hub de eventos.

Propriedade	Valor
Valor padrão:	$Default

--device-id -d

A ID do dispositivo de destino. Você pode encontrar a ID do dispositivo clicando no botão Conectar na página Detalhes do Dispositivo.

--dr --duration

Duração máxima para receber mensagens do dispositivo de destino antes de encerrar a conexão. Use 0 para infinito.

Propriedade	Valor
Valor padrão:	300

--enqueued-time --et -e

Indica o tempo que deve ser usado como ponto de partida para ler mensagens das partições. As unidades são milissegundos desde a época do unix. Se nenhuma hora for indicada "agora" será usada.

--max-messages --mm

Número máximo de mensagens a serem recebidas do dispositivo de destino antes de encerrar a conexão. Use 0 para infinito.

Propriedade	Valor
Valor padrão:	10

--minimum-severity

Severidade mínima do problema necessário para relatórios.

Propriedade	Valor
Valor padrão:	warning
Valores aceitos:	error, info, warning

--module-id -m

A ID do módulo do IoT Edge se o tipo de dispositivo for IoT Edge.

--properties --props -p

Indique as propriedades da mensagem de chave para a saída. sys = propriedades do sistema, aplicativo = propriedades do aplicativo, anno = anotações.

Propriedade	Valor
Valores aceitos:	all, anno, app, sys

--repair -r

Reinstale a dependência uamqp compatível com a versão de extensão. Padrão: false.

Propriedade	Valor
Valor padrão:	False
Valores aceitos:	false, true

--style

Indique o stylescroll de saída = entregar erros conforme eles chegam, json = resumir resultados como json, csv = resumir resultados como csv.

Propriedade	Valor
Valor padrão:	scroll
Valores aceitos:	csv, json, scroll

--timeout --to -t

Máximo de segundos para manter a conexão sem receber mensagem. Use 0 para infinito.

Propriedade	Valor
Valor padrão:	300

--token

--yes -y

Ignore as solicitações do usuário. Indica a aceitação da ação. Usado principalmente para cenários de automação. Padrão: false.

Propriedade	Valor
Valor padrão:	False
Valores aceitos:	false, true

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

Formato de saída.

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 diagnostics validate-properties

Versão Prévia

O grupo de comandos 'iot central diagnostics' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Valide as propriedades relatadas enviadas ao aplicativo IoT Central.

Executa validações em atualizações de propriedade relatadas:

Aviso - Propriedades enviadas pelo dispositivo que não são modeladas no central.
Aviso – as propriedades com o mesmo nome declarado em várias interfaces devem ter o nome da interface incluído como parte da atualização da propriedade.

az iot central diagnostics validate-properties --app-id
                                               --device-id
                                               [--central-api-uri --central-dns-suffix]
                                               [--minimum-severity {error, info, warning}]
                                               [--token]

Exemplos

Uso Básico

az iot central diagnostics validate-properties --app-id {app_id} -d {device_id}

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-id -d

A ID do dispositivo de destino. Você pode encontrar a ID do dispositivo clicando no botão Conectar na página Detalhes do Dispositivo.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade	Valor
Valor padrão:	azureiotcentral.com

--minimum-severity

Severidade mínima do problema necessário para relatórios.

Propriedade	Valor
Valor padrão:	warning
Valores aceitos:	error, info, warning

--token

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

Formato de saída.

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

Comentários

Esta página foi útil?

Compartilhar via

az iot central diagnostics

Comandos

az iot central diagnostics monitor-events

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az iot central diagnostics monitor-properties

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az iot central diagnostics registration-summary

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az iot central diagnostics validate-messages

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az iot central diagnostics validate-properties

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

Comentários