Freigeben über


Iot Hub Resource - Test Route

Testen der neuen Route für diesen Iot Hub

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
iotHubName
path True

string

Zu testende IotHub

resourceGroupName
path True

string

Ressourcengruppe, zu der Iot Hub gehört

subscriptionId
path True

string

Die Abonnement-ID.

api-version
query True

string

Die Version der API.

Anforderungstext

Name Erforderlich Typ Beschreibung
route True

RouteProperties

Routeneigenschaften

message

RoutingMessage

Weiterleiten von Nachrichten

twin

RoutingTwin

Routingzwillwilligenreferenz

Antworten

Name Typ Beschreibung
200 OK

TestRouteResult

OK

Other Status Codes

ErrorDetails

DefaultErrorResponse

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

IotHubResource_TestRoute

Beispielanforderung

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

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
ErrorDetails

Fehlerdetails.

Properties
RouteCompilationError

Kompilierungsfehler beim Auswerten der Route

RouteErrorPosition

Position, an der der Routenfehler aufgetreten ist

RouteErrorRange

Bereich von Routenfehlern

RouteErrorSeverity

Schweregrad des Routenfehlers

RouteProperties

Die Eigenschaften einer Routingregel, die Ihr IoT Hub verwendet, um Nachrichten an Endpunkte weiterzuleiten.

RoutingMessage

Weiterleiten von Nachrichten

RoutingSource

Die Quelle, auf die die Routingregel angewendet werden soll, z. B. DeviceMessages.

RoutingTwin

Eingabeparameter für Zwillingsverweis. Dies ist ein optionaler Parameter.

TestResultStatus

Ergebnis der Testroute

TestRouteInput

Eingabe zum Testen der Route

TestRouteResult

Ergebnis des Testens einer Route

TestRouteResultDetails

Detailliertes Ergebnis des Testens einer Route

ErrorDetails

Fehlerdetails.

Name Typ Beschreibung
code

string

Der Fehlercode.

details

string

Die Fehlerdetails.

httpStatusCode

string

Der HTTP-Statuscode.

message

string

Die Fehlermeldung.

Properties

Name Typ Beschreibung
desired

object

Gewünschte Eigenschaften von Gerätezwillingen

reported

object

Gewünschte Eigenschaften von Gerätezwillingen

RouteCompilationError

Kompilierungsfehler beim Auswerten der Route

Name Typ Beschreibung
location

RouteErrorRange

Speicherort, an dem der Routenfehler aufgetreten ist

message

string

Routenfehlermeldung

severity

RouteErrorSeverity

Schweregrad des Routenfehlers

RouteErrorPosition

Position, an der der Routenfehler aufgetreten ist

Name Typ Beschreibung
column

integer

Spalte, in der der Routenfehler aufgetreten ist

line

integer

Zeile, in der der Routenfehler aufgetreten ist

RouteErrorRange

Bereich von Routenfehlern

Name Typ Beschreibung
end

RouteErrorPosition

Ende des Routenfehlers

start

RouteErrorPosition

Beginnen Sie, wo der Routenfehler aufgetreten ist.

RouteErrorSeverity

Schweregrad des Routenfehlers

Name Typ Beschreibung
error

string

warning

string

RouteProperties

Die Eigenschaften einer Routingregel, die Ihr IoT Hub verwendet, um Nachrichten an Endpunkte weiterzuleiten.

Name Typ Beschreibung
condition

string

Die Bedingung, die ausgewertet wird, um die Routingregel anzuwenden. Wenn keine Bedingung angegeben wird, wird standardmäßig true ausgewertet. Informationen zur 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

Der Name der Route. Der Name darf nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche enthalten, hat eine maximale Länge von 64 Zeichen und muss eindeutig sein.

source

RoutingSource

Die Quelle, auf die die Routingregel angewendet werden soll, z. B. DeviceMessages.

RoutingMessage

Weiterleiten von Nachrichten

Name Typ Beschreibung
appProperties

object

App-Eigenschaften

body

string

Text der Routingnachricht

systemProperties

object

Systemeigenschaften

RoutingSource

Die Quelle, auf die die Routingregel angewendet werden soll, z. B. DeviceMessages.

Name Typ Beschreibung
DeviceConnectionStateEvents

string

DeviceJobLifecycleEvents

string

DeviceLifecycleEvents

string

DeviceMessages

string

Invalid

string

TwinChangeEvents

string

RoutingTwin

Eingabeparameter für Zwillingsverweis. Dies ist ein optionaler Parameter.

Name Typ Beschreibung
properties

Properties

tags

object

Zwillingstags

TestResultStatus

Ergebnis der Testroute

Name Typ Beschreibung
false

string

true

string

undefined

string

TestRouteInput

Eingabe zum Testen der Route

Name Typ Beschreibung
message

RoutingMessage

Weiterleiten von Nachrichten

route

RouteProperties

Routeneigenschaften

twin

RoutingTwin

Routingzwillwilligenreferenz

TestRouteResult

Ergebnis des Testens einer Route

Name Typ Beschreibung
details

TestRouteResultDetails

Detailliertes Ergebnis der Testroute

result

TestResultStatus

Ergebnis der Testroute

TestRouteResultDetails

Detailliertes Ergebnis des Testens einer Route

Name Typ Beschreibung
compilationErrors

RouteCompilationError[]

JSON-serialisierte Liste von Routenkompilierungsfehlern