Iot Hub Resource - Test All Routes

Prueba de todas las rutas configuradas en este centro de IoT

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testall?api-version=2026-11-01

Parámetros de identificador URI

Nombre En Requerido Tipo Description
iotHubName
path True

string

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Nombre del grupo de recursos. El nombre no distingue entre mayúsculas y minúsculas.

subscriptionId
path True

string (uuid)

Identificador de la suscripción de destino. El valor debe ser un UUID.

api-version
query True

string

minLength: 1

Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre Tipo Description
message

RoutingMessage

Mensaje de enrutamiento

routingSource

RoutingSource

Origen de enrutamiento

twin

RoutingTwin

Referencia de gemelos de enrutamiento

Respuestas

Nombre Tipo Description
200 OK

TestAllRoutesResult

La operación de Azure se completó correctamente.

Other Status Codes

ErrorDetails

Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantar su cuenta de usuario

Ejemplos

IotHubResource_TestAllRoutes

Solicitud de ejemplo

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/routing/routes/$testall?api-version=2026-11-01

{
  "message": {
    "appProperties": {
      "key1": "value1"
    },
    "body": "Body of message",
    "systemProperties": {
      "key1": "value1"
    }
  },
  "routingSource": "DeviceMessages"
}

Respuesta de muestra

{
  "routes": [
    {
      "properties": {
        "name": "Routeid",
        "endpointNames": [
          "id1"
        ],
        "isEnabled": true,
        "source": "DeviceMessages"
      }
    }
  ]
}

Definiciones

Nombre Description
ErrorDetails

Detalles del error.

MatchedRoute

Rutas que coincidían

RouteProperties

Las propiedades de una regla de enrutamiento que el centro de IoT usa para enrutar mensajes a los puntos de conexión.

RoutingMessage

Mensaje de enrutamiento

RoutingSource

Origen al que se va a aplicar la regla de enrutamiento, como DeviceMessages.

RoutingTwin

Parámetro de entrada de referencia de gemelos. Este es un parámetro opcional

RoutingTwinProperties
TestAllRoutesInput

Entrada para probar todas las rutas

TestAllRoutesResult

Resultado de probar todas las rutas

ErrorDetails

Detalles del error.

Nombre Tipo Description
code

string

Código de error.

details

string

Detalles del error.

httpStatusCode

string

El código de estado HTTP.

message

string

El mensaje de error.

MatchedRoute

Rutas que coincidían

Nombre Tipo Description
properties

RouteProperties

Propiedades de las rutas que coinciden

RouteProperties

Las propiedades de una regla de enrutamiento que el centro de IoT usa para enrutar mensajes a los puntos de conexión.

Nombre Tipo Description
condition

string

Condición que se evalúa para aplicar la regla de enrutamiento. Si no se proporciona ninguna condición, se evalúa como true de forma predeterminada. Para la gramática, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

endpointNames

string[]

Lista de puntos de conexión a los que se enrutan los mensajes que cumplen la condición. Actualmente solo se permite un punto de conexión.

isEnabled

boolean

Se usa para especificar si una ruta está habilitada.

name

string

pattern: ^[A-Za-z0-9-._]{1,64}$

Nombre de la ruta. El nombre solo puede incluir caracteres alfanuméricos, puntos, caracteres de subrayado, guiones, tiene una longitud máxima de 64 caracteres y debe ser único.

source

RoutingSource

Origen al que se va a aplicar la regla de enrutamiento, como DeviceMessages.

RoutingMessage

Mensaje de enrutamiento

Nombre Tipo Description
appProperties

object

Propiedades de la aplicación

body

string

Cuerpo del mensaje de enrutamiento

systemProperties

object

Propiedades del sistema

RoutingSource

Origen al que se va a aplicar la regla de enrutamiento, como DeviceMessages.

Valor Description
Invalid

No válido

DeviceMessages

Mensajes de dispositivo

TwinChangeEvents

TwinChangeEvents

DeviceLifecycleEvents

EventosDelCicloDeVidaDelDispositivo

DeviceJobLifecycleEvents

DeviceJobLifecycleEvents

DeviceConnectionStateEvents

DeviceConnectionStateEvents

RoutingTwin

Parámetro de entrada de referencia de gemelos. Este es un parámetro opcional

Nombre Tipo Description
properties

RoutingTwinProperties

tags

Etiquetas gemelas

RoutingTwinProperties

Nombre Tipo Description
desired

Propiedades deseadas gemelas

reported

Propiedades reportadas por gemelos

TestAllRoutesInput

Entrada para probar todas las rutas

Nombre Tipo Description
message

RoutingMessage

Mensaje de enrutamiento

routingSource

RoutingSource

Origen de enrutamiento

twin

RoutingTwin

Referencia de gemelos de enrutamiento

TestAllRoutesResult

Resultado de probar todas las rutas

Nombre Tipo Description
routes

MatchedRoute[]

Matriz serializada JSON de rutas coincidentes