Iot Hub Resource - Test All Routes

Referens

Service:: IoT Hub

API Version:: 2018-04-01

Testa alla vägar som konfigurerats i den här Iot Hub

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
iotHubName	path	True	string	IotHub 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	Typ	Description
message	RoutingMessage	Routningsmeddelande
routingSource	RoutingSource	Routningskälla
twin	RoutingTwin	Referens för routningstvilling

Svar

Name	Typ	Description
200 OK	TestAllRoutesResult	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_TestAllRoutes

Sample Request

HTTP

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

{
  "routingSource": "DeviceMessages",
  "message": {
    "body": "Body of message",
    "appProperties": "App Properties",
    "systemProperties": "System Properties"
  }
}

Sample Response

Status code:: 200

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

Definitioner

Name	Description
ErrorDetails	Felinformation.
MatchedRoute	Vägar som matchade
Properties
RouteProperties	Egenskaperna för en routningsregel som din IoT-hubb 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	Indataparameter för tvillingreferens. Det här är en valfri parameter
TestAllRoutesInput	Indata för testning av alla vägar
TestAllRoutesResult	Resultat av testning av alla vägar

ErrorDetails

Felinformation.

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

MatchedRoute

Vägar som matchade

Name	Typ	Description
properties	RouteProperties	Egenskaper för vägar som matchade

Properties

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

RouteProperties

Egenskaperna för en routningsregel som din IoT-hubb 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 som sant som standard. För grammatik, se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	Listan över slutpunkter som meddelanden som uppfyller villkoret dirigeras till. 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 kan 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

Indataparameter för tvillingreferens. Det här är en valfri parameter

Name	Typ	Description
properties	Properties
tags	object	Tvillingtaggar

TestAllRoutesInput

Indata för testning av alla vägar

Name	Typ	Description
message	RoutingMessage	Routningsmeddelande
routingSource	RoutingSource	Routningskälla
twin	RoutingTwin	Referens för routningstvilling

TestAllRoutesResult

Resultat av testning av alla vägar

Name	Typ	Description
routes	MatchedRoute[]	JSON-serialiserad matris med matchade vägar