Iot Hub Resource - Test All Routes

참조

Service:: IoT Hub

API Version:: 2018-04-01

이 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 매개 변수

Name	In(다음 안에)	필수	형식	Description
iotHubName	path	True	string	테스트할 IotHub
resourceGroupName	path	True	string	Iot Hub가 속한 리소스 그룹
subscriptionId	path	True	string	구독 식별자입니다.
api-version	query	True	string	API 버전입니다.

요청 본문

Name	형식	Description
message	RoutingMessage	라우팅 메시지
routingSource	RoutingSource	라우팅 원본
twin	RoutingTwin	라우팅 쌍 참조

응답

Name	형식	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

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

정의

Name	Description
ErrorDetails	오류 세부 정보입니다.
MatchedRoute	일치하는 경로
Properties
RouteProperties	IoT Hub가 메시지를 엔드포인트로 라우팅하는 데 사용하는 라우팅 규칙의 속성입니다.
RoutingMessage	라우팅 메시지
RoutingSource	라우팅 규칙이 적용될 원본(예: DeviceMessages)입니다.
RoutingTwin	쌍 참조 입력 매개 변수입니다. 선택적 매개 변수입니다.
TestAllRoutesInput	모든 경로를 테스트하기 위한 입력
TestAllRoutesResult	모든 경로 테스트 결과

ErrorDetails

오류 세부 정보입니다.

Name	형식	Description
code	string	오류 코드입니다.
details	string	오류 세부 정보입니다.
httpStatusCode	string	HTTP 상태 코드입니다.
message	string	오류 메시지입니다.

MatchedRoute

일치하는 경로

Name	형식	Description
properties	RouteProperties	일치하는 경로의 속성

Properties

Name	형식	Description
desiredProperties	object	Twin desired 속성
reportedProperties	object	Twin desired 속성

RouteProperties

IoT Hub가 메시지를 엔드포인트로 라우팅하는 데 사용하는 라우팅 규칙의 속성입니다.

Name	형식	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

라우팅 메시지

Name	형식	Description
appProperties	object	앱 속성
body	string	라우팅 메시지 본문
systemProperties	object	시스템 속성

RoutingSource

라우팅 규칙이 적용될 원본(예: DeviceMessages)입니다.

Name	형식	Description
DeviceJobLifecycleEvents	string
DeviceLifecycleEvents	string
DeviceMessages	string
Invalid	string
TwinChangeEvents	string

RoutingTwin

쌍 참조 입력 매개 변수입니다. 선택적 매개 변수입니다.

Name	형식	Description
properties	Properties
tags	object	쌍 태그

TestAllRoutesInput

모든 경로를 테스트하기 위한 입력

Name	형식	Description
message	RoutingMessage	라우팅 메시지
routingSource	RoutingSource	라우팅 원본
twin	RoutingTwin	라우팅 쌍 참조

TestAllRoutesResult

모든 경로 테스트 결과

Name	형식	Description
routes	MatchedRoute[]	일치하는 경로의 JSON 직렬화된 배열