az iot device c2d-message

  • Referencia

Nota:

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

Comandos de mensajería de nube a dispositivo.

Comandos

Nombre Description Tipo Estado
az iot device c2d-message abandon

Abandone un mensaje de nube a dispositivo.

 Extensión GA
az iot device c2d-message complete

Complete un mensaje de nube a dispositivo.

 Extensión GA
az iot device c2d-message purge

Purgar la cola de mensajes de nube a dispositivo para un dispositivo de destino.

 Extensión GA
az iot device c2d-message receive

Reciba un mensaje de nube a dispositivo.

 Extensión GA
az iot device c2d-message reject

Rechace o interbloquee un mensaje de nube a dispositivo.

 Extensión GA
az iot device c2d-message send

Envíe un mensaje de nube a dispositivo.

 Extensión GA

az iot device c2d-message abandon

Abandone un mensaje de nube a dispositivo.

az iot device c2d-message abandon --device-id
                                  [--etag]
                                  [--hub-name]
                                  [--login]
                                  [--resource-group]

Parámetros requeridos

--device-id -d

Id. de dispositivo de destino.

Parámetros opcionales

--etag -e

Etag o etiqueta de entidad correspondiente al último estado del recurso. Si no se proporciona ninguna etag, se usa el valor '*'.

--hub-name -n

Nombre o nombre de host de IoT Hub. Obligatorio si no se proporciona --login.

--login -l

Este comando admite una entidad cadena de conexión con derechos para realizar la acción. Use para evitar el inicio de sesión de sesión a través de "az login". Si se proporcionan las cadena de conexión y el nombre de una entidad, el cadena de conexión tiene prioridad. Obligatorio si no se proporciona --hub-name.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

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 device c2d-message complete

Complete un mensaje de nube a dispositivo.

az iot device c2d-message complete --device-id
                                   [--etag]
                                   [--hub-name]
                                   [--login]
                                   [--resource-group]

Parámetros requeridos

--device-id -d

Id. de dispositivo de destino.

Parámetros opcionales

--etag -e

Etag o etiqueta de entidad correspondiente al último estado del recurso. Si no se proporciona ninguna etag, se usa el valor '*'.

--hub-name -n

Nombre o nombre de host de IoT Hub. Obligatorio si no se proporciona --login.

--login -l

Este comando admite una entidad cadena de conexión con derechos para realizar la acción. Use para evitar el inicio de sesión de sesión a través de "az login". Si se proporcionan las cadena de conexión y el nombre de una entidad, el cadena de conexión tiene prioridad. Obligatorio si no se proporciona --hub-name.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

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 device c2d-message purge

Purgar la cola de mensajes de nube a dispositivo para un dispositivo de destino.

az iot device c2d-message purge --device-id
                                [--hub-name]
                                [--login]
                                [--resource-group]

Parámetros requeridos

--device-id -d

Id. de dispositivo de destino.

Parámetros opcionales

--hub-name -n

Nombre o nombre de host de IoT Hub. Obligatorio si no se proporciona --login.

--login -l

Este comando admite una entidad cadena de conexión con derechos para realizar la acción. Use para evitar el inicio de sesión de sesión a través de "az login". Si se proporcionan las cadena de conexión y el nombre de una entidad, el cadena de conexión tiene prioridad. Obligatorio si no se proporciona --hub-name.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

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 device c2d-message receive

Reciba un mensaje de nube a dispositivo.

El cuerpo del mensaje recibido solo se descodificará cuando su codificación de contenido esté establecida en "utf-8", "utf-16" o "utf-32". La carga del mensaje se mostrará como {{carga no descodable}} cuando la codificación de contenido no está establecida en una de las anteriores, o no se puede descodificar incluso cuando la codificación de contenido está establecida en una de las anteriores.

Nota: Solo se aceptará un argumento de confirmación de mensaje [--complete, --reject, --abandon].

az iot device c2d-message receive --device-id
                                  [--abandon {false, true}]
                                  [--complete {false, true}]
                                  [--hub-name]
                                  [--lock-timeout]
                                  [--login]
                                  [--reject {false, true}]
                                  [--resource-group]

Ejemplos

Uso básico

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group}

Recibir un mensaje y establecer un tiempo de espera de bloqueo de 30 segundos para ese mensaje

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group} --lt {30}

Reciba un mensaje y ack it como "completo" después de recibirlo

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group} --complete

Recibir un mensaje y rechazarlo después de recibirlo

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group} --reject

Parámetros requeridos

--device-id -d

Id. de dispositivo de destino.

Parámetros opcionales

--abandon

Abandone el mensaje de la nube al dispositivo después de la recepción.

valores aceptados: false, true
valor predeterminado: False
--complete

Complete el mensaje de nube a dispositivo después de la recepción.

valores aceptados: false, true
valor predeterminado: False
--hub-name -n

Nombre o nombre de host de IoT Hub. Obligatorio si no se proporciona --login.

--lock-timeout --lt

Especifica la cantidad de tiempo que un mensaje será invisible para otras llamadas de recepción.

valor predeterminado: 60
--login -l

Este comando admite una entidad cadena de conexión con derechos para realizar la acción. Use para evitar el inicio de sesión de sesión a través de "az login". Si se proporcionan las cadena de conexión y el nombre de una entidad, el cadena de conexión tiene prioridad. Obligatorio si no se proporciona --hub-name.

--reject

Rechazar el mensaje de nube a dispositivo después de la recepción.

valores aceptados: false, true
valor predeterminado: False
--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

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 device c2d-message reject

Rechace o interbloquee un mensaje de nube a dispositivo.

az iot device c2d-message reject --device-id
                                 [--etag]
                                 [--hub-name]
                                 [--login]
                                 [--resource-group]

Parámetros requeridos

--device-id -d

Id. de dispositivo de destino.

Parámetros opcionales

--etag -e

Etag o etiqueta de entidad correspondiente al último estado del recurso. Si no se proporciona ninguna etag, se usa el valor '*'.

--hub-name -n

Nombre o nombre de host de IoT Hub. Obligatorio si no se proporciona --login.

--login -l

Este comando admite una entidad cadena de conexión con derechos para realizar la acción. Use para evitar el inicio de sesión de sesión a través de "az login". Si se proporcionan las cadena de conexión y el nombre de una entidad, el cadena de conexión tiene prioridad. Obligatorio si no se proporciona --hub-name.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

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 device c2d-message send

Envíe un mensaje de nube a dispositivo.

Este comando se basa en y puede instalar el paquete Cython dependiente (uamqp) tras la primera ejecución. https://github.com/Azure/azure-uamqp-python

Nota: La codificación de contenido tiene como valor predeterminado utf-8. El comando enviará el cuerpo del mensaje con la acción de codificación cuando la propiedad content-encoding sea utf-8, utf-16 o utf-32. Si el valor de codificación de contenido no es uno de estos, la propiedad se seguirá enviando sin ninguna acción de codificación realizada.

Al enviar un cuerpo de mensaje binario, el contenido debe proporcionarse desde un archivo (a través --data-file-pathde ) y el tipo de contenido debe establecerse application/octet-streamen .

az iot device c2d-message send --device-id
                               [--ack {full, negative, positive}]
                               [--auth-type {key, login}]
                               [--ce]
                               [--cid]
                               [--content-type]
                               [--da]
                               [--data-file-path]
                               [--expiry]
                               [--hub-name]
                               [--login]
                               [--message-id]
                               [--properties]
                               [--repair {false, true}]
                               [--resource-group]
                               [--uid]
                               [--wait {false, true}]
                               [--yes {false, true}]

Ejemplos

Uso básico con el cuerpo del mensaje predeterminado

az iot device c2d-message send -d {device_id} -n {iothub_name}

Envíe un mensaje de nube a dispositivo con datos y propiedades personalizados.

az iot device c2d-message send -d {device_id} -n {iothub_name} --data 'Hello World' --props 'key0=value0;key1=value1'

Enviar un mensaje C2D y esperar la confirmación del dispositivo

az iot device c2d-message send -d {device_id} -n {iothub_name} --ack full --wait

Enviar un mensaje C2D en formato binario desde un archivo.

az iot device c2d-message send -d {device_id} -n {iothub_name} --data-file-path {file_path} --content-type 'application/octet-stream'

Envíe un mensaje C2D en formato JSON desde un archivo.

az iot device c2d-message send -d {device_id} -n {iothub_name} --data-file-path {file_path} --content-type 'application/json'

Parámetros requeridos

--device-id -d

Id. de dispositivo de destino.

Parámetros opcionales

--ack

Solicite la entrega de comentarios por mensaje con respecto al estado final de ese mensaje. La descripción de los valores de confirmación es la siguiente. Positivo: si el mensaje c2d alcanza el estado Completado, IoT Hub genera un mensaje de comentarios. Negativo: si el mensaje c2d alcanza el estado Mensajes fallidos, IoT Hub genera un mensaje de comentarios. Completo: IoT Hub genera un mensaje de comentarios en cualquier caso. De forma predeterminada, no se solicita ninguna confirmación.

valores aceptados: full, negative, positive
--auth-type

Indica si la operación debe derivar automáticamente una clave de directiva o usar la sesión actual de Azure AD. Si el tipo de autenticación es login y se proporciona el nombre de host del recurso, se omitirá la búsqueda de recursos a menos que sea necesario. Puede configurar el valor predeterminado mediante az configure --defaults iothub-data-auth-type=<auth-type-value>.

valores aceptados: key, login
valor predeterminado: key
--ce --content-encoding

Codificación para el cuerpo del mensaje C2D.

valor predeterminado: utf-8
--cid --correlation-id

Identificador de correlación asociado al mensaje C2D.

--content-type --ct

Tipo de contenido para el cuerpo del mensaje C2D.

--da --data

Cuerpo del mensaje. Proporcione texto o json sin formato.

valor predeterminado: Ping from Az CLI IoT Extension
--data-file-path --dfp
Vista previa

Proporcione la ruta de acceso al archivo para la carga del cuerpo del mensaje. Tenga en cuenta si la carga debe enviarse en formato binario, establezca el tipo de contenido en application/octet-stream.

--expiry --expiry-time-utc

Las unidades son milisegundos desde la época unix. Si no se indica ninguna hora, se usa el TTL de mensaje C2D de IoT Hub predeterminado.

--hub-name -n

Nombre o nombre de host de IoT Hub. Obligatorio si no se proporciona --login.

--login -l

Este comando admite una entidad cadena de conexión con derechos para realizar la acción. Use para evitar el inicio de sesión de sesión a través de "az login". Si se proporcionan las cadena de conexión y el nombre de una entidad, el cadena de conexión tiene prioridad. Obligatorio si no se proporciona --hub-name.

--message-id --mid

Identificador del mensaje C2D. Si no se proporciona ningún identificador de mensaje, se generará un UUID.

--properties --props -p

Contenedor de propiedades de mensaje en pares clave-valor con el formato siguiente: a=b; c=d.

--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
--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--uid --user-id

El mensaje C2D, propiedad id. de usuario.

--wait -w

Si establece la operación de envío c2d se bloqueará hasta que se hayan recibido comentarios del dispositivo.

valores aceptados: false, true
valor predeterminado: False
--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.