az iot central diagnostics

  • Vista previa
  • Referencia

Nota:

Esta referencia forma parte de la extensión azure-iot para la CLI de Azure (versión 2.46.0 o posterior). La extensión instalará automáticamente la primera vez que ejecute un comando az iot central diagnostics . Obtenga más información sobre las extensiones.

Este grupo de comandos está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Realice diagnósticos de nivel de aplicación y dispositivo.

Comandos

Nombre Description Tipo Estado
az iot central diagnostics monitor-events

Vea los mensajes de telemetría del dispositivo enviados a la aplicación de IoT Central.

 Extensión Vista previa
az iot central diagnostics monitor-properties

Vea las propiedades deseadas y notificadas enviadas a o desde la aplicación de IoT Central.

 Extensión Vista previa
az iot central diagnostics registration-summary

Vea el resumen de registro de todos los dispositivos de una aplicación.

 Extensión Vista previa
az iot central diagnostics validate-messages

Valide los mensajes enviados a IoT Hub para una aplicación de IoT Central.

 Extensión Vista previa
az iot central diagnostics validate-properties

Valide las propiedades notificadas enviadas a la aplicación de IoT Central.

 Extensión Vista previa

az iot central diagnostics monitor-events

Vista previa

El grupo de comandos "iot central diagnostics" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Vea los mensajes de telemetría del dispositivo enviados a la aplicación de IoT Central.

Muestra los datos de telemetría enviados a la aplicación de IoT Central. De forma predeterminada, muestra todos los datos enviados por todos los dispositivos. Use el parámetro --device-id para filtrar a un 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}]

Ejemplos

Uso básico

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

Uso básico al filtrar en el dispositivo de destino

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

Uso básico al filtrar dispositivos de destino con un carácter comodín en el identificador

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

Uso básico al filtrar en el módulo.

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

Uso básico al filtrar módulos de destino con un carácter comodín en el identificador

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

Filtre el dispositivo y especifique un grupo de consumidores del centro de eventos al que se va a enlazar.

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

Recibir anotaciones de mensaje (encabezados de mensaje)

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

Recibir anotaciones de mensaje + propiedades del sistema. Nunca agote el tiempo de espera.

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

Recepción de todos los atributos de mensaje de todos los mensajes de dispositivo

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

Recepción de todos los mensajes y análisis de la carga de mensajes como JSON

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

Parámetros requeridos

--app-id -n

El identificador de aplicación de la aplicación de IoT Central que quiere administrar. Puede encontrar el identificador de aplicación en la página "Acerca de" de la aplicación en el menú de ayuda.

Parámetros opcionales

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

Sufijo DNS de IoT Central asociado a la aplicación.

Valor predeterminado: azureiotcentral.com
--cg --consumer-group -c

Especifique el grupo de consumidores que se usará al conectarse al punto de conexión del centro de eventos.

Valor predeterminado: $Default
--device-id -d

Identificador de dispositivo del dispositivo de destino. Para encontrar el identificador de dispositivo, haga clic en el botón Conectar de la página Detalles del dispositivo.

--enqueued-time --et -e

Indica la hora que se debe usar como punto de partida para leer los mensajes de las particiones. Las unidades son milisegundos desde la época unix. Si no se indica "ahora" se usa ninguna hora.

--module-id -m

Identificador del módulo ioT Edge si el tipo de dispositivo es IoT Edge.

--properties --props -p

Indique las propiedades del mensaje clave que se van a generar. sys = propiedades del sistema, app = propiedades de la aplicación, anno = anotaciones.

Valores aceptados: all, anno, app, sys
--repair -r

Vuelva a instalar la dependencia de uamqp compatible con la versión de la extensión. Valor predeterminado: false.

Valores aceptados: false, true
Valor predeterminado: False
--timeout --to -t

Máximo de segundos para mantener la conexión sin recibir el mensaje. Use 0 para infinito.

Valor predeterminado: 300
--token

Si prefiere enviar la solicitud sin autenticarse en la CLI de Azure, puede especificar un token de usuario válido para autenticar la solicitud. Debe especificar el tipo de clave como parte de la solicitud. Obtenga más información en https://aka.ms/iotcentraldocsapi.

--yes -y

Omita las indicaciones del usuario. Indica la aceptación de la acción. Se usa principalmente para escenarios de automatización. Valor predeterminado: false.

Valores aceptados: false, true
Valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az iot central diagnostics monitor-properties

Vista previa

El grupo de comandos "iot central diagnostics" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Vea las propiedades deseadas y notificadas enviadas a o desde la aplicación de IoT Central.

Sondea el dispositivo gemelo desde central y lo compara con las últimas propiedades del dispositivo gemelo Analiza las propiedades del dispositivo gemelo y detecta si se realizaron cambios En el subconjunto de propiedades que se cambiaron dentro del intervalo de sondeo.

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

Ejemplos

Uso básico

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

Parámetros requeridos

--app-id -n

El identificador de aplicación de la aplicación de IoT Central que quiere administrar. Puede encontrar el identificador de aplicación en la página "Acerca de" de la aplicación en el menú de ayuda.

--device-id -d

Identificador de dispositivo del dispositivo de destino. Para encontrar el identificador de dispositivo, haga clic en el botón Conectar de la página Detalles del dispositivo.

Parámetros opcionales

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

Sufijo DNS de IoT Central asociado a la aplicación.

Valor predeterminado: azureiotcentral.com
--token

Si prefiere enviar la solicitud sin autenticarse en la CLI de Azure, puede especificar un token de usuario válido para autenticar la solicitud. Debe especificar el tipo de clave como parte de la solicitud. Obtenga más información en https://aka.ms/iotcentraldocsapi.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az iot central diagnostics registration-summary

Vista previa

El grupo de comandos "iot central diagnostics" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Vea el resumen de registro de todos los dispositivos de una aplicación.

Nota: Este comando puede tardar mucho tiempo en devolverse si la aplicación contiene una gran cantidad de dispositivos.

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

Ejemplos

Resumen del registro

az iot central diagnostics registration-summary --app-id {appid}

Parámetros requeridos

--app-id -n

El identificador de aplicación de la aplicación de IoT Central que quiere administrar. Puede encontrar el identificador de aplicación en la página "Acerca de" de la aplicación en el menú de ayuda.

Parámetros opcionales

--api-version --av
Obsoleto

El argumento "api_version" está en desuso y se quitará en una versión futura.

Este parámetro de comando está en desuso y se omitirá. En la versión futura, solo se admitirán las API de IoT Central desde la versión más reciente de disponibilidad general. Si alguna API aún no está disponible, llamaremos a la versión preliminar más reciente.

Valores aceptados: 2022-06-30-preview, 2022-07-31
Valor predeterminado: 2022-07-31
--central-api-uri --central-dns-suffix

Sufijo DNS de IoT Central asociado a la aplicación.

Valor predeterminado: azureiotcentral.com
--token

Si prefiere enviar la solicitud sin autenticarse en la CLI de Azure, puede especificar un token de usuario válido para autenticar la solicitud. Debe especificar el tipo de clave como parte de la solicitud. Obtenga más información en https://aka.ms/iotcentraldocsapi.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az iot central diagnostics validate-messages

Vista previa

El grupo de comandos "iot central diagnostics" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Valide los mensajes enviados a IoT Hub para una aplicación de IoT Central.

Realiza validaciones en los mensajes de telemetría e informa de los datos que no están modelados en la plantilla de dispositivo o los datos en los que el tipo de datos no coincide con lo que se define en la plantilla 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}]

Ejemplos

Uso básico

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

Errores de salida a medida que se detectan

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

Uso básico al filtrar en el dispositivo de destino

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

Uso básico al filtrar dispositivos de destino con un carácter comodín en el identificador

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

Uso básico al filtrar en el módulo.

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

Uso básico al filtrar módulos de destino con un carácter comodín en el identificador

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

Filtre el dispositivo y especifique un grupo de consumidores del centro de eventos al que se va a enlazar.

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

Parámetros requeridos

--app-id -n

El identificador de aplicación de la aplicación de IoT Central que quiere administrar. Puede encontrar el identificador de aplicación en la página "Acerca de" de la aplicación en el menú de ayuda.

Parámetros opcionales

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

Sufijo DNS de IoT Central asociado a la aplicación.

Valor predeterminado: azureiotcentral.com
--cg --consumer-group -c

Especifique el grupo de consumidores que se usará al conectarse al punto de conexión del centro de eventos.

Valor predeterminado: $Default
--device-id -d

Identificador de dispositivo del dispositivo de destino. Para encontrar el identificador de dispositivo, haga clic en el botón Conectar de la página Detalles del dispositivo.

--dr --duration

Duración máxima para recibir mensajes del dispositivo de destino antes de finalizar la conexión. Use 0 para infinito.

Valor predeterminado: 300
--enqueued-time --et -e

Indica la hora que se debe usar como punto de partida para leer los mensajes de las particiones. Las unidades son milisegundos desde la época unix. Si no se indica "ahora" se usa ninguna hora.

--max-messages --mm

Número máximo de mensajes que se van a recibir del dispositivo de destino antes de finalizar la conexión. Use 0 para infinito.

Valor predeterminado: 10
--minimum-severity

Gravedad mínima del problema necesaria para los informes.

Valores aceptados: error, info, warning
Valor predeterminado: warning
--module-id -m

Identificador del módulo ioT Edge si el tipo de dispositivo es IoT Edge.

--properties --props -p

Indique las propiedades del mensaje clave que se van a generar. sys = propiedades del sistema, app = propiedades de la aplicación, anno = anotaciones.

Valores aceptados: all, anno, app, sys
--repair -r

Vuelva a instalar la dependencia de uamqp compatible con la versión de la extensión. Valor predeterminado: false.

Valores aceptados: false, true
Valor predeterminado: False
--style

Indique los estilos de salidacroll = entregar errores a medida que llegan, json = resumir los resultados como json, csv = resumir los resultados como csv.

Valores aceptados: csv, json, scroll
Valor predeterminado: scroll
--timeout --to -t

Máximo de segundos para mantener la conexión sin recibir el mensaje. Use 0 para infinito.

Valor predeterminado: 300
--token

Si prefiere enviar la solicitud sin autenticarse en la CLI de Azure, puede especificar un token de usuario válido para autenticar la solicitud. Debe especificar el tipo de clave como parte de la solicitud. Obtenga más información en https://aka.ms/iotcentraldocsapi.

--yes -y

Omita las indicaciones del usuario. Indica la aceptación de la acción. Se usa principalmente para escenarios de automatización. Valor predeterminado: false.

Valores aceptados: false, true
Valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az iot central diagnostics validate-properties

Vista previa

El grupo de comandos "iot central diagnostics" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Valide las propiedades notificadas enviadas a la aplicación de IoT Central.

Realiza validaciones en actualizaciones de propiedades notificadas:

  1. Advertencia: propiedades enviadas por el dispositivo que no están modeladas en central.
  2. Advertencia: las propiedades con el mismo nombre declarados en varias interfaces deben tener el nombre de interfaz incluido como parte de la actualización de propiedades.
az iot central diagnostics validate-properties --app-id
                                               --device-id
                                               [--central-api-uri]
                                               [--minimum-severity {error, info, warning}]
                                               [--token]

Ejemplos

Uso básico

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

Parámetros requeridos

--app-id -n

El identificador de aplicación de la aplicación de IoT Central que quiere administrar. Puede encontrar el identificador de aplicación en la página "Acerca de" de la aplicación en el menú de ayuda.

--device-id -d

Identificador de dispositivo del dispositivo de destino. Para encontrar el identificador de dispositivo, haga clic en el botón Conectar de la página Detalles del dispositivo.

Parámetros opcionales

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

Sufijo DNS de IoT Central asociado a la aplicación.

Valor predeterminado: azureiotcentral.com
--minimum-severity

Gravedad mínima del problema necesaria para los informes.

Valores aceptados: error, info, warning
Valor predeterminado: warning
--token

Si prefiere enviar la solicitud sin autenticarse en la CLI de Azure, puede especificar un token de usuario válido para autenticar la solicitud. Debe especificar el tipo de clave como parte de la solicitud. Obtenga más información en https://aka.ms/iotcentraldocsapi.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.