Reject Cloud Events - Reject Cloud Events

Referenz

Dienst:: Event Grid

API-Version:: 2023-11-01

Ablehnen eines Batches von Cloudereignissen. Die Antwort enthält den Satz von erfolgreich abgelehnten Sperrtoken zusammen mit anderen fehlgeschlagenen Sperrtoken mit den entsprechenden Fehlerinformationen. Erfolgreich abgelehnte Ereignisse werden in totschreibend geschrieben und können von einem Verbraucher nicht mehr empfangen werden.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Der Hostname des Namespaces, z. B. namespaceName1.westus-1.eventgrid.azure.net
eventSubscriptionName	path	True	string	Name des Ereignisabonnements.
topicName	path	True	string	Themaname.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
lockTokens	True	string[]	Array von Sperrtoken.

Antworten

Name

Typ

Beschreibung

200 OK

Die Anforderung ist erfolgreich.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Unerwartete Fehlerantwort.

Header

x-ms-error-code: string

Sicherheit

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
https://eventgrid.azure.net/.default

Beispiele

Reject Cloud Event

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

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

Definitionen

Name	Beschreibung
Azure.Core.Foundations.Error	Das Fehlerobjekt.
Azure.Core.Foundations.ErrorResponse	Eine Antwort, die Fehlerdetails enthält.
Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
FailedLockToken	Fehler bei LockToken-Informationen.
RejectResult	Das Ergebnis des Ablehnen-Vorgangs.

Azure.Core.Foundations.Error

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
details	Azure.Core.Foundations.Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

Azure.Core.Foundations.ErrorResponse

Objekt

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Beschreibung
error	Azure.Core.Foundations.Error	Das Fehlerobjekt.

Azure.Core.Foundations.InnerError

Objekt

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
innererror	Azure.Core.Foundations.InnerError	Innerer Fehler.

FailedLockToken

Objekt

Fehler bei LockToken-Informationen.

Name	Typ	Beschreibung
error	Azure.Core.Foundations.Error	Fehlerinformationen des Fehlgeschlagenen Vorgangsergebnisses für das Sperrtoken in der Anforderung.
lockToken	string	Das Sperrtoken eines Eintrags in der Anforderung.

RejectResult

Objekt

Das Ergebnis des Ablehnen-Vorgangs.

Name	Typ	Beschreibung
failedLockTokens	FailedLockToken[]	Array von FailedLockToken für fehlgeschlagene Cloudereignisse. Jedes FailedLockToken enthält das Sperrtoken zusammen mit den zugehörigen Fehlerinformationen (nämlich dem Fehlercode und der Beschreibung).
succeededLockTokens	string[]	Array von Sperrtoken für die erfolgreich abgelehnten Cloudereignisse.