Reject Cloud Events - Reject Cloud Events

Layanan:: Event Grid

Versi API:: 2024-06-01

Tolak sekumpulan Peristiwa Cloud. Respons akan mencakup kumpulan token kunci yang berhasil ditolak, bersama dengan token kunci gagal lainnya dengan informasi kesalahan yang sesuai. Peristiwa yang berhasil ditolak akan menjadi huruf mati dan tidak dapat lagi diterima oleh konsumen.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string (uri)	Nama host namespace, misalnya namespaceName1.westus-1.eventgrid.azure.net
eventSubscriptionName	path	True	string	Nama Langganan Acara.
topicName	path	True	string	Nama Topik.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
lockTokens	True	string[]	Array token kunci.

Respons

Nama

Jenis

Deskripsi

200 OK

Permintaan telah berhasil.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Respons kesalahan tak terduga.

Header

x-ms-error-code: string

Keamanan

OAuth2Auth

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
https://eventgrid.azure.net/.default

Contoh

Reject Cloud Event

Permintaan sampel

HTTP

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

Respon sampel

Kode status:: 200

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

Definisi

Nama	Deskripsi
Azure.Core.Foundations.Error	Objek kesalahan.
Azure.Core.Foundations.ErrorResponse	Respons yang berisi detail kesalahan.
Azure.Core.Foundations.InnerError	Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai pedoman Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.
FailedLockToken	Informasi LockToken gagal.
RejectResult	Hasil dari operasi Tolak.

Azure.Core.Foundations.Error

Objek

Objek kesalahan.

Nama	Jenis	Deskripsi
code	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.
details	Azure.Core.Foundations.Error[]	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
innererror	Azure.Core.Foundations.InnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Representasi kesalahan yang dapat dibaca manusia.
target	string	Target kesalahan.

Azure.Core.Foundations.ErrorResponse

Objek

Respons yang berisi detail kesalahan.

Nama	Jenis	Deskripsi
error	Azure.Core.Foundations.Error	Objek kesalahan.

Azure.Core.Foundations.InnerError

Objek

Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai pedoman Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nama	Jenis	Deskripsi
code	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.
innererror	Azure.Core.Foundations.InnerError	Kesalahan dalam.

FailedLockToken

Objek

Informasi LockToken gagal.

Nama	Jenis	Deskripsi
error	Azure.Core.Foundations.Error	Informasi kesalahan dari hasil operasi yang gagal untuk token kunci dalam permintaan.
lockToken	string	Token kunci entri dalam permintaan.

RejectResult

Objek

Hasil dari operasi Tolak.

Nama	Jenis	Deskripsi
failedLockTokens	FailedLockToken[]	Array FailedLockToken untuk peristiwa cloud yang gagal. Setiap FailedLockToken menyertakan token kunci bersama dengan informasi kesalahan terkait (yaitu, kode kesalahan dan deskripsi).
succeededLockTokens	string[]	Array token kunci untuk peristiwa cloud yang berhasil ditolak.