Iot Hub Resource - Test Route

Service:

IoT Hub

API Version:

2018-04-01

Testa den nya vägen för den här Iot Hub

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
iotHubName	path	True	string	IotHub som ska testas
resourceGroupName	path	True	string	resursgrupp som Iot Hub tillhör
subscriptionId	path	True	string	Prenumerationsidentifieraren.
api-version	query	True	string	Versionen av API:et.

Begärandetext

Name	Obligatorisk	Typ	Description
route	True	RouteProperties	Routningsegenskaper
message		RoutingMessage	Routningsmeddelande
twin		RoutingTwin	Referens för routningstvilling

Svar

Name	Typ	Description
200 OK	TestRouteResult	OK
Other Status Codes	ErrorDetails	DefaultErrorResponse

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

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
          }
        }
      }
    ]
  }
}

Definitioner

Name	Description
ErrorDetails	Felinformation.
Properties
RouteCompilationError	Kompileringsfel vid utvärdering av vägen
RouteErrorPosition	Position där vägfelet inträffade
RouteErrorRange	Intervall med vägfel
RouteErrorSeverity	Allvarlighetsgrad för vägfelet
RouteProperties	Egenskaperna för en routningsregel som IoT-hubben använder för att dirigera meddelanden till slutpunkter.
RoutingMessage	Routningsmeddelande
RoutingSource	Den källa som routningsregeln ska tillämpas på, till exempel DeviceMessages.
RoutingTwin	Tvillingreferensens indataparameter. Det här är en valfri parameter
TestResultStatus	Resultatet av testvägen
TestRouteInput	Indata för testväg
TestRouteResult	Resultatet av att testa en väg
TestRouteResultDetails	Detaljerat resultat av att testa en väg

ErrorDetails

Felinformation.

Name	Typ	Description
code	string	Felkoden.
details	string	Felinformationen.
httpStatusCode	string	HTTP-statuskoden.
message	string	Felmeddelandet.

Properties

Name	Typ	Description
desiredProperties	object	Önskade egenskaper för tvilling
reportedProperties	object	Önskade egenskaper för tvilling

RouteCompilationError

Kompileringsfel vid utvärdering av vägen

Name	Typ	Description
location	RouteErrorRange	Plats där vägfelet inträffade
message	string	Routningsfelmeddelande
severity	RouteErrorSeverity	Allvarlighetsgrad för vägfelet

RouteErrorPosition

Position där vägfelet inträffade

Name	Typ	Description
column	integer	Kolumn där vägfelet inträffade
line	integer	Rad där vägfelet inträffade

RouteErrorRange

Intervall med vägfel

Name	Typ	Description
end	RouteErrorPosition	Avsluta där vägfelet inträffade
start	RouteErrorPosition	Starta där vägfelet inträffade

RouteErrorSeverity

Allvarlighetsgrad för vägfelet

Name	Typ	Description
error	string
warning	string

RouteProperties

Egenskaperna för en routningsregel som IoT-hubben använder för att dirigera meddelanden till slutpunkter.

Name	Typ	Description
condition	string	Villkoret som utvärderas för att tillämpa routningsregeln. Om inget villkor anges utvärderas det till sant som standard. Grammatik finns i: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	Listan över slutpunkter till vilka meddelanden som uppfyller villkoret dirigeras. För närvarande tillåts endast en slutpunkt.
isEnabled	boolean	Används för att ange om en väg är aktiverad.
name	string	Namnet på vägen. Namnet får bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck, har en maximal längd på 64 tecken och måste vara unikt.
source	RoutingSource	Den källa som routningsregeln ska tillämpas på, till exempel DeviceMessages.

RoutingMessage

Routningsmeddelande

Name	Typ	Description
appProperties	object	Appegenskaper
body	string	Brödtext för routningsmeddelande
systemProperties	object	Systemegenskaper

RoutingSource

Den källa som routningsregeln ska tillämpas på, till exempel DeviceMessages.

Name	Typ	Description
DeviceJobLifecycleEvents	string
DeviceLifecycleEvents	string
DeviceMessages	string
Invalid	string
TwinChangeEvents	string

RoutingTwin

Tvillingreferensens indataparameter. Det här är en valfri parameter

Name	Typ	Description
properties	Properties
tags	object	Tvillingtaggar

TestResultStatus

Resultatet av testvägen

Name	Typ	Description
false	string
true	string
undefined	string

TestRouteInput

Indata för testväg

Name	Typ	Description
message	RoutingMessage	Routningsmeddelande
route	RouteProperties	Routningsegenskaper
twin	RoutingTwin	Referens för routningstvilling

TestRouteResult

Resultatet av att testa en väg

Name	Typ	Description
details	TestRouteResultDetails	Detaljerat resultat av testvägen
result	TestResultStatus	Resultatet av testvägen

TestRouteResultDetails

Detaljerat resultat av att testa en väg

Name	Typ	Description
compilationErrors	RouteCompilationError[]	JSON-serialiserad lista över vägkompileringsfel