ReceiveEventsOptions interface

Пакет:

@azure/eventgrid-namespaces

Параметры получения событий

Extends

ReceiveEventsOptionalParams

Унаследованные свойства

abortSignal	Сигнал, который можно использовать для прерывания запросов.
maxEvents	Максимальное число событий для получения. Минимальное значение равно 1, а максимальное значение — 100 событий. Если значение по умолчанию не указано, значение по умолчанию равно 1.
maxWaitTime	Максимальное значение времени ожидания для операции получения в секундах. Это время в секундах, когда сервер приблизительно ожидает доступности события и отвечает на запрос. Если событие доступно, брокер немедленно отвечает клиенту. Минимальное значение составляет 10 секунд, а максимальное значение — 120 секунд. Если значение не указано, значение по умолчанию — 60 секунд.
onResponse	Функция, вызываемая каждый раз при получении ответа от сервера при выполнении запрошенной операции. Может вызываться несколько раз.
requestOptions	Параметры, используемые при создании и отправке HTTP-запросов для этой операции.
tracingOptions	Параметры, используемые при включении трассировки.

Сведения об унаследованном свойстве

abortSignal

Сигнал, который можно использовать для прерывания запросов.

abortSignal?: AbortSignalLike

Значение свойства

AbortSignalLike

наследуется отReceiveEventsOptionalParams.abortSignal

maxEvents

Максимальное число событий для получения. Минимальное значение равно 1, а максимальное значение — 100 событий. Если значение по умолчанию не указано, значение по умолчанию равно 1.

maxEvents?: number

Значение свойства

number

унаследовано отReceiveEventsOptionalParams.maxEvents

maxWaitTime

Максимальное значение времени ожидания для операции получения в секундах. Это время в секундах, когда сервер приблизительно ожидает доступности события и отвечает на запрос. Если событие доступно, брокер немедленно отвечает клиенту. Минимальное значение составляет 10 секунд, а максимальное значение — 120 секунд. Если значение не указано, значение по умолчанию — 60 секунд.

maxWaitTime?: number

Значение свойства

number

наследуется отReceiveEventsOptionalParams.maxWaitTime

onResponse

Функция, вызываемая каждый раз при получении ответа от сервера при выполнении запрошенной операции. Может вызываться несколько раз.

onResponse?: RawResponseCallback

Значение свойства

RawResponseCallback

наследуется отReceiveEventsOptionalParams.onResponse

requestOptions

Параметры, используемые при создании и отправке HTTP-запросов для этой операции.

requestOptions?: OperationRequestOptions

Значение свойства

OperationRequestOptions

наследуется отReceiveEventsOptionalParams.requestOptions

tracingOptions

Параметры, используемые при включении трассировки.

tracingOptions?: OperationTracingOptions

Значение свойства

OperationTracingOptions

наследуется отReceiveEventsOptionalParams.tracingOptions