EventGridClient class

Клиент EventGrid для обмена сообщениями Azure

new EventGridClient(endpoint: string, credential: AzureKeyCredential | TokenCredential, options?: EventGridClientOptions)

Параметры

Подтвердите пакет облачных событий. Сервер отвечает с кодом состояния HTTP 200, если по крайней мере одно событие успешно подтверждено. Текст ответа будет содержать набор успешно подтвержденных lockTokens, а также другие неудачные блокировки с соответствующими сведениями об ошибке. Успешно подтвержденные события больше не будут доступны любому потребителю.

function acknowledgeCloudEvents(lockTokens: string[], topicName: string, eventSubscriptionName: string, options?: AcknowledgeCloudEventsOptions): Promise<AcknowledgeResult>

Параметры

Возвращаемое значение

Публикация события одного облака в разделе пространства имен. В случае успешного выполнения сервер отвечает с кодом состояния HTTP 200 пустым объектом JSON в ответе. В противном случае сервер может возвращать различные коды ошибок. Например, 401: что указывает на сбой авторизации, 403: указывающее превышение квоты или сообщение слишком велико, 410: указывающее, что конкретный раздел не найден, 400: для неправильного запроса и 500: для внутренней ошибки сервера.

function publishCloudEvent<T>(event: CloudEvent<T>, topicName: string, options?: PublishCloudEventOptions): Promise<void>

Параметры

Возвращаемое значение

Раздел Публикация события облака пакетной службы в пространстве имен. В случае успешного выполнения сервер отвечает с кодом состояния HTTP 200 пустым объектом JSON в ответе. В противном случае сервер может возвращать различные коды ошибок. Например, 401: что указывает на сбой авторизации, 403: указывающее превышение квоты или сообщение слишком велико, 410: указывающее, что конкретный раздел не найден, 400: для неправильного запроса и 500: для внутренней ошибки сервера.

function publishCloudEvents<T>(events: CloudEvent<T>[], topicName: string, options?: PublishCloudEventsOptions): Promise<void>

Параметры

Возвращаемое значение

Получение пакета облачных событий из подписки на события.

function receiveCloudEvents(topicName: string, eventSubscriptionName: string, options?: ReceiveCloudEventsOptions): Promise<ReceiveResult>

Параметры

Возвращаемое значение

Отклонить пакет облачных событий.

function rejectCloudEvents(lockTokens: string[], topicName: string, eventSubscriptionName: string, options?: RejectCloudEventsOptions): Promise<RejectResult>

Параметры

Возвращаемое значение

Выпуск пакета облачных событий. Сервер отвечает с кодом состояния HTTP 200, если по крайней мере одно событие успешно выпущено. Текст ответа будет содержать набор успешно выпущенных lockTokens, а также другие неудачные блокировки с соответствующими сведениями об ошибке.

function releaseCloudEvents(lockTokens: string[], topicName: string, eventSubscriptionName: string, options?: ReleaseCloudEventsOptions): Promise<ReleaseResult>

Параметры

Возвращаемое значение

Продление блокировки для пакета облачных событий.

function renewCloudEventLocks(lockTokens: string[], topicName: string, eventSubscriptionName: string, options?: RenewCloudEventLocksOptions): Promise<RenewCloudEventLocksResult>

Параметры

Возвращаемое значение