Freigeben über


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
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 Typ Beschreibung
message

RoutingMessage

Weiterleiten von Nachrichten

routingSource

RoutingSource

Routingquelle

twin

RoutingTwin

Routingzwillwilligenreferenz

Antworten

Name Typ Beschreibung
200 OK

TestAllRoutesResult

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_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
ErrorDetails

Fehlerdetails.

MatchedRoute

Routen, die übereinstimmen

Properties
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.

TestAllRoutesInput

Eingabe zum Testen aller Routen

TestAllRoutesResult

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

RouteProperties

Eigenschaften von Routen, die übereinstimmen

Properties

Name Typ Beschreibung
desired

object

Gewünschte Eigenschaften von Gerätezwillingen

reported

object

Gewünschte Eigenschaften von Gerätezwillingen

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

TestAllRoutesInput

Eingabe zum Testen aller Routen

Name Typ Beschreibung
message

RoutingMessage

Weiterleiten von Nachrichten

routingSource

RoutingSource

Routingquelle

twin

RoutingTwin

Routingzwillwilligenreferenz

TestAllRoutesResult

Ergebnis des Testens aller Routen

Name Typ Beschreibung
routes

MatchedRoute[]

JSON-serialisiertes Array übereinstimmender Routen