Iot Hub Resource - Test Route

Usługa:: IoT Hub

Wersja interfejsu API:: 2026-11-01

Testowanie nowej trasy dla tej usługi IoT Hub

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

Parametry identyfikatora URI

Nazwisko	W	Wymagane	Typ	Opis
iotHubName	path	True	string
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwisko	Wymagane	Typ	Opis
route	True	RouteProperties	Właściwości trasy
message		RoutingMessage	Komunikat routingu
twin		RoutingTwin	Odwołanie do bliźniaczej reprezentacji routingu

Odpowiedzi

Nazwisko	Typ	Opis
200 OK	TestRouteResult	Operacja Azure zakończyła się pomyślnie.
Other Status Codes	ErrorDetails	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 w usłudze Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwisko	Opis
user_impersonation	podszywaj się pod konto użytkownika

Przykłady

IotHubResource_TestRoute

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:: 200

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

Definicje

Nazwisko	Opis
ErrorDetails	Szczegóły błędu.
RouteCompilationError	Błąd kompilacji podczas oceniania trasy
RouteErrorPosition	Pozycja, w której wystąpił błąd trasy
RouteErrorRange	Zakres błędów trasy
RouteErrorSeverity	Waga błędu trasy
RouteProperties	Właściwości reguły routingu używanej przez centrum IoT Hub do kierowania komunikatów do punktów końcowych.
RoutingMessage	Komunikat routingu
RoutingSource	Źródłem, do którego ma być zastosowana reguła routingu, na przykład DeviceMessages.
RoutingTwin	Parametr wejściowy odwołania do podwójnej reprezentacji. Jest to parametr opcjonalny
RoutingTwinProperties
TestResultStatus	Wynik trasy testowej
TestRouteInput	Dane wejściowe dla trasy testowej
TestRouteResult	Wynik badania jednej trasy
TestRouteResultDetails	Szczegółowy wynik testowania trasy

ErrorDetails

Objekt

Szczegóły błędu.

Nazwisko	Typ	Opis
code	string	Kod błędu.
details	string	Szczegóły błędu.
httpStatusCode	string	Kod statusu HTTP.
message	string	Komunikat o błędzie.

RouteCompilationError

Objekt

Błąd kompilacji podczas oceniania trasy

Nazwisko	Typ	Opis
location	RouteErrorRange	Lokalizacja, w której wystąpił błąd trasy
message	string	Komunikat o błędzie trasy
severity	RouteErrorSeverity	Waga błędu trasy

RouteErrorPosition

Objekt

Pozycja, w której wystąpił błąd trasy

Nazwisko	Typ	Opis
column	integer (int32)	Kolumna, w której wystąpił błąd trasy
line	integer (int32)	Linia, na której wystąpił błąd trasy

RouteErrorRange

Objekt

Zakres błędów trasy

Nazwisko	Typ	Opis
end	RouteErrorPosition	Koniec w miejscu, w którym wystąpił błąd trasy
start	RouteErrorPosition	Rozpocznij w miejscu, w którym wystąpił błąd trasy

RouteErrorSeverity

Wyliczenie

Waga błędu trasy

Wartość	Opis
error	błąd
warning	ostrzeżenie

RouteProperties

Objekt

Właściwości reguły routingu używanej przez centrum IoT Hub do kierowania komunikatów do punktów końcowych.

Nazwisko	Typ	Opis
condition	string	Warunek, który jest obliczany w celu zastosowania reguły routingu. Jeśli nie podano warunku, wartość jest domyślnie obliczana na wartość true. Aby zapoznać się z gramatyką, zobacz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	Lista punktów końcowych, do których są kierowane komunikaty spełniające warunek. Obecnie dozwolony jest tylko jeden punkt końcowy.
isEnabled	boolean	Służy do określania, czy trasa jest włączona.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Nazwa trasy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki, ma maksymalną długość 64 znaków i musi być unikatowa.
source	RoutingSource	Źródłem, do którego ma być zastosowana reguła routingu, na przykład DeviceMessages.

RoutingMessage

Objekt

Komunikat routingu

Nazwisko	Typ	Opis
appProperties	object	Właściwości aplikacji
body	string	Treść komunikatu routingu
systemProperties	object	Właściwości systemu

RoutingSource

Wyliczenie

Źródłem, do którego ma być zastosowana reguła routingu, na przykład DeviceMessages.

Wartość	Opis
Invalid	Nieprawidłowy
DeviceMessages	Komunikaty urządzenia
TwinChangeEvents	Wydarzenia TwinChangeWydarzenia
DeviceLifecycleEvents	ZdarzeniaCykluŻyciaUrządzenia
DeviceJobLifecycleEvents	DeviceJobLifecycleEvents
DeviceConnectionStateEvents	DeviceConnectionStateEvents

RoutingTwin

Objekt

Parametr wejściowy odwołania do podwójnej reprezentacji. Jest to parametr opcjonalny

Nazwisko	Typ	Opis
properties	RoutingTwinProperties
tags		Bliźniacze tagi

RoutingTwinProperties

Objekt

Nazwisko	Typ	Opis
desired		Pożądane właściwości bliźniaka
reported		Bliźniacze zgłaszane właściwości

TestResultStatus

Wyliczenie

Wynik trasy testowej

Wartość	Opis
undefined	niezdefiniowany
false	false
true	prawda

TestRouteInput

Objekt

Dane wejściowe dla trasy testowej

Nazwisko	Typ	Opis
message	RoutingMessage	Komunikat routingu
route	RouteProperties	Właściwości trasy
twin	RoutingTwin	Odwołanie do bliźniaczej reprezentacji routingu

TestRouteResult

Objekt

Wynik badania jednej trasy

Nazwisko	Typ	Opis
details	TestRouteResultDetails	Szczegółowy wynik trasy testowej
result	TestResultStatus	Wynik trasy testowej

TestRouteResultDetails

Objekt

Szczegółowy wynik testowania trasy

Nazwisko	Typ	Opis
compilationErrors	RouteCompilationError[]	Serializowana w formacie JSON lista błędów kompilacji tras