Iot Hub Resource - Test All Routes

Ссылка

Service:: IoT Hub

API Version:: 2018-04-01

Тестирование всех маршрутов, настроенных в этом Центре Интернета вещей

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
iotHubName	path	True	string	IotHub для тестирования
resourceGroupName	path	True	string	группа ресурсов, к которой принадлежит Центр Интернета вещей
subscriptionId	path	True	string	Идентификатор подписки.
api-version	query	True	string	Версия API.

Текст запроса

Имя	Тип	Описание
message	RoutingMessage	Сообщение маршрутизации
routingSource	RoutingSource	Источник маршрутизации
twin	RoutingTwin	Справочник по двойнику маршрутизации

Ответы

Имя	Тип	Описание
200 OK	TestAllRoutesResult	ОК
Other Status Codes	ErrorDetails	DefaultErrorResponse

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

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

Scopes

Имя	Описание
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
      }
    }
  ]
}

Определения

Имя	Описание
ErrorDetails	Сведения об ошибке.
MatchedRoute	Совпадающие маршруты
Properties
RouteProperties	Свойства правила маршрутизации, которое центр Интернета вещей использует для маршрутизации сообщений в конечные точки.
RoutingMessage	Сообщение маршрутизации
RoutingSource	Источник, к которому будет применяться правило маршрутизации, например DeviceMessages.
RoutingTwin	Входной параметр ссылки на двойник. Это необязательный параметр
TestAllRoutesInput	Входные данные для тестирования всех маршрутов
TestAllRoutesResult	Результат тестирования всех маршрутов

ErrorDetails

Сведения об ошибке.

Имя	Тип	Описание
code	string	Код ошибки.
details	string	Сведения об ошибке.
httpStatusCode	string	Код состояния HTTP.
message	string	Сообщение об ошибке.

MatchedRoute

Совпадающие маршруты

Имя	Тип	Описание
properties	RouteProperties	Свойства соответствующих маршрутов

Properties

Имя	Тип	Описание
desiredProperties	object	Требуемые свойства двойников
reportedProperties	object	Требуемые свойства двойников

RouteProperties

Свойства правила маршрутизации, которое центр Интернета вещей использует для маршрутизации сообщений в конечные точки.

Имя	Тип	Описание
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.

Имя	Тип	Описание
DeviceJobLifecycleEvents	string
DeviceLifecycleEvents	string
DeviceMessages	string
Invalid	string
TwinChangeEvents	string

RoutingTwin

Входной параметр ссылки на двойник. Это необязательный параметр

Имя	Тип	Описание
properties	Properties
tags	object	Теги двойника

TestAllRoutesInput

Входные данные для тестирования всех маршрутов

Имя	Тип	Описание
message	RoutingMessage	Сообщение маршрутизации
routingSource	RoutingSource	Источник маршрутизации
twin	RoutingTwin	Справочник по двойнику маршрутизации

TestAllRoutesResult

Результат тестирования всех маршрутов

Имя	Тип	Описание
routes	MatchedRoute[]	Сериализованный json массив сопоставленных маршрутов