Reject Cloud Events - Reject Cloud Events

Service:: Event Grid

Version d'API:: 2024-06-01

Rejeter un lot d’événements Cloud. La réponse inclut l’ensemble des jetons de verrouillage rejetés avec succès, ainsi que d’autres jetons de verrouillage ayant échoué avec leurs informations d’erreur correspondantes. Les événements rejetés avec succès seront insignifiants et ne pourront plus être reçus par un consommateur.

POST {endpoint}/topics/{topicName}/eventsubscriptions/{eventSubscriptionName}:reject?api-version=2024-06-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (uri)	Le nom d’hôte de l’espace de noms, par exemple namespaceName1.westus-1.eventgrid.azure.net
eventSubscriptionName	path	True	string	Nom de l’abonnement à l’événement.
topicName	path	True	string	Nom du sujet.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
lockTokens	True	string[]	Tableau de jetons de verrouillage.

Réponses

Nom

Type

Description

200 OK

La demande a réussi.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Réponse d’erreur inattendue.

En-têtes

x-ms-error-code: string

Sécurité

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
https://eventgrid.azure.net/.default

Exemples

Reject Cloud Event

Exemple de requête

HTTP

POST myNamespaceName.westus-1.eventgrid.azure.net/topics/myTopic/eventsubscriptions/myEventSubscription:reject?api-version=2024-06-01

Exemple de réponse

Code d’état:: 200

{
  "failedLockTokens": [],
  "succeededLockTokens": [
    "CgMKATESCQoHdG9rZW4tMQ=="
  ]
}

Définitions

Nom	Description
Azure.Core.Foundations.Error	Objet d’erreur.
Azure.Core.Foundations.ErrorResponse	Réponse contenant les détails de l’erreur.
Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux directives de l’API REST Azure : https://aka.ms/AzureRestApiGuidelines#handling-errors.
FailedLockToken	Échec des informations LockToken.
RejectResult	Résultat de l’opération Rejet.

Azure.Core.Foundations.Error

Objet

Objet d’erreur.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
details	Azure.Core.Foundations.Error[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	Azure.Core.Foundations.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.
target	string	Cible de l’erreur.

Azure.Core.Foundations.ErrorResponse

Objet

Réponse contenant les détails de l’erreur.

Nom	Type	Description
error	Azure.Core.Foundations.Error	Objet d’erreur.

Azure.Core.Foundations.InnerError

Objet

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux directives de l’API REST Azure : https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
innererror	Azure.Core.Foundations.InnerError	Erreur interne.

FailedLockToken

Objet

Échec des informations LockToken.

Nom	Type	Description
error	Azure.Core.Foundations.Error	Informations d’erreur du résultat de l’échec de l’opération pour le jeton de verrouillage dans la demande.
lockToken	string	Le jeton de verrouillage d’une entrée dans la requête.

RejectResult

Objet

Résultat de l’opération Rejet.

Nom	Type	Description
failedLockTokens	FailedLockToken[]	Tableau de FailedLockToken pour les événements cloud ayant échoué. Chaque FailedLockToken inclut le jeton de verrouillage ainsi que les informations d’erreur associées (à savoir, le code d’erreur et la description).
succeededLockTokens	string[]	Tableau de jetons de verrouillage pour les événements cloud rejetés avec succès.