Event Routes - Add

Service:

Azure Digital Twins

API Version:

2023-10-31

Ajoute ou remplace un itinéraire d’événements. Codes d’état :

• 204 Pas de contenu
• 400 Demande incorrecte
  • EventRouteEndpointInvalid : le point de terminaison fourni n’existe pas ou n’est pas actif.
  • EventRouteFilterInvalid : le filtre d’itinéraire d’événements n’est pas valide.
  • EventRouteIdInvalid : l’ID d’itinéraire d’événement n’est pas valide.
  • LimitExceeded : le nombre maximal d’itinéraires d’événements autorisés a été atteint.

PUT https://digitaltwins-hostname/eventroutes/{id}?api-version=2023-10-31

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
id	path	True	string	ID d’un itinéraire d’événements. L’ID est unique dans les itinéraires d’événements et respecte la casse.
api-version	query	True	string	Version de l’API demandée.

En-tête de la demande

Nom	Obligatoire	Type	Description
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 complément à traceparent.

Corps de la demande

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

Réponses

Nom	Type	Description
204 No Content		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

Add an event route

Add an event route (with filter)

Add an event route

Sample Request

HTTP

PUT https://digitaltwins-hostname/eventroutes/eventroute-001?api-version=2023-10-31

{
  "endpointName": "endpoint-001",
  "filter": "true"
}

Sample Response

Status code:

204

Add an event route (with filter)

Sample Request

HTTP

PUT https://digitaltwins-hostname/eventroutes/eventroute-001?api-version=2023-10-31

{
  "endpointName": "endpoint-001",
  "filter": "type = 'Microsoft.DigitalTwins.Twin.Create'"
}

Sample Response

Status code:

204

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.
InnerError	Une description de l’erreur plus spécifique que celle fournie par l’erreur contenante.

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 par l’homme 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énements 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 des événements.

InnerError

Une description de l’erreur plus spécifique que celle fournie par l’erreur contenante.

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