你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

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 参数

名称 必需 类型 说明
iotHubName
path True

string

要测试的 IotHub

resourceGroupName
path True

string

IoT 中心所属的资源组

subscriptionId
path True

string

订阅标识符。

api-version
query True

string

API 的版本。

请求正文

名称 必需 类型 说明
route True

RouteProperties

路由属性

message

RoutingMessage

路由消息

twin

RoutingTwin

路由孪生参考

响应

名称 类型 说明
200 OK

TestRouteResult

确定

Other Status Codes

ErrorDetails

DefaultErrorResponse

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
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
          }
        }
      }
    ]
  }
}

定义

名称 说明
ErrorDetails

错误详细信息。

Properties
RouteCompilationError

评估路由时出现编译错误

RouteErrorPosition

发生路由错误的位置

RouteErrorRange

路由错误范围

RouteErrorSeverity

路由错误的严重性

RouteProperties

IoT 中心用于将消息路由到终结点的路由规则的属性。

RoutingMessage

路由消息

RoutingSource

要应用路由规则的源,例如 DeviceMessages。

RoutingTwin

孪生引用输入参数。 这是一个可选参数

TestResultStatus

测试路由的结果

TestRouteInput

测试路由的输入

TestRouteResult

测试一个路由的结果

TestRouteResultDetails

测试路线的详细结果

ErrorDetails

错误详细信息。

名称 类型 说明
code

string

错误代码。

details

string

错误详细信息。

httpStatusCode

string

HTTP 状态代码。

message

string

错误消息。

Properties

名称 类型 说明
desired

object

孪生所需属性

reported

object

孪生所需属性

RouteCompilationError

评估路由时出现编译错误

名称 类型 说明
location

RouteErrorRange

发生路由错误的位置

message

string

路由错误消息

severity

RouteErrorSeverity

路由错误的严重性

RouteErrorPosition

发生路由错误的位置

名称 类型 说明
column

integer

发生路由错误的列

line

integer

发生路由错误的行

RouteErrorRange

路由错误范围

名称 类型 说明
end

RouteErrorPosition

在发生路由错误的位置结束

start

RouteErrorPosition

从发生路由错误的位置开始

RouteErrorSeverity

路由错误的严重性

名称 类型 说明
error

string

warning

string

RouteProperties

IoT 中心用于将消息路由到终结点的路由规则的属性。

名称 类型 说明
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

路由消息

名称 类型 说明
appProperties

object

应用属性

body

string

路由消息的正文

systemProperties

object

系统属性

RoutingSource

要应用路由规则的源,例如 DeviceMessages。

名称 类型 说明
DeviceConnectionStateEvents

string

DeviceJobLifecycleEvents

string

DeviceLifecycleEvents

string

DeviceMessages

string

Invalid

string

TwinChangeEvents

string

RoutingTwin

孪生引用输入参数。 这是一个可选参数

名称 类型 说明
properties

Properties

tags

object

孪生标记

TestResultStatus

测试路由的结果

名称 类型 说明
false

string

true

string

undefined

string

TestRouteInput

测试路由的输入

名称 类型 说明
message

RoutingMessage

路由消息

route

RouteProperties

路由属性

twin

RoutingTwin

路由孪生参考

TestRouteResult

测试一个路由的结果

名称 类型 说明
details

TestRouteResultDetails

测试路线的详细结果

result

TestResultStatus

测试路由的结果

TestRouteResultDetails

测试路线的详细结果

名称 类型 说明
compilationErrors

RouteCompilationError[]

路由编译错误的 JSON 序列化列表