Event Routes - List

Service:

Reference

API Version:

2023-10-31

Retrieves all event routes. Status codes:

• 200 OK

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

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string	The requested API version.

Request Header

Name	Required	Type	Description
max-items-per-page		integer	The maximum number of items to retrieve per request. The server may choose to return less than the requested number.
traceparent		string	Identifies the request in a distributed tracing system.
tracestate		string	Provides vendor-specific trace identification information and is a companion to traceparent.

Responses

Name	Type	Description
200 OK	EventRouteCollection	Success
Other Status Codes	ErrorResponse	Default response. Headers x-ms-error-code: string

Security

oauth2

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

Examples

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"
}

Definitions

Name	Description
Error	Error definition.
ErrorResponse	Error response.
EventRoute	A route which directs notification and telemetry events to an endpoint. Endpoints are a destination outside of Azure Digital Twins such as an EventHub.
EventRouteCollection	A collection of EventRoute objects.
InnerError	A more specific error description than was provided by the containing error.

Error

Error definition.

Name	Type	Description
code	string	Service specific error code which serves as the substatus for the HTTP error code.
details	Error[]	Internal error details.
innererror	InnerError	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.

ErrorResponse

Error response.

Name	Type	Description
error	Error	The error details.

EventRoute

A route which directs notification and telemetry events to an endpoint. Endpoints are a destination outside of Azure Digital Twins such as an EventHub.

Name	Type	Description
endpointName	string	The name of the endpoint this event route is bound to.
filter	string	An expression which describes the events which are routed to the endpoint.
id	string	The id of the event route.

EventRouteCollection

A collection of EventRoute objects.

Name	Type	Description
nextLink	string	A URI to retrieve the next page of results.
value	EventRoute[]	The EventRoute objects.

InnerError

A more specific error description than was provided by the containing error.

Name	Type	Description
code	string	A more specific error code than was provided by the containing error.
innererror	InnerError	An object containing more specific information than the current object about the error.