Reject Cloud Events - Reject Cloud Events

服務:

Event Grid

API 版本:

2024-06-01

拒絕一批雲端事件。 回應將包括一組成功拒絕的鎖定權杖，以及其他失敗的鎖定權杖及其對應的錯誤資訊。 成功拒絕的事件將是無效的，消費者無法再接收。

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

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string (uri)	命名空間的主機名稱，例如 namespaceName1.westus-1.eventgrid.azure.net
eventSubscriptionName	path	True	string	事件訂閱名稱。
topicName	path	True	string	主題名稱。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

要求本文

名稱	必要	類型	Description
lockTokens	True	string[]	鎖定權杖陣列。

回應

名稱	類型	Description
200 OK	RejectResult	要求已成功。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	未預期的錯誤回應。 標題 x-ms-error-code: string

安全性

OAuth2Auth

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
https://eventgrid.azure.net/.default

範例

Reject Cloud Event

範例要求

HTTP

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

範例回覆

狀態碼:

200

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

定義

名稱	Description
Azure.Core.Foundations.Error	錯誤物件。
Azure.Core.Foundations.ErrorResponse	包含錯誤詳細數據的回應。
Azure.Core.Foundations.InnerError	物件，包含有關錯誤的更特定資訊。 根據 Azure REST API 準則 - https://aka.ms/AzureRestApiGuidelines#handling-errors。
FailedLockToken	失敗的 LockToken 資訊。
RejectResult	拒絕作業的結果。

Azure.Core.Foundations.Error

Object

錯誤物件。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
details	Azure.Core.Foundations.Error[]	導致此錯誤之特定錯誤的詳細數據陣列。
innererror	Azure.Core.Foundations.InnerError	物件，包含與目前對象有關錯誤更具體的資訊。
message	string	錯誤的人類可讀取表示法。
target	string	錯誤的目標。

Azure.Core.Foundations.ErrorResponse

Object

包含錯誤詳細數據的回應。

名稱	類型	Description
error	Azure.Core.Foundations.Error	錯誤物件。

Azure.Core.Foundations.InnerError

Object

物件，包含有關錯誤的更特定資訊。 根據 Azure REST API 準則 - https://aka.ms/AzureRestApiGuidelines#handling-errors。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
innererror	Azure.Core.Foundations.InnerError	內部錯誤。

FailedLockToken

Object

失敗的 LockToken 資訊。

名稱	類型	Description
error	Azure.Core.Foundations.Error	要求中鎖定權杖失敗作業結果的錯誤資訊。
lockToken	string	要求中項目的鎖定記號。

RejectResult

Object

拒絕作業的結果。

名稱	類型	Description
failedLockTokens	FailedLockToken[]	失敗雲端事件的 FailedLockToken 陣列。 每個 FailedLockToken 都包含鎖定權杖以及相關的錯誤資訊 （也就是錯誤碼和描述） 。
succeededLockTokens	string[]	成功拒絕的雲端事件的鎖定權杖陣列。