Event Routes - List

Service:

Azure Digital Twins

API Version:

2023-10-31

Recupera todas las rutas de eventos. Códigos de estado:

• 200 OK

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
api-version	query	True	string	La versión de API solicitada.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
max-items-per-page		integer	Número máximo de elementos que se van a recuperar por solicitud. El servidor puede optar por devolver menos que el número solicitado.
traceparent		string	Identifica la solicitud en un sistema de seguimiento distribuido.
tracestate		string	Proporciona información de identificación de seguimiento específica del proveedor y es un compañero de seguimiento primario.

Respuestas

Nombre	Tipo	Description
200 OK	EventRouteCollection	Correcto
Other Status Codes	ErrorResponse	Respuesta predeterminada. Headers x-ms-error-code: string

Seguridad

oauth2

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

Ejemplos

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

Definiciones

Nombre	Description
Error	Definición de error.
ErrorResponse	Respuesta de error.
EventRoute	Una ruta que dirige los eventos de notificación y telemetría a un punto de conexión. Los puntos de conexión son un destino fuera de Azure Digital Twins, como eventhub.
EventRouteCollection	Colección de objetos EventRoute.
InnerError	Una descripción de error más específica de la proporcionada por el error contenedor.

Error

Definición de error.

Nombre	Tipo	Description
code	string	Código de error específico del servicio que actúa como subestado para el código de error HTTP.
details	Error[]	Detalles internos del error.
innererror	InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.

ErrorResponse

Respuesta de error.

Nombre	Tipo	Description
error	Error	Los detalles del error.

EventRoute

Una ruta que dirige los eventos de notificación y telemetría a un punto de conexión. Los puntos de conexión son un destino fuera de Azure Digital Twins, como eventhub.

Nombre	Tipo	Description
endpointName	string	El nombre del punto de conexión al que está enlazada esta ruta de eventos.
filter	string	Expresión que describe los eventos que se enrutan al punto de conexión.
id	string	Identificador de la ruta de eventos.

EventRouteCollection

Colección de objetos EventRoute.

Nombre	Tipo	Description
nextLink	string	URI para recuperar la siguiente página de resultados.
value	EventRoute[]	Objetos EventRoute.

InnerError

Una descripción de error más específica de la proporcionada por el error contenedor.

Nombre	Tipo	Description
code	string	Código de error más específico del proporcionado por el error contenedor.
innererror	InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.