Reject Cloud Events - Reject Cloud Events

服务:

Event Grid

API 版本:

2024-06-01

拒绝一批 Cloud 事件。 响应将包括一组成功拒绝的锁令牌，以及其他失败的锁令牌及其相应的错误信息。 成功拒绝的事件将是死信，使用者无法再接收。

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

URI 参数

名称	在	必需	类型	说明
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 版本。

请求正文

名称	必需	类型	说明
lockTokens	True	string[]	锁定令牌数组。

响应

名称	类型	说明
200 OK	RejectResult	请求已成功。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	意外错误响应。 标头 x-ms-error-code: string

安全性

OAuth2Auth

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
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=="
  ]
}

定义

名称	说明
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

对象

错误对象。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
details	Azure.Core.Foundations.Error[]	导致此报告错误的特定错误的详细信息数组。
innererror	Azure.Core.Foundations.InnerError	包含与当前对象有关错误的更具体信息的对象。
message	string	错误的人工可读表示形式。
target	string	错误的目标。

Azure.Core.Foundations.ErrorResponse

对象

包含错误详细信息的响应。

名称	类型	说明
error	Azure.Core.Foundations.Error	错误对象。

Azure.Core.Foundations.InnerError

对象

包含有关错误的更具体信息的对象。 根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
innererror	Azure.Core.Foundations.InnerError	内部错误。

FailedLockToken

对象

失败的 LockToken 信息。

名称	类型	说明
error	Azure.Core.Foundations.Error	请求中锁令牌的失败作结果的错误信息。
lockToken	string	请求中条目的锁令牌。

RejectResult

对象

拒绝作的结果。

名称	类型	说明
failedLockTokens	FailedLockToken[]	失败的云事件的 FailedLockToken 数组。 每个 FailedLockToken 都包含锁令牌以及相关的错误信息（即错误代码和说明）。
succeededLockTokens	string[]	成功拒绝的云事件的锁定令牌数组。