az iot central device command

  • 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 device command. Obtenga más información sobre las extensiones.

Ejecute comandos de dispositivo.

Comandos

Nombre Description Tipo Estado
az iot central device command history

Obtenga los detalles de la solicitud de comando y la respuesta más recientes enviadas al dispositivo.

 Extensión GA
az iot central device command run

Ejecute un comando en un dispositivo y vea la respuesta asociada. No supervisa las actualizaciones de propiedades que el comando puede realizar.

 Extensión GA

az iot central device command history

Obtenga los detalles de la solicitud de comando y la respuesta más recientes enviadas al dispositivo.

Enumera la solicitud de comando y la respuesta más recientes que se enviaron al dispositivo desde IoT Central. Las actualizaciones que el dispositivo realiza en las propiedades del dispositivo como resultado de la ejecución del comando no se incluyen en la respuesta.

az iot central device command history --app-id
                                      --cn
                                      --device-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--co]
                                      [--interface-id]
                                      [--mn]
                                      [--token]

Ejemplos

Mostrar respuesta de comando

az iot central device command history --app-id {appid} --device-id {deviceid} --interface-id {interfaceid} --command-name {commandname}

Mostrar respuesta de comandos de componente

az iot central device command history --app-id {appid} --device-id {deviceid} --component-name {componentname} --command-name {commandname}

Mostrar la respuesta de comandos del componente de módulo

az iot central device command history --app-id {appid} --device-id {deviceid} --module-name {modulename} --component-name {componentname} --command-name {commandname}

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.

--cn --command-name

Nombre del comando tal y como se especifica en la plantilla de dispositivo. El nombre del comando podría ser diferente del nombre para mostrar del comando.

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

--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
--co --component-name

Nombre del componente de dispositivo.

--interface-id -i

Nombre de la interfaz o componente tal como se especifica en la plantilla de dispositivo. Para encontrarlo, vaya a Plantilla de dispositivo y vea la identidad de interfaz o componente en la funcionalidad del dispositivo correspondiente.

--mn --module-name

Nombre del módulo de dispositivo.

--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 device command run

Ejecute un comando en un dispositivo y vea la respuesta asociada. No supervisa las actualizaciones de propiedades que el comando puede realizar.

--content puede ser json insertado o ruta de acceso de archivo.

az iot central device command run --app-id
                                  --cn
                                  --content
                                  --device-id
                                  [--api-version {2022-06-30-preview, 2022-07-31}]
                                  [--central-api-uri]
                                  [--co]
                                  [--interface-id]
                                  [--mn]
                                  [--token]

Ejemplos

Ejecute el comando con carga insertada. La carga debe estar en "request" en la cadena json.

az iot central device command run --app-id {appid} --device-id {deviceid} --interface-id {interfaceid} --command-name {commandname} --content '{"request": {payload}}'

Comando de ejecución corta con la ruta de acceso de carga json.

az iot central device command run -n {appid} -d {deviceid} -i {interfaceid} --cn {commandname} -k {payload_file_path}

Ejecute el comando de componente.

az iot central device command run -n {appid} -d {deviceid} --co {componentname} --cn {commandname} -k {payload}

Ejecute el comando del componente de módulo.

az iot central device command run -n {appid} -d {deviceid} --mn {modulename} --co {componentname} --cn {commandname} -k {payload}

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.

--cn --command-name

Nombre del comando tal y como se especifica en la plantilla de dispositivo. El nombre del comando podría ser diferente del nombre para mostrar del comando.

--content -k

Configuración de solicitud. Proporcione la ruta de acceso al archivo JSON o json con cadena sin formato. [Ejemplo de ruta de acceso de archivo: ./path/to/file.json] [Ejemplo json con cadena: {'a': 'b'}].

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

--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
--co --component-name

Nombre del componente de dispositivo.

--interface-id -i

Nombre de la interfaz o componente tal como se especifica en la plantilla de dispositivo. Para encontrarlo, vaya a Plantilla de dispositivo y vea la identidad de interfaz o componente en la funcionalidad del dispositivo correspondiente.

--mn --module-name

Nombre del módulo de dispositivo.

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