你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

EventGridReceiverClient class

事件网格命名空间客户端

构造函数

EventGridReceiverClient(string, AzureKeyCredential | TokenCredential, string, string, EventGridReceiverClientOptions)

Azure Messaging EventGrid 客户端

方法

acknowledgeEvents(string[], AcknowledgeEventsOptions)

确认一批云事件。 如果成功确认了至少一个事件,服务器将使用 HTTP 200 状态代码进行响应。 响应正文将包含成功确认的 lockTokens 集,以及其他失败的 lockTokens 及其相应的错误信息。 成功确认的事件将不再可供任何使用者使用。

receiveEvents<T>(ReceiveEventsOptions)

从事件订阅接收一批云事件。

rejectEvents(string[], RejectEventsOptions)

拒绝一批云事件。

releaseEvents(string[], ReleaseEventsOptions)

释放一批云事件。 如果成功释放了至少一个事件,服务器将使用 HTTP 200 状态代码进行响应。 响应正文将包含成功释放 lockTokens 集,以及其他失败的 lockTokens 及其相应的错误信息。

renewEventLocks(string[], RenewEventLocksOptions)

续订一批云事件的锁。

构造函数详细信息

EventGridReceiverClient(string, AzureKeyCredential | TokenCredential, string, string, EventGridReceiverClientOptions)

Azure Messaging EventGrid 客户端

new EventGridReceiverClient(endpoint: string, credential: AzureKeyCredential | TokenCredential, topicName: string, subscriptionName: string, options?: EventGridReceiverClientOptions)

参数

endpoint

string

topicName

string

subscriptionName

string

方法详细信息

acknowledgeEvents(string[], AcknowledgeEventsOptions)

确认一批云事件。 如果成功确认了至少一个事件,服务器将使用 HTTP 200 状态代码进行响应。 响应正文将包含成功确认的 lockTokens 集,以及其他失败的 lockTokens 及其相应的错误信息。 成功确认的事件将不再可供任何使用者使用。

function acknowledgeEvents(lockTokens: string[], options?: AcknowledgeEventsOptions): Promise<AcknowledgeResult>

参数

lockTokens

string[]

锁定令牌

options
AcknowledgeEventsOptions

确认的选项

返回

receiveEvents<T>(ReceiveEventsOptions)

从事件订阅接收一批云事件。

function receiveEvents<T>(options?: ReceiveEventsOptions): Promise<ReceiveResult<T>>

参数

options
ReceiveEventsOptions

要接收的选项

返回

Promise<ReceiveResult<T>>

rejectEvents(string[], RejectEventsOptions)

拒绝一批云事件。

function rejectEvents(lockTokens: string[], options?: RejectEventsOptions): Promise<RejectResult>

参数

lockTokens

string[]

锁定令牌

options
RejectEventsOptions

拒绝的选项

返回

Promise<RejectResult>

releaseEvents(string[], ReleaseEventsOptions)

释放一批云事件。 如果成功释放了至少一个事件,服务器将使用 HTTP 200 状态代码进行响应。 响应正文将包含成功释放 lockTokens 集,以及其他失败的 lockTokens 及其相应的错误信息。

function releaseEvents(lockTokens: string[], options?: ReleaseEventsOptions): Promise<ReleaseResult>

参数

lockTokens

string[]

锁定令牌

options
ReleaseEventsOptions

要发布的选项

返回

Promise<ReleaseResult>

renewEventLocks(string[], RenewEventLocksOptions)

续订一批云事件的锁。

function renewEventLocks(lockTokens: string[], options?: RenewEventLocksOptions): Promise<RenewLocksResult>

参数

lockTokens

string[]

锁定令牌

options
RenewEventLocksOptions

续订的选项

返回

Promise<RenewLocksResult>