az iot hub route

  • Obsoleto
  • Referencia

Este grupo de comandos ha quedado en desuso y se quitará en una versión futura. En su lugar, use el grupo de comandos "IoT Extension (azure-iot) message-route (az iot hub message-route)".

Administre rutas de una instancia de IoT Hub.

Comandos

Nombre Description Tipo Estado
az iot hub route create

Cree una ruta en IoT Hub.

 Principal Obsoleto
az iot hub route delete

Elimine todas las rutas o mencionadas para IoT Hub.

 Principal Obsoleto
az iot hub route list

Obtenga todas las rutas de IoT Hub.

 Principal Obsoleto
az iot hub route show

Obtenga información sobre la ruta en IoT Hub.

 Principal Obsoleto
az iot hub route test

Pruebe todas las rutas o la ruta mencionada en IoT Hub.

 Principal Obsoleto
az iot hub route update

Actualice una ruta en IoT Hub.

 Principal Obsoleto

az iot hub route create

Editar
Obsoleto

Este comando está en desuso implícitamente porque el grupo de comandos "ruta iot hub" está en desuso y se quitará en una versión futura. En su lugar, use el grupo de comandos "IoT Extension (azure-iot) message-route (az iot hub message-route)".

Cree una ruta en IoT Hub.

Cree una ruta para enviar un origen de datos y una condición específicos a un punto de conexión deseado.

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

Ejemplos

Cree una nueva ruta "R1".

az iot hub route create -g MyResourceGroup --hub-name MyIotHub --endpoint-name E2 --source DeviceMessages --route-name R1

Cree una nueva ruta "R1" con todos los parámetros.

az iot hub route create -g MyResourceGroup --hub-name MyIotHub --endpoint-name E2 --source DeviceMessages --route-name R1 --condition true --enabled true

Parámetros requeridos

--en --endpoint --endpoint-name

Nombre del punto de conexión de enrutamiento.

--hub-name

Nombre de IoT Hub.

--name --route-name -n

Nombre de la ruta.

--source --source-type --type -s

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.

--enabled -e

Valor booleano que indica si se va a habilitar la ruta al centro de IoT.

Valores aceptados: false, 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 route delete

Editar
Obsoleto

Este comando está en desuso implícitamente porque el grupo de comandos "ruta iot hub" está en desuso y se quitará en una versión futura. En su lugar, use el grupo de comandos "IoT Extension (azure-iot) message-route (az iot hub message-route)".

Elimine todas las rutas o mencionadas para IoT Hub.

Elimine una ruta o todas las rutas de IoT Hub.

az iot hub route delete [--hub-name]
                        [--ids]
                        [--name]
                        [--resource-group]
                        [--source {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                        [--subscription]

Ejemplos

Elimine la ruta "R1" de "MyIotHub" IoT Hub.

az iot hub route delete -g MyResourceGroup --hub-name MyIotHub --route-name R1

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

az iot hub route delete -g MyResourceGroup --hub-name MyIotHub --source DeviceMessages

Elimine todas las rutas de IoT Hub "MyIotHub".

az iot hub route delete -g MyResourceGroup --hub-name MyIotHub

Parámetros opcionales

--hub-name

Nombre de IoT Hub.

--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--name --route-name -n

Nombre de la ruta.

--resource-group -g

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

--source --source-type --type -s

Origen de la ruta.

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

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

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

Editar
Obsoleto

Este comando está en desuso implícitamente porque el grupo de comandos "ruta iot hub" está en desuso y se quitará en una versión futura. En su lugar, use el grupo de comandos "IoT Extension (azure-iot) message-route (az iot hub message-route)".

Obtenga todas las rutas de IoT Hub.

Obtenga información sobre todas las rutas de una instancia de IoT Hub.

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

Ejemplos

Obtenga toda la ruta de IoT Hub "MyIotHub".

az iot hub route list -g MyResourceGroup --hub-name MyIotHub

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

az iot hub route list -g MyResourceGroup --hub-name MyIotHub --source DeviceMessages

Parámetros opcionales

--hub-name

Nombre de IoT Hub.

--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--resource-group -g

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

--source --source-type --type -s

Origen de la ruta.

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

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

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

Editar
Obsoleto

Este comando está en desuso implícitamente porque el grupo de comandos "ruta iot hub" está en desuso y se quitará en una versión futura. En su lugar, use el grupo de comandos "IoT Extension (azure-iot) message-route (az iot hub message-route)".

Obtenga información sobre la ruta en IoT Hub.

Obtenga información sobre una ruta específica de IoT Hub.

az iot hub route show --name
                      [--hub-name]
                      [--ids]
                      [--resource-group]
                      [--subscription]

Ejemplos

Obtenga información de ruta de IoT Hub "MyIotHub".

az iot hub route show -g MyResourceGroup --hub-name MyIotHub --route-name {routeName}

Parámetros requeridos

--name --route-name -n

Nombre de la ruta.

Parámetros opcionales

--hub-name

Nombre de IoT Hub.

--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--resource-group -g

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

--subscription

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

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

Editar
Obsoleto

Este comando está en desuso implícitamente porque el grupo de comandos "ruta iot hub" está en desuso y se quitará en una versión futura. En su lugar, use el grupo de comandos "IoT Extension (azure-iot) message-route (az iot hub message-route)".

Pruebe todas las rutas o la ruta mencionada en IoT Hub.

Pruebe todas las rutas existentes o la ruta mencionada en ioT Hub. Puede proporcionar un mensaje de ejemplo para probar las rutas.

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

Ejemplos

Pruebe la ruta "R1" desde "MyIotHub" IoT Hub.

az iot hub route test -g MyResourceGroup --hub-name MyIotHub --route-name R1

Pruebe toda la ruta del tipo de origen "DeviceMessages" desde "MyIotHub" IoT Hub.

az iot hub route test -g MyResourceGroup --hub-name MyIotHub --source DeviceMessages

Parámetros opcionales

--ap --app-properties

Propiedades de la aplicación del mensaje de ruta.

--body -b

Cuerpo del mensaje de ruta.

--hub-name

Nombre de IoT Hub.

--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--name --route-name -n

Nombre de la ruta.

--resource-group -g

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

--source --source-type --type -s

Origen de la ruta.

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

Propiedades del sistema del mensaje de ruta.

--subscription

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

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

Editar
Obsoleto

Este comando está en desuso implícitamente porque el grupo de comandos "ruta iot hub" está en desuso y se quitará en una versión futura. En su lugar, use el grupo de comandos "IoT Extension (azure-iot) message-route (az iot hub message-route)".

Actualice una ruta en IoT Hub.

Novedades una ruta en IoT Hub. Puede cambiar el origen, el punto de conexión o la consulta en la ruta.

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

Ejemplos

Actualice el tipo de origen de ruta "R1" desde "MyIotHub" IoT Hub.

az iot hub route update -g MyResourceGroup --hub-name MyIotHub --source DeviceMessages --route-name R1

Parámetros requeridos

--name --route-name -n

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.

--enabled -e

Valor booleano que indica si se va a habilitar la ruta al centro de IoT.

Valores aceptados: false, true
--hub-name

Nombre de IoT Hub.

--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--resource-group -g

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

--source --source-type --type -s

Origen de la ruta.

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

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

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.