QueuePeekMessagesOptions interface

Пакет:

@azure/storage-queue

Параметры для настройки операции peekMessages

Extends

MessagesPeekOptionalParams,CommonOptions

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

abortSignal	Сигнал контроллера прерывания. Может использоваться для прерывания отправки сетевого запроса и ожидания ответа.
customHeaders	будет применен до отправки запроса.
numberOfMessages	Необязательный элемент. Ненулевое целочисленное значение, которое определяет количество сообщений для получения из очереди (не более 32). Если видимых сообщений меньше, то возвращаются только видимые. По умолчанию эта операция возвращает одно сообщение из очереди.
onDownloadProgress	Обратный вызов, который срабатывает при скачивании.
onUploadProgress	Обратный вызов, который срабатывает при выполнении отправки.
requestId	Клиент создал непрозрачное значение с ограничением символов, равным 1 КБ, которое записывается в журналы аналитики, когда ведение журнала службы аналитики хранилища включено.
serializerOptions	Параметры для переопределения поведения синтаксического анализа и построения XML.
shouldDeserialize	Следует ли десериализовать httpOperationResponse. Если этот параметр не определен, следует десериализовать httpOperationResponse.
timeout	Количество миллисекундах, которые может занять запрос до автоматического завершения. Если запрос завершается, AbortError возникает исключение .
timeoutInSeconds	Параметр Время ожидания выражается в секундах. Дополнительные сведения см. в разделе Настройка времени ожидания для операций службы очередей.
tracingContext	Трассировка: контекст, используемый при создании диапазонов.
tracingOptions	Параметры для настройки диапазонов, созданных при включенной трассировке.

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

abortSignal

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

abortSignal?: AbortSignalLike

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

AbortSignalLike

Наследуется отMessagesPeekOptionalParams.abortSignal

customHeaders

будет применен до отправки запроса.

customHeaders?: {[key: string]: string}

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

{[key: string]: string}

Наследуется отMessagesPeekOptionalParams.customHeaders

numberOfMessages

Необязательный элемент. Ненулевое целочисленное значение, которое определяет количество сообщений для получения из очереди (не более 32). Если видимых сообщений меньше, то возвращаются только видимые. По умолчанию эта операция возвращает одно сообщение из очереди.

numberOfMessages?: number

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

number

Наследуется отMessagesPeekOptionalParams.numberOfMessages

onDownloadProgress

Обратный вызов, который срабатывает при скачивании.

onDownloadProgress?: (progress: TransferProgressEvent) => void

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

(progress: TransferProgressEvent) => void

Наследуется отMessagesPeekOptionalParams.onDownloadProgress

onUploadProgress

Обратный вызов, который срабатывает при выполнении отправки.

onUploadProgress?: (progress: TransferProgressEvent) => void

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

(progress: TransferProgressEvent) => void

Наследуется отMessagesPeekOptionalParams.onUploadProgress

requestId

Клиент создал непрозрачное значение с ограничением символов, равным 1 КБ, которое записывается в журналы аналитики, когда ведение журнала службы аналитики хранилища включено.

requestId?: string

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

string

Наследуется отMessagesPeekOptionalParams.requestId

serializerOptions

Параметры для переопределения поведения синтаксического анализа и построения XML.

serializerOptions?: SerializerOptions

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

SerializerOptions

Наследуется отMessagesPeekOptionalParams.serializerOptions

shouldDeserialize

Следует ли десериализовать httpOperationResponse. Если этот параметр не определен, следует десериализовать httpOperationResponse.

shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean

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

boolean | (response: HttpOperationResponse) => boolean

Наследуется отMessagesPeekOptionalParams.shouldDeserialize

timeout

Количество миллисекундах, которые может занять запрос до автоматического завершения. Если запрос завершается, AbortError возникает исключение .

timeout?: number

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

number

Наследуется отMessagesPeekOptionalParams.timeout

timeoutInSeconds

Параметр Время ожидания выражается в секундах. Дополнительные сведения см. в разделе Настройка времени ожидания для операций службы очередей.

timeoutInSeconds?: number

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

number

Наследуется отMessagesPeekOptionalParams.timeoutInSeconds

tracingContext

Трассировка: контекст, используемый при создании диапазонов.

tracingContext?: Context

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

@azure/core-tracing.Context

Наследуется отMessagesPeekOptionalParams.tracingContext

tracingOptions

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

tracingOptions?: OperationTracingOptions

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

OperationTracingOptions

Наследуется отCommonOptions.tracingOptions