Reject Cloud Events - Reject Cloud Events

Servizio:: Event Grid

Versione API:: 2024-06-01

Rifiutare un batch di eventi cloud. La risposta includerà il set di token di blocco rifiutati correttamente, insieme ad altri token di blocco non riusciti con le informazioni di errore corrispondenti. Gli eventi rifiutati correttamente saranno non recapitabili e non potranno più essere ricevuti da un consumer.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string (uri)	Il nome host dello spazio dei nomi, ad esempio namespaceName1.westus-1.eventgrid.azure.net
eventSubscriptionName	path	True	string	Nome sottoscrizione evento.
topicName	path	True	string	Nome argomento.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
lockTokens	True	string[]	Matrice di token di blocco.

Risposte

Nome

Tipo

Descrizione

200 OK

La richiesta ha avuto esito positivo.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Risposta di errore imprevista.

Intestazioni

x-ms-error-code: string

Sicurezza

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
https://eventgrid.azure.net/.default

Esempio

Reject Cloud Event

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 200

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

Definizioni

Nome	Descrizione
Azure.Core.Foundations.Error	Oggetto error.
Azure.Core.Foundations.ErrorResponse	Risposta contenente i dettagli dell'errore.
Azure.Core.Foundations.InnerError	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API REST di Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.
FailedLockToken	Informazioni LockToken non riuscite.
RejectResult	Risultato dell'operazione Reject.

Azure.Core.Foundations.Error

Oggetto

Oggetto error.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
details	Azure.Core.Foundations.Error[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror	Azure.Core.Foundations.InnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

Azure.Core.Foundations.ErrorResponse

Oggetto

Risposta contenente i dettagli dell'errore.

Nome	Tipo	Descrizione
error	Azure.Core.Foundations.Error	Oggetto error.

Azure.Core.Foundations.InnerError

Oggetto

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API REST di Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
innererror	Azure.Core.Foundations.InnerError	Errore interno.

FailedLockToken

Oggetto

Informazioni LockToken non riuscite.

Nome	Tipo	Descrizione
error	Azure.Core.Foundations.Error	Informazioni sull'errore del risultato dell'operazione non riuscita per il token di blocco nella richiesta.
lockToken	string	Token di blocco di una voce nella richiesta.

RejectResult

Oggetto

Risultato dell'operazione Reject.

Nome	Tipo	Descrizione
failedLockTokens	FailedLockToken[]	Matrice di FailedLockToken per gli eventi cloud non riusciti. Ogni FailedLockToken include il token di blocco insieme alle informazioni sull'errore correlate, ovvero il codice di errore e la descrizione.
succeededLockTokens	string[]	Matrice di token di blocco per gli eventi cloud rifiutati correttamente.