Event Routes - List

Service:

Azure Digital Twins

API Version:

2023-10-31

Récupère tous les itinéraires d’événements. Codes d’état :

• 200 OK

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
api-version	query	True	string	Version de l’API demandée.

En-tête de la demande

Nom	Obligatoire	Type	Description
max-items-per-page		integer	Nombre maximal d’éléments à récupérer par demande. Le serveur peut choisir de retourner une valeur inférieure au nombre demandé.
traceparent		string	Identifie la demande dans un système de suivi distribué.
tracestate		string	Fournit des informations d’identification de trace spécifiques au fournisseur et est un compagnon de traceparent.

Réponses

Nom	Type	Description
200 OK	EventRouteCollection	Succès
Other Status Codes	ErrorResponse	Réponse par défaut. Headers x-ms-error-code: string

Sécurité

oauth2

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

Exemples

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

Définitions

Nom	Description
Error	Définition de l’erreur.
ErrorResponse	Réponse d’erreur.
EventRoute	Itinéraire qui dirige les événements de notification et de télémétrie vers un point de terminaison. Les points de terminaison sont une destination en dehors d’Azure Digital Twins, par exemple un EventHub.
EventRouteCollection	Collection d’objets EventRoute.
InnerError	Description d’erreur plus spécifique que celle fournie par l’erreur contenant.

Error

Définition de l’erreur.

Nom	Type	Description
code	string	Code d’erreur spécifique au service qui sert de sous-état pour le code d’erreur HTTP.
details	Error[]	Détails de l’erreur interne.
innererror	InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible de l’erreur.

ErrorResponse

Réponse d’erreur.

Nom	Type	Description
error	Error	Détails de l’erreur.

EventRoute

Itinéraire qui dirige les événements de notification et de télémétrie vers un point de terminaison. Les points de terminaison sont une destination en dehors d’Azure Digital Twins, par exemple un EventHub.

Nom	Type	Description
endpointName	string	Nom du point de terminaison à lequel cet itinéraire d’événement est lié.
filter	string	Expression qui décrit les événements routés vers le point de terminaison.
id	string	ID de l’itinéraire de l’événement.

EventRouteCollection

Collection d’objets EventRoute.

Nom	Type	Description
nextLink	string	URI pour récupérer la page de résultats suivante.
value	EventRoute[]	Objets EventRoute.

InnerError

Description d’erreur plus spécifique que celle fournie par l’erreur contenant.

Nom	Type	Description
code	string	Un code d’erreur plus spécifique que celui fourni par l’erreur contenant.
innererror	InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.