Iot Hub Resource - Test Route

Referencia

Service:: IoT Hub

API Version:: 2018-04-01

Prueba de la nueva ruta para este centro de IoT

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
iotHubName	path	True	string	IotHub que se va a probar
resourceGroupName	path	True	string	grupo de recursos al que pertenece IoT Hub
subscriptionId	path	True	string	Identificador de la suscripción.
api-version	query	True	string	La versión de la API.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
route	True	RouteProperties	Propiedades de ruta
message		RoutingMessage	Mensaje de enrutamiento
twin		RoutingTwin	Referencia de enrutamiento gemelo

Respuestas

Nombre	Tipo	Description
200 OK	TestRouteResult	Aceptar
Other Status Codes	ErrorDetails	DefaultErrorResponse

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

IotHubResource_TestRoute

Sample Request

HTTP

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

{
  "message": {
    "body": "Body of message",
    "appProperties": "App Properties",
    "systemProperties": "System Properties"
  },
  "route": {
    "name": "Routeid",
    "source": "DeviceMessages",
    "endpointNames": [
      "id1"
    ],
    "isEnabled": true
  }
}

Sample Response

Status code:: 200

{
  "result": "false",
  "details": {
    "compilationErrors": [
      {
        "message": "string response",
        "severity": "error",
        "location": {
          "start": {
            "line": 12,
            "column": 12
          },
          "end": {
            "line": 12,
            "column": 24
          }
        }
      }
    ]
  }
}

Definiciones

Nombre	Description
ErrorDetails	Detalles del error.
Properties
RouteCompilationError	Error de compilación al evaluar la ruta
RouteErrorPosition	Posición en la que se produjo el error de ruta
RouteErrorRange	Intervalo de errores de ruta
RouteErrorSeverity	Gravedad del error de ruta
RouteProperties	Las propiedades de una regla de enrutamiento que el centro de IoT usa para enrutar los mensajes a los puntos de conexión.
RoutingMessage	Mensaje de enrutamiento
RoutingSource	Origen al que se aplicará la regla de enrutamiento, como DeviceMessages.
RoutingTwin	Parámetro de entrada de referencia gemelo. Se trata de un parámetro opcional.
TestResultStatus	Resultado de la ruta de prueba
TestRouteInput	Entrada para la ruta de prueba
TestRouteResult	Resultado de la prueba de una ruta
TestRouteResultDetails	Resultado detallado de la prueba de una ruta

ErrorDetails

Detalles del error.

Nombre	Tipo	Description
code	string	Código de error.
details	string	Los detalles del error.
httpStatusCode	string	El código de estado HTTP.
message	string	El mensaje de error.

Properties

Nombre	Tipo	Description
desiredProperties	object	Propiedades deseadas de dispositivos gemelos
reportedProperties	object	Propiedades deseadas de dispositivos gemelos

RouteCompilationError

Error de compilación al evaluar la ruta

Nombre	Tipo	Description
location	RouteErrorRange	Ubicación donde se produjo el error de ruta
message	string	Mensaje de error de ruta
severity	RouteErrorSeverity	Gravedad del error de ruta

RouteErrorPosition

Posición en la que se produjo el error de ruta

Nombre	Tipo	Description
column	integer	Columna en la que se produjo el error de ruta
line	integer	Línea en la que se produjo el error de ruta

RouteErrorRange

Intervalo de errores de ruta

Nombre	Tipo	Description
end	RouteErrorPosition	Fin donde se produjo el error de ruta
start	RouteErrorPosition	Inicio en el que se produjo el error de ruta

RouteErrorSeverity

Gravedad del error de ruta

Nombre	Tipo	Description
error	string
warning	string

RouteProperties

Las propiedades de una regla de enrutamiento que el centro de IoT usa para enrutar los 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	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 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 aplicará la regla de enrutamiento, como DeviceMessages.

Nombre	Tipo	Description
DeviceJobLifecycleEvents	string
DeviceLifecycleEvents	string
DeviceMessages	string
Invalid	string
TwinChangeEvents	string

RoutingTwin

Parámetro de entrada de referencia gemelo. Se trata de un parámetro opcional.

Nombre	Tipo	Description
properties	Properties
tags	object	Etiquetas gemelas

TestResultStatus

Resultado de la ruta de prueba

Nombre	Tipo	Description
false	string
true	string
undefined	string

TestRouteInput

Entrada para la ruta de prueba

Nombre	Tipo	Description
message	RoutingMessage	Mensaje de enrutamiento
route	RouteProperties	Propiedades de ruta
twin	RoutingTwin	Referencia de enrutamiento gemelo

TestRouteResult

Resultado de la prueba de una ruta

Nombre	Tipo	Description
details	TestRouteResultDetails	Resultado detallado de la ruta de prueba
result	TestResultStatus	Resultado de la ruta de prueba

TestRouteResultDetails

Resultado detallado de la prueba de una ruta

Nombre	Tipo	Description
compilationErrors	RouteCompilationError[]	Lista serializada por JSON de errores de compilación de rutas