Event Routes - List

Service:

Azure Digital Twins

API Version:

2023-10-31

Ruft alle Ereignisrouten ab. Statuscodes:

• 200 – OK

GET https://digitaltwins-hostname/eventroutes?api-version=2023-10-31

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
api-version	query	True	string	Die angeforderte API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
max-items-per-page		integer	Die maximale Anzahl von Elementen, die pro Anforderung abgerufen werden sollen. Der Server kann sich dafür entscheiden, weniger als die angeforderte Nummer zurückzugeben.
traceparent		string	Identifiziert die Anforderung in einem verteilten Ablaufverfolgungssystem.
tracestate		string	Stellt herstellerspezifische Ablaufverfolgungsinformationen bereit und ist ein Begleiter für traceparent.

Antworten

Name	Typ	Beschreibung
200 OK	EventRouteCollection	Erfolg
Other Status Codes	ErrorResponse	Standardantwort. Headers x-ms-error-code: string

Sicherheit

oauth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=0b07f429-9f4b-4714-9392-cc5e8e80c8b0

Beispiele

List event routes

Sample Request

HTTP

GET https://digitaltwins-hostname/eventroutes?api-version=2023-10-31

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "eventroute-001",
      "endpointName": "endpoint-001",
      "filter": "type = 'Microsoft.DigitalTwins.Twin.Create'"
    },
    {
      "id": "eventroute-002",
      "endpointName": "endpoint-002",
      "filter": "type = 'Microsoft.DigitalTwins.Twin.Create' OR type = 'microsoft.iot.telemetry'"
    }
  ],
  "nextLink": "url-to-next-page"
}

Definitionen

Name	Beschreibung
Error	Fehlerdefinition.
ErrorResponse	Fehlerantwort.
EventRoute	Eine Route, die Benachrichtigungs- und Telemetrieereignisse an einen Endpunkt leitet. Endpunkte sind ein Ziel außerhalb von Azure Digital Twins, z. B. ein EventHub.
EventRouteCollection	Eine Auflistung von EventRoute-Objekten.
InnerError	Eine spezifischere Fehlerbeschreibung als der enthaltende Fehler.

Error

Fehlerdefinition.

Name	Typ	Beschreibung
code	string	Dienstspezifischer Fehlercode, der als Unterstatus für den HTTP-Fehlercode dient.
details	Error[]	Interne Fehlerdetails.
innererror	InnerError	Ein Objekt, das spezifischere Informationen als das aktuelle Objekt über den Fehler enthält.
message	string	Eine für Menschen lesbare Darstellung des Fehlers.

ErrorResponse

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Die Fehlerdetails.

EventRoute

Eine Route, die Benachrichtigungs- und Telemetrieereignisse an einen Endpunkt leitet. Endpunkte sind ein Ziel außerhalb von Azure Digital Twins, z. B. ein EventHub.

Name	Typ	Beschreibung
endpointName	string	Der Name des Endpunkts, an den diese Ereignisroute gebunden ist.
filter	string	Ein Ausdruck, der die Ereignisse beschreibt, die an den Endpunkt weitergeleitet werden.
id	string	Die ID der Ereignisroute.

EventRouteCollection

Eine Auflistung von EventRoute-Objekten.

Name	Typ	Beschreibung
nextLink	string	Ein URI zum Abrufen der nächsten Ergebnisseite.
value	EventRoute[]	Die EventRoute-Objekte.

InnerError

Eine spezifischere Fehlerbeschreibung als der enthaltende Fehler.

Name	Typ	Beschreibung
code	string	Ein spezifischerer Fehlercode als vom enthaltenden Fehler bereitgestellt wurde.
innererror	InnerError	Ein Objekt, das spezifischere Informationen als das aktuelle Objekt über den Fehler enthält.