Compartir a través de

az iot hub message-route

  • 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 hub message-route . 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

Administre rutas de una instancia de IoT Hub.

Comandos

Nombre Description Tipo Estado
az iot hub message-route create

Agregue una ruta para una instancia de IoT Hub.

 Extensión Vista previa
az iot hub message-route delete

Elimine todas las rutas o una ruta mencionada en una instancia de IoT Hub.

 Extensión Vista previa
az iot hub message-route fallback

Administre la ruta de reserva de un centro de IoT.

 Extensión Vista previa
az iot hub message-route fallback set

Habilite o deshabilite la ruta de reserva en una instancia de IoT Hub.

 Extensión Vista previa
az iot hub message-route fallback show

Mostrar la ruta de reserva de una instancia de IoT Hub.

 Extensión Vista previa
az iot hub message-route list

Obtenga todas las rutas de una instancia de IoT Hub.

 Extensión Vista previa
az iot hub message-route show

Obtenga información sobre la ruta en una instancia de IoT Hub.

 Extensión Vista previa
az iot hub message-route test

Pruebe todas las rutas o una ruta mencionada en una instancia de IoT Hub.

 Extensión Vista previa
az iot hub message-route update

Actualice una ruta para una instancia de IoT Hub.

 Extensión Vista previa

az iot hub message-route create

Vista previa

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

Agregue una ruta para una instancia de IoT Hub.

az iot hub message-route create --en
                                --hub-name
                                --rn
                                --source-type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}
                                [--condition]
                                [--enabled {false, true}]
                                [--resource-group]

Ejemplos

Cree una ruta para una instancia de IoT Hub con el punto de conexión y el tipo de origen especificados "DeviceMessages".

az iot hub message-route create -n {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source DeviceMessages

Cree una ruta para ioT Hub con el punto de conexión integrado y el tipo de origen "DeviceMessages".

az iot hub message-route create -n {iothub_name} --route-name {route_name} --endpoint-name events --source DeviceMessages

Cree una ruta deshabilitada para una instancia de IoT Hub con el punto de conexión especificado, el tipo de origen "DigitalTwinChangeEvents" y la condición personalizada.

az iot hub message-route create -n {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source DigitalTwinChangeEvents --condition {condition} --enabled false

Parámetros requeridos

--en --endpoint --endpoint-name

Nombre del punto de conexión de enrutamiento. Para el punto de conexión integrado, use el nombre del punto de conexión "events".

--hub-name -n

Nombre de IoT Hub.

--rn --route --route-name

Nombre de la ruta.

--source-type --type -t

Origen de la ruta.

Valores aceptados: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

Parámetros opcionales

--condition -c

Condición que se evalúa para aplicar la regla de enrutamiento.

Valor predeterminado: true
--enabled -e

Valor booleano que indica si se va a habilitar la ruta a IoT Hub.

Valores aceptados: false, true
Valor predeterminado: True
--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 hub message-route delete

Vista previa

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

Elimine todas las rutas o una ruta mencionada en una instancia de IoT Hub.

az iot hub message-route delete --hub-name
                                [--resource-group]
                                [--rn]
                                [--source-type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                                [--yes {false, true}]

Ejemplos

Elimine una ruta de una instancia de IoT Hub.

az iot hub message-route delete -n {iothub_name} --route-name {route_name}

Elimine todas las rutas del tipo de origen "DeviceMessages" de una instancia de IoT Hub.

az iot hub message-route delete -n {iothub_name} --source DeviceMessages

Elimine todas las rutas de una instancia de IoT Hub.

az iot hub message-route delete -n {iothub_name}

Parámetros requeridos

--hub-name -n

Nombre de IoT Hub.

Parámetros opcionales

--resource-group -g

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

--rn --route --route-name

Nombre de la ruta.

--source-type --type -t

Origen de la ruta.

Valores aceptados: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--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
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 hub message-route list

Vista previa

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

Obtenga todas las rutas de una instancia de IoT Hub.

az iot hub message-route list --hub-name
                              [--resource-group]
                              [--source-type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]

Ejemplos

Obtenga todas las rutas de una instancia de IoT Hub.

az iot hub message-route list -n {iothub_name}

Obtenga todas las rutas del tipo de origen "DeviceMessages" de una instancia de IoT Hub.

az iot hub message-route list -n {iothub_name} --source DeviceMessages

Parámetros requeridos

--hub-name -n

Nombre de IoT Hub.

Parámetros opcionales

--resource-group -g

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

--source-type --type -t

Origen de la ruta.

Valores aceptados: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
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 hub message-route show

Vista previa

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

Obtenga información sobre la ruta en una instancia de IoT Hub.

az iot hub message-route show --hub-name
                              --rn
                              [--resource-group]

Ejemplos

Obtenga información de ruta desde una instancia de IoT Hub.

az iot hub message-route show -n {iothub_name} --route-name {route_name}

Parámetros requeridos

--hub-name -n

Nombre de IoT Hub.

--rn --route --route-name

Nombre de la ruta.

Parámetros opcionales

--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 hub message-route test

Vista previa

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

Pruebe todas las rutas o una ruta mencionada en una instancia de IoT Hub.

Puede proporcionar un mensaje de ejemplo para probar las rutas.

az iot hub message-route test --hub-name
                              [--ap]
                              [--body]
                              [--resource-group]
                              [--rn]
                              [--source-type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                              [--sp]

Ejemplos

Pruebe una ruta desde una instancia de IoT Hub.

az iot hub message-route test -n {iothub_name} --route-name {route_name}

Pruebe todas las rutas del tipo de origen "DeviceMessages" desde una instancia de IoT Hub.

az iot hub message-route test -n {iothub_name} --source DeviceMessages

Pruebe toda la ruta desde una instancia de IoT Hub con un mensaje personalizado, como el cuerpo, las propiedades de la aplicación y las propiedades del sistema.

az iot hub message-route test -n {iothub_name} -b {body} --ap {app_properties} --sp {system_properties}

Parámetros requeridos

--hub-name -n

Nombre de IoT Hub.

Parámetros opcionales

--ap --app-properties

Propiedades de la aplicación del mensaje de ruta.

--body -b

Cuerpo del mensaje de ruta.

--resource-group -g

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

--rn --route --route-name

Nombre de la ruta.

--source-type --type -t

Origen de la ruta.

Valores aceptados: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--sp --system-properties

Propiedades del sistema del mensaje de ruta.

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 hub message-route update

Vista previa

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

Actualice una ruta para una instancia de IoT Hub.

Puede cambiar el estado de origen, punto de conexión, condición o habilitado en la ruta.

az iot hub message-route update --hub-name
                                --rn
                                [--condition]
                                [--en]
                                [--enabled {false, true}]
                                [--resource-group]
                                [--source-type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]

Ejemplos

Actualice una ruta a un punto de conexión determinado y el tipo de origen "DeviceMessages".

az iot hub message-route update -n {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source DeviceMessages

Deshabilite una ruta.

az iot hub message-route update -n {iothub_name} --route-name {route_name} --enabled false

Cambiar la condición de una ruta.

az iot hub message-route update -n {iothub_name} --route-name {route_name} --condition {condition}

Parámetros requeridos

--hub-name -n

Nombre de IoT Hub.

--rn --route --route-name

Nombre de la ruta.

Parámetros opcionales

--condition -c

Condición que se evalúa para aplicar la regla de enrutamiento.

--en --endpoint --endpoint-name

Nombre del punto de conexión de enrutamiento. Para el punto de conexión integrado, use el nombre del punto de conexión "events".

--enabled -e

Valor booleano que indica si se va a habilitar la ruta a IoT Hub.

Valores aceptados: false, true
--resource-group -g

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

--source-type --type -t

Origen de la ruta.

Valores aceptados: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
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.