Поделиться через


Iot Hub Resource - Test All Routes

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

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testall?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.

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

Имя Тип Описание
message

RoutingMessage

Сообщение маршрутизации

routingSource

RoutingSource

Источник маршрутизации

twin

RoutingTwin

Справочник по двойнику маршрутизации

Ответы

Имя Тип Описание
200 OK

TestAllRoutesResult

ХОРОШО

Other Status Codes

ErrorDetails

DefaultErrorResponse

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

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

IotHubResource_TestAllRoutes

Образец запроса

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

{
  "routingSource": "DeviceMessages",
  "message": {
    "body": "Body of message",
    "appProperties": {
      "key1": "value1"
    },
    "systemProperties": {
      "key1": "value1"
    }
  }
}

Пример ответа

{
  "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

Имя Тип Описание
desired

object

Требуемые свойства двойника

reported

object

Требуемые свойства двойника

RouteProperties

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

Имя Тип Описание
condition

string

Условие, которое оценивается для применения правила маршрутизации. Если условие не указано, оно по умолчанию оценивается как true. Сведения о грамматике см. в статье https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

endpointNames

string[]

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

isEnabled

boolean

Используется для указания включения маршрута.

name

string

pattern: ^[A-Za-z0-9-._]{1,64}$

Имя маршрута. Имя может включать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы, максимальную длину 64 символов и должны быть уникальными.

source

RoutingSource

Источник, к которому применяется правило маршрутизации, например DeviceMessages.

RoutingMessage

Сообщение маршрутизации

Имя Тип Описание
appProperties

object

Свойства приложения

body

string

Текст сообщения маршрутизации

systemProperties

object

Свойства системы

RoutingSource

Источник, к которому применяется правило маршрутизации, например DeviceMessages.

Значение Описание
DeviceConnectionStateEvents
DeviceJobLifecycleEvents
DeviceLifecycleEvents
DeviceMessages
Invalid
TwinChangeEvents

RoutingTwin

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

Имя Тип Описание
properties

Properties

tags

object

Теги двойников

TestAllRoutesInput

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

Имя Тип Описание
message

RoutingMessage

Сообщение маршрутизации

routingSource

RoutingSource

Источник маршрутизации

twin

RoutingTwin

Справочник по двойнику маршрутизации

TestAllRoutesResult

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

Имя Тип Описание
routes

MatchedRoute[]

Сериализованный в ФОРМАТЕ JSON массив сопоставленных маршрутов