az iot central diagnostics

  • Versão Prévia
  • Referência

Observação

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

Este grupo de comandos está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Execute diagnósticos em nível de aplicativo e dispositivo.

Comandos

Nome Description Tipo Status
az iot central diagnostics monitor-events

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

 Extensão Versão Prévia
az iot central diagnostics monitor-properties

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

 Extensão Versão Prévia
az iot central diagnostics registration-summary

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

 Extensão Versão Prévia
az iot central diagnostics validate-messages

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

 Extensão Versão Prévia
az iot central diagnostics validate-properties

Valide as propriedades relatadas enviadas ao aplicativo IoT Central.

 Extensão Versão Prévia

az iot central diagnostics monitor-events

Versão Prévia

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

Exiba as mensagens de telemetria do dispositivo enviadas para o 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]
                                          [--cg]
                                          [--device-id]
                                          [--enqueued-time]
                                          [--module-id]
                                          [--properties {all, anno, app, sys}]
                                          [--repair {false, true}]
                                          [--timeout]
                                          [--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 no 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 no 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 se vincular.

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

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

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

Receber anotações de mensagem + propriedades do sistema. Nunca expire.

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 a carga útil das mensagens 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 o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

Parâmetros Opcionais

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

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.

valor padrão: $Default
--device-id -d

O ID do dispositivo de destino. Você pode encontrar o 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 unix. Se nenhum tempo for indicado "agora" é usado.

--module-id -m

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

--properties --props -p

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

valores aceitos: all, anno, app, sys
--repair -r

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

valores aceitos: false, true
valor padrão: False
--timeout --to -t

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

valor padrão: 300
--token

Se preferir enviar sua solicitação sem 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

Ignorar prompts do usuário. Indica aceitação da ação. Usado principalmente para cenários de automação. Padrão: falso.

valores aceitos: false, true
valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az iot central diagnostics monitor-properties

Versão Prévia

O grupo de comandos 'iot central diagnostics' está em pré-visualização 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.

Polls device-twin from central e compara-o com o último device-twin Analisa propriedades de device-twin 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]
                                              [--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 o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--device-id -d

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

Parâmetros Opcionais

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

valor padrão: azureiotcentral.com
--token

Se preferir enviar sua solicitação sem 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 o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az iot central diagnostics registration-summary

Versão Prévia

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

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

Observação: esse comando pode levar uma quantidade significativa de tempo para retornar se seu aplicativo contiver muitos dispositivos.

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

Exemplos

Resumo da inscrição

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

Esse parâmetro de comando foi preterido e será ignorado. Na versão futura, só daremos suporte às APIs do IoT Central 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 aceitos: 2022-06-30-preview, 2022-07-31
valor padrão: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

valor padrão: azureiotcentral.com
--token

Se preferir enviar sua solicitação sem 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 o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az iot central diagnostics validate-messages

Versão Prévia

O grupo de comandos 'iot central diagnostics' está em pré-visualização 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 é definido no modelo de dispositivo.

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

Exemplos

Uso básico

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

Erros de saída à medida que 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 no 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 no 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 se vincular.

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 o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

Parâmetros Opcionais

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

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.

valor padrão: $Default
--device-id -d

O ID do dispositivo de destino. Você pode encontrar o 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.

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 unix. Se nenhum tempo for indicado "agora" é usado.

--max-messages --mm

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

valor padrão: 10
--minimum-severity

Gravidade mínima do problema necessária para a notificação.

valores aceitos: error, info, warning
valor padrão: warning
--module-id -m

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

--properties --props -p

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

valores aceitos: all, anno, app, sys
--repair -r

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

valores aceitos: false, true
valor padrão: False
--style

Indique a saída stylescroll = entregue os erros à medida que eles chegam, json = resuma os resultados como json, csv = resuma os resultados como csv.

valores aceitos: csv, json, scroll
valor padrão: scroll
--timeout --to -t

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

valor padrão: 300
--token

Se preferir enviar sua solicitação sem 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

Ignorar prompts do usuário. Indica aceitação da ação. Usado principalmente para cenários de automação. Padrão: falso.

valores aceitos: false, true
valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az iot central diagnostics validate-properties

Versão Prévia

O grupo de comandos 'iot central diagnostics' está em pré-visualização 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 propriedades relatadas:

  1. Aviso - Propriedades enviadas pelo dispositivo que não são modeladas na central.
  2. 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]
                                               [--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 o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--device-id -d

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

Parâmetros Opcionais

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

valor padrão: azureiotcentral.com
--minimum-severity

Gravidade mínima do problema necessária para a notificação.

valores aceitos: error, info, warning
valor padrão: warning
--token

Se preferir enviar sua solicitação sem 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 o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.