az iot central diagnostics
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 diagnostics . Saiba mais sobre extensões.
Este grupo de comandos está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus
Execute diagnósticos no nível do aplicativo e do dispositivo.
Comandos
Name | Description | Tipo | Estado |
---|---|---|---|
az iot central diagnostics monitor-events |
Visualize mensagens de telemetria de dispositivo enviadas para o aplicativo IoT Central. |
Extensão | Pré-visualizar |
az iot central diagnostics monitor-properties |
Visualize as propriedades desejadas e relatadas enviadas de/para o aplicativo IoT Central. |
Extensão | Pré-visualizar |
az iot central diagnostics registration-summary |
Veja o resumo de registo de todos os dispositivos numa aplicação. |
Extensão | Pré-visualizar |
az iot central diagnostics validate-messages |
Valide mensagens enviadas ao Hub IoT para um aplicativo do IoT Central. |
Extensão | Pré-visualizar |
az iot central diagnostics validate-properties |
Valide as propriedades relatadas enviadas para o aplicativo IoT Central. |
Extensão | Pré-visualizar |
az iot central diagnostics monitor-events
O grupo de comando 'iot central diagnostics' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus
Visualize mensagens de telemetria de 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
Utilização básica
az iot central diagnostics monitor-events --app-id {app_id}
Uso básico ao filtrar no dispositivo alvo
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 perca tempo.
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
Receba todas as mensagens e analise a carga útil da mensagem como JSON
az iot central diagnostics monitor-events --app-id {app_id} --output json
Parâmetros Obrigatórios
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
O sufixo DNS do IoT Central associado ao seu aplicativo.
Especifique o grupo de consumidores a ser usado ao se conectar ao ponto de extremidade do hub de eventos.
O ID do dispositivo de destino. Você pode encontrar o ID do dispositivo clicando no botão Conectar na página Detalhes do dispositivo.
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.
O ID do módulo IoT Edge se o tipo de dispositivo for IoT Edge.
Indique as propriedades da mensagem-chave para a saída. sys = propriedades do sistema, app = propriedades do aplicativo, anno = anotações.
Reinstale a dependência uamqp compatível com a versão da extensão. Predefinição: false.
Máximo de segundos para manter a conexão sem receber mensagem. Use 0 para o infinito.
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.
Ignore os prompts do usuário. Indica a aceitação da ação. Usado principalmente para cenários de automação. Predefinição: false.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az iot central diagnostics monitor-properties
O grupo de comando 'iot central diagnostics' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus
Visualize as propriedades desejadas e relatadas enviadas de/para o aplicativo IoT Central.
Sonda dispositivo-gêmeo da central e o compara com o último dispositivo-gêmeo Analisa as propriedades do dispositivo-gêmeo e deteta 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
Utilização básica
az iot central diagnostics monitor-properties --app-id {app_id} -d {device_id}
Parâmetros Obrigatórios
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.
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
O sufixo DNS do IoT Central associado ao seu aplicativo.
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
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az iot central diagnostics registration-summary
O grupo de comando 'iot central diagnostics' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus
Veja o resumo de registo de todos os dispositivos numa aplicação.
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 das inscrições
az iot central diagnostics registration-summary --app-id {appid}
Parâmetros Obrigatórios
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
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.
O sufixo DNS do IoT Central associado ao seu aplicativo.
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
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az iot central diagnostics validate-messages
O grupo de comando 'iot central diagnostics' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus
Valide 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]
[--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
Utilização básica
az iot central diagnostics validate-messages --app-id {app_id}
Erros de saída à medida que são detetados
az iot central diagnostics validate-messages --app-id {app_id} --style scroll
Uso básico ao filtrar no dispositivo alvo
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 Obrigatórios
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
O sufixo DNS do IoT Central associado ao seu aplicativo.
Especifique o grupo de consumidores a ser usado ao se conectar ao ponto de extremidade do hub de eventos.
O ID do dispositivo de destino. Você pode encontrar o ID do dispositivo clicando no botão Conectar na página Detalhes do dispositivo.
Duração máxima para receber mensagens do dispositivo de destino antes de encerrar a conexão. Use 0 para o infinito.
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.
Número máximo de mensagens a receber do dispositivo de destino antes de encerrar a conexão. Use 0 para o infinito.
Gravidade mínima do problema necessária para a elaboração de relatórios.
O ID do módulo IoT Edge se o tipo de dispositivo for IoT Edge.
Indique as propriedades da mensagem-chave para a saída. sys = propriedades do sistema, app = propriedades do aplicativo, anno = anotações.
Reinstale a dependência uamqp compatível com a versão da extensão. Predefinição: false.
Indique output stylescroll = entregar erros à medida que eles chegam, json = resumir resultados como json, csv = resumir resultados como csv.
Máximo de segundos para manter a conexão sem receber mensagem. Use 0 para o infinito.
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.
Ignore os prompts do usuário. Indica a aceitação da ação. Usado principalmente para cenários de automação. Predefinição: false.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az iot central diagnostics validate-properties
O grupo de comando 'iot central diagnostics' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus
Valide as propriedades relatadas enviadas para o aplicativo IoT Central.
Executa validações em atualizações de propriedade relatadas:
- Aviso - Propriedades enviadas por dispositivo que não são modeladas na central.
- Aviso - As propriedades com o mesmo nome declaradas 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
Utilização básica
az iot central diagnostics validate-properties --app-id {app_id} -d {device_id}
Parâmetros Obrigatórios
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.
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
O sufixo DNS do IoT Central associado ao seu aplicativo.
Gravidade mínima do problema necessária para a elaboração de relatórios.
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
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.