共用方式為


Iot Hub Resource - Test Route

測試此 IoT 中樞的新路由

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

URI 參數

名稱 位於 必要 類型 Description
iotHubName
path True

string

要測試的 IotHub

resourceGroupName
path True

string

IoT 中樞所屬的資源群組

subscriptionId
path True

string

訂用帳戶識別碼。

api-version
query True

string

API 的版本。

要求本文

名稱 必要 類型 Description
route True

RouteProperties

路由屬性

message

RoutingMessage

路由訊息

twin

RoutingTwin

路由對應項參考

回應

名稱 類型 Description
200 OK

TestRouteResult

確定

Other Status Codes

ErrorDetails

DefaultErrorResponse

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

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

範例

IotHubResource_TestRoute

範例要求

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

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

範例回覆

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

定義

名稱 Description
ErrorDetails

錯誤詳細數據。

Properties
RouteCompilationError

評估路由時發生編譯錯誤

RouteErrorPosition

發生路由錯誤的位置

RouteErrorRange

路由錯誤的範圍

RouteErrorSeverity

路由錯誤的嚴重性

RouteProperties

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

RoutingMessage

路由訊息

RoutingSource

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

RoutingTwin

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

TestResultStatus

測試路由的結果

TestRouteInput

測試路由的輸入

TestRouteResult

測試一個路由的結果

TestRouteResultDetails

測試路由的詳細結果

ErrorDetails

錯誤詳細數據。

名稱 類型 Description
code

string

錯誤碼。

details

string

錯誤詳細資料。

httpStatusCode

string

HTTP 狀態碼。

message

string

錯誤訊息。

Properties

名稱 類型 Description
desired

object

對應項的所需屬性

reported

object

對應項的所需屬性

RouteCompilationError

評估路由時發生編譯錯誤

名稱 類型 Description
location

RouteErrorRange

發生路由錯誤的位置

message

string

路由錯誤訊息

severity

RouteErrorSeverity

路由錯誤的嚴重性

RouteErrorPosition

發生路由錯誤的位置

名稱 類型 Description
column

integer

發生路由錯誤的數據行

line

integer

發生路由錯誤的行

RouteErrorRange

路由錯誤的範圍

名稱 類型 Description
end

RouteErrorPosition

結束發生路由錯誤的位置

start

RouteErrorPosition

開始發生路由錯誤的位置

RouteErrorSeverity

路由錯誤的嚴重性

名稱 類型 Description
error

string

warning

string

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
DeviceConnectionStateEvents

string

DeviceJobLifecycleEvents

string

DeviceLifecycleEvents

string

DeviceMessages

string

Invalid

string

TwinChangeEvents

string

RoutingTwin

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

名稱 類型 Description
properties

Properties

tags

object

對應項標記

TestResultStatus

測試路由的結果

名稱 類型 Description
false

string

true

string

undefined

string

TestRouteInput

測試路由的輸入

名稱 類型 Description
message

RoutingMessage

路由訊息

route

RouteProperties

路由屬性

twin

RoutingTwin

路由對應項參考

TestRouteResult

測試一個路由的結果

名稱 類型 Description
details

TestRouteResultDetails

測試路由的詳細結果

result

TestResultStatus

測試路由的結果

TestRouteResultDetails

測試路由的詳細結果

名稱 類型 Description
compilationErrors

RouteCompilationError[]

路由編譯錯誤的 JSON 串行化清單