Iot Hub Resource - Test All Routes
Testen aller Routen, die in diesem Iot Hub konfiguriert sind
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testall?api-version=2023-06-30
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
iot
|
path | True |
string |
Zu testende IotHub |
resource
|
path | True |
string |
Ressourcengruppe, zu der Iot Hub gehört |
subscription
|
path | True |
string |
Der Abonnementbezeichner. |
api-version
|
query | True |
string |
Die Version der API. |
Anforderungstext
Name | Typ | Beschreibung |
---|---|---|
message |
Routingnachricht |
|
routingSource |
Routingquelle |
|
twin |
Routing Twin Reference |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
OKAY |
|
Other Status Codes |
DefaultErrorResponse |
Sicherheit
azure_auth
Azure Active Directory OAuth2-Fluss
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel ihres Benutzerkontos |
Beispiele
IotHubResource_TestAllRoutes
Beispielanforderung
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"
}
}
}
Beispiel für eine Antwort
{
"routes": [
{
"properties": {
"name": "Routeid",
"source": "DeviceMessages",
"endpointNames": [
"id1"
],
"isEnabled": true
}
}
]
}
Definitionen
Name | Beschreibung |
---|---|
Error |
Fehlerdetails. |
Matched |
Routen, die übereinstimmen |
Properties | |
Route |
Die Eigenschaften einer Routingregel, die Ihr IoT-Hub zum Weiterleiten von Nachrichten an Endpunkte verwendet. |
Routing |
Routingnachricht |
Routing |
Die Quelle, auf die die Routingregel angewendet werden soll, z. B. DeviceMessages. |
Routing |
Twin reference input parameter. Dies ist ein optionaler Parameter. |
Test |
Eingabe zum Testen aller Routen |
Test |
Ergebnis des Testens aller Routen |
ErrorDetails
Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Der Fehlercode. |
details |
string |
Die Fehlerdetails. |
httpStatusCode |
string |
Der HTTP-Statuscode. |
message |
string |
Die Fehlermeldung. |
MatchedRoute
Routen, die übereinstimmen
Name | Typ | Beschreibung |
---|---|---|
properties |
Eigenschaften von Routen, die übereinstimmen |
Properties
Name | Typ | Beschreibung |
---|---|---|
desired |
object |
Gewünschte Zwillingsmerkmale |
reported |
object |
Gewünschte Zwillingsmerkmale |
RouteProperties
Die Eigenschaften einer Routingregel, die Ihr IoT-Hub zum Weiterleiten von Nachrichten an Endpunkte verwendet.
Name | Typ | Beschreibung |
---|---|---|
condition |
string |
Die Bedingung, die ausgewertet wird, um die Routingregel anzuwenden. Wenn keine Bedingung angegeben wird, wird sie standardmäßig als "true" ausgewertet. Grammatik finden Sie unter: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language |
endpointNames |
string[] |
Die Liste der Endpunkte, an die Nachrichten weitergeleitet werden, die die Bedingung erfüllen. Derzeit ist nur ein Endpunkt zulässig. |
isEnabled |
boolean |
Wird verwendet, um anzugeben, ob eine Route aktiviert ist. |
name |
string pattern: ^[A-Za-z0-9-._]{1,64}$ |
Der Name der Route. Der Name kann nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche, maximal 64 Zeichen enthalten und muss eindeutig sein. |
source |
Die Quelle, auf die die Routingregel angewendet werden soll, z. B. DeviceMessages. |
RoutingMessage
Routingnachricht
Name | Typ | Beschreibung |
---|---|---|
appProperties |
object |
App-Eigenschaften |
body |
string |
Textkörper der Routingnachricht |
systemProperties |
object |
Systemeigenschaften |
RoutingSource
Die Quelle, auf die die Routingregel angewendet werden soll, z. B. DeviceMessages.
Wert | Beschreibung |
---|---|
DeviceConnectionStateEvents | |
DeviceJobLifecycleEvents | |
DeviceLifecycleEvents | |
DeviceMessages | |
Invalid | |
TwinChangeEvents |
RoutingTwin
Twin reference input parameter. Dies ist ein optionaler Parameter.
Name | Typ | Beschreibung |
---|---|---|
properties | ||
tags |
object |
Twin Tags |
TestAllRoutesInput
Eingabe zum Testen aller Routen
Name | Typ | Beschreibung |
---|---|---|
message |
Routingnachricht |
|
routingSource |
Routingquelle |
|
twin |
Routing Twin Reference |
TestAllRoutesResult
Ergebnis des Testens aller Routen
Name | Typ | Beschreibung |
---|---|---|
routes |
JSON-serialisiertes Array von übereinstimmenden Routen |