Reject Cloud Events - Reject Cloud Events

Tjänst:

Event Grid

API-versionen:

2024-06-01

Avvisa en batch med molnhändelser. Svaret innehåller uppsättningen med låstoken som har avvisats, tillsammans med andra misslyckade låstoken med motsvarande felinformation. Händelser som har avvisats kommer att vara obeställbara och kan inte längre tas emot av en konsument.

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

URI-parametrar

Namn	I	Krävs	Typ	Beskrivning
endpoint	path	True	string (uri)	Värdnamnet för namnområdet, t.ex. namespaceName1.westus-1.eventgrid.azure.net
eventSubscriptionName	path	True	string	Namn på händelseprenumeration.
topicName	path	True	string	Ämnes namn.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begäranarorgan

Namn	Krävs	Typ	Beskrivning
lockTokens	True	string[]	Matris med låstoken.

Svaren

Namn	Typ	Beskrivning
200 OK	RejectResult	Begäran har slutförts.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Ett oväntat felsvar. Headers x-ms-error-code: string

Säkerhet

OAuth2Auth

Typ: oauth2
Rinna: implicit
Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/authorize

Scope

Namn	Beskrivning
https://eventgrid.azure.net/.default

Exempel

Reject Cloud Event

Exempelförfrågan

HTTP

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

Exempelsvar

Statuskod:

200

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

Definitioner

Namn	Beskrivning
Azure.Core.Foundations.Error	Felobjektet.
Azure.Core.Foundations.ErrorResponse	Ett svar som innehåller felinformation.
Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information om felet. Enligt riktlinjerna för Azure REST API – https://aka.ms/AzureRestApiGuidelines#handling-errors.
FailedLockToken	Misslyckad LockToken-information.
RejectResult	Resultatet av avvisningsåtgärden.

Azure.Core.Foundations.Error

Objekt

Felobjektet.

Namn	Typ	Beskrivning
code	string	En av en serverdefinierad uppsättning felkoder.
details	Azure.Core.Foundations.Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

Azure.Core.Foundations.ErrorResponse

Objekt

Ett svar som innehåller felinformation.

Namn	Typ	Beskrivning
error	Azure.Core.Foundations.Error	Felobjektet.

Azure.Core.Foundations.InnerError

Objekt

Ett objekt som innehåller mer specifik information om felet. Enligt riktlinjerna för Azure REST API – https://aka.ms/AzureRestApiGuidelines#handling-errors.

Namn	Typ	Beskrivning
code	string	En av en serverdefinierad uppsättning felkoder.
innererror	Azure.Core.Foundations.InnerError	Inre fel.

FailedLockToken

Objekt

Misslyckad LockToken-information.

Namn	Typ	Beskrivning
error	Azure.Core.Foundations.Error	Felinformation om det misslyckade åtgärdsresultatet för låstoken i begäran.
lockToken	string	Låstoken för en post i begäran.

RejectResult

Objekt

Resultatet av avvisningsåtgärden.

Namn	Typ	Beskrivning
failedLockTokens	FailedLockToken[]	Matris med FailedLockToken för misslyckade molnhändelser. Varje FailedLockToken innehåller låstoken tillsammans med relaterad felinformation (nämligen felkoden och beskrivningen).
succeededLockTokens	string[]	Matris med låstoken för de avvisade molnhändelserna.