Reject Cloud Events - Reject Cloud Events

Usługa:: Event Grid

Wersja API:: 2024-06-01

Odrzuć partię zdarzeń w chmurze. Odpowiedź będzie zawierać zestaw pomyślnie odrzuconych tokenów blokady wraz z innymi tokenami blokady, które zakończyły się niepowodzeniem, wraz z odpowiadającymi im informacjami o błędzie. Pomyślnie odrzucone zdarzenia będą nieaktywne i nie będą już mogły być odbierane przez konsumenta.

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

Parametry URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string (uri)	Nazwa hosta przestrzeni nazw, np. namespaceName1.westus-1.eventgrid.azure.net
eventSubscriptionName	path	True	string	Nazwa subskrypcji wydarzenia.
topicName	path	True	string	Nazwa tematu.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Ciało żądania

Nazwa	Wymagane	Typ	Opis
lockTokens	True	string[]	Tablica tokenów blokady.

Odpowiedzi

Nazwa

Typ

Opis

200 OK

Żądanie zakończyło się pomyślnie.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Nagłówki

x-ms-error-code: string

Zabezpieczenia

OAuth2Auth

Typ: oauth2
Flow: implicit
URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresów

Nazwa	Opis
https://eventgrid.azure.net/.default

Przykłady

Reject Cloud Event

Przykładowa prośba

HTTP

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

Przykładowa odpowiedź

Kod statusu:: 200

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

Definicje

Nazwa	Opis
Azure.Core.Foundations.Error	Obiekt błędu.
Azure.Core.Foundations.ErrorResponse	Odpowiedź zawierająca szczegóły błędu.
Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu API REST platformy Azure — https://aka.ms/AzureRestApiGuidelines#handling-errors.
FailedLockToken	Informacje o nieudanym tokenie blokującym.
RejectResult	Wynik operacji Odrzuć.

Azure.Core.Foundations.Error

Sprzeciwiać się

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Azure.Core.Foundations.Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

Azure.Core.Foundations.ErrorResponse

Sprzeciwiać się

Odpowiedź zawierająca szczegóły błędu.

Nazwa	Typ	Opis
error	Azure.Core.Foundations.Error	Obiekt błędu.

Azure.Core.Foundations.InnerError

Sprzeciwiać się

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu API REST platformy Azure — https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
innererror	Azure.Core.Foundations.InnerError	Błąd wewnętrzny.

FailedLockToken

Sprzeciwiać się

Informacje o nieudanym tokenie blokującym.

Nazwa	Typ	Opis
error	Azure.Core.Foundations.Error	Informacje o błędzie wyniku operacji zakończonej niepowodzeniem dla tokenu blokady w żądaniu.
lockToken	string	Token blokady wpisu w żądaniu.

RejectResult

Sprzeciwiać się

Wynik operacji Odrzuć.

Nazwa	Typ	Opis
failedLockTokens	FailedLockToken[]	Tablica FailedLockToken dla zdarzeń w chmurze, które zakończyły się niepowodzeniem. Każdy FailedLockToken zawiera token blokady wraz z powiązanymi informacjami o błędzie (mianowicie kodem błędu i opisem).
succeededLockTokens	string[]	Tablica tokenów blokady dla pomyślnie odrzuconych zdarzeń w chmurze.