Iot Hub Resource - Test All Routes

參考

Service:: IoT Hub

API Version:: 2018-04-01

測試在此IoT中樞內設定的所有路由

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

URI 參數

名稱	位於	必要	類型	Description
iotHubName	path	True	string	要測試的 IotHub
resourceGroupName	path	True	string	IoT 中樞所屬的資源群組
subscriptionId	path	True	string	訂用帳戶識別碼。
api-version	query	True	string	API 的版本。

要求本文

名稱	類型	Description
message	RoutingMessage	路由訊息
routingSource	RoutingSource	路由來源
twin	RoutingTwin	路由對應項參考

回應

名稱	類型	Description
200 OK	TestAllRoutesResult	確定
Other Status Codes	ErrorDetails	DefaultErrorResponse

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

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

定義

名稱	Description
ErrorDetails	錯誤詳細數據。
MatchedRoute	符合的路由
Properties
RouteProperties	IoT 中樞用來將訊息路由至端點的路由規則屬性。
RoutingMessage	路由訊息
RoutingSource	路由規則要套用到的來源，例如 DeviceMessages。
RoutingTwin	對應項參考輸入參數。這是選擇性參數
TestAllRoutesInput	用於測試所有路由的輸入
TestAllRoutesResult	測試所有路由的結果

ErrorDetails

錯誤詳細數據。

名稱	類型	Description
code	string	錯誤碼。
details	string	錯誤詳細資料。
httpStatusCode	string	HTTP 狀態碼。
message	string	錯誤訊息。

MatchedRoute

符合的路由

名稱	類型	Description
properties	RouteProperties	符合之路由的屬性

Properties

名稱	類型	Description
desiredProperties	object	對應項的所需屬性
reportedProperties	object	對應項的所需屬性

RouteProperties

IoT 中樞用來將訊息路由至端點的路由規則屬性。

名稱	類型	Description
condition	string	評估為套用路由規則的條件。如果未提供任何條件，則預設會評估為 true。如需文法，請參閱： https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	路由傳送符合條件之訊息的端點清單。目前只允許一個端點。
isEnabled	boolean	用來指定是否啟用路由。
name	string	路由的名稱。名稱只能包含英數位元、句號、底線、連字元、長度上限為64個字元，而且必須是唯一的。
source	RoutingSource	路由規則要套用到的來源，例如 DeviceMessages。

RoutingMessage

路由訊息

名稱	類型	Description
appProperties	object	應用程式屬性
body	string	路由訊息本文
systemProperties	object	系統屬性

RoutingSource

路由規則要套用到的來源，例如 DeviceMessages。

名稱	類型	Description
DeviceJobLifecycleEvents	string
DeviceLifecycleEvents	string
DeviceMessages	string
Invalid	string
TwinChangeEvents	string

RoutingTwin

對應項參考輸入參數。這是選擇性參數

名稱	類型	Description
properties	Properties
tags	object	對應項標記

TestAllRoutesInput

用於測試所有路由的輸入

名稱	類型	Description
message	RoutingMessage	路由訊息
routingSource	RoutingSource	路由來源
twin	RoutingTwin	路由對應項參考

TestAllRoutesResult

測試所有路由的結果

名稱	類型	Description
routes	MatchedRoute[]	相符路由的 JSON 串行化數位