EventGridReceiverClient class
Клиент пространств имен сетки событий
Конструкторы
| Event |
Клиент EventGrid для обмена сообщениями Azure |
Методы
| acknowledge |
Подтвердите пакет облачных событий. Сервер отвечает с кодом состояния HTTP 200, если по крайней мере одно событие успешно подтверждено. Текст ответа будет содержать набор успешно подтвержденных lockTokens, а также другие неудачные блокировки с соответствующими сведениями об ошибке. Успешно подтвержденные события больше не будут доступны любому потребителю. |
| receive |
Получение пакета облачных событий из подписки на события. |
| reject |
Отклонить пакет облачных событий. |
| release |
Выпуск пакета облачных событий. Сервер отвечает с кодом состояния HTTP 200, если по крайней мере одно событие успешно выпущено. Текст ответа будет содержать набор успешно выпущенных lockTokens, а также другие неудачные блокировки с соответствующими сведениями об ошибке. |
| renew |
Продление блокировки для пакета облачных событий. |
Сведения о конструкторе
EventGridReceiverClient(string, AzureKeyCredential | TokenCredential, string, string, EventGridReceiverClientOptions)
Клиент EventGrid для обмена сообщениями Azure
new EventGridReceiverClient(endpoint: string, credential: AzureKeyCredential | TokenCredential, topicName: string, subscriptionName: string, options?: EventGridReceiverClientOptions)Параметры
- endpoint
-
string
- credential
- topicName
-
string
- subscriptionName
-
string
- options
- EventGridReceiverClientOptions
Сведения о методе
acknowledgeEvents(string[], AcknowledgeEventsOptions)
Подтвердите пакет облачных событий. Сервер отвечает с кодом состояния HTTP 200, если по крайней мере одно событие успешно подтверждено. Текст ответа будет содержать набор успешно подтвержденных lockTokens, а также другие неудачные блокировки с соответствующими сведениями об ошибке. Успешно подтвержденные события больше не будут доступны любому потребителю.
function acknowledgeEvents(lockTokens: string[], options?: AcknowledgeEventsOptions): Promise<AcknowledgeResult>Параметры
- lockTokens
-
string[]
Маркеры блокировки
- options
- AcknowledgeEventsOptions
Параметры подтверждения
Возвращаемое значение
Promise<AcknowledgeResult>
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, а также другие неудачные блокировки с соответствующими сведениями об ошибке.
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>