QueueSendMessageOptions interface

Пакет:

@azure/storage-queue

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

Extends

MessagesEnqueueOptionalParams,CommonOptions

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

abortSignal	Сигнал контроллера прерывания. Можно использовать для прерывания отправки сетевого запроса и ожидания ответа.
customHeaders	будет применен до отправки запроса.
messageTimeToLive	Необязательный элемент. Задает интервал срока существования сообщения в секундах. До версии 29.07.2017 максимальное допустимое время жизни — 7 дней. Для версии 2017-07-29 или более поздней максимальной продолжительности жизни может быть любое положительное число, а также -1, указывающее, что срок действия сообщения не истекает. Если этот параметр пропущен, по умолчанию срок существования составляет 7 дней.
onDownloadProgress	Обратный вызов, который срабатывает при скачивании.
onUploadProgress	Обратный вызов, который запускается при выполнении отправки.
requestId	Клиент создал непрозрачное значение с ограничением символов, равным 1 КБ, которое записывается в журналы аналитики, когда ведение журнала службы аналитики хранилища включено.
serializerOptions	Параметры для переопределения поведения синтаксического анализа и сборки XML.
shouldDeserialize	Указывает, следует ли десериализовать httpOperationResponse. Если этот параметр не определен, необходимо десериализировать httpOperationResponse.
timeout	Количество миллисекундах, которые может занять запрос до автоматического завершения. Если запрос завершается, AbortError создается исключение .
timeoutInSeconds	Параметр времени ожидания выражается в секундах. Дополнительные сведения см. в разделе Настройка времени ожидания для операций службы очередей.
tracingContext	Трассировка: контекст, используемый при создании диапазонов.
tracingOptions	Параметры для настройки диапазонов, созданных при включенной трассировке.
visibilityTimeout	Необязательный элемент. Если указан параметр, запрос должен выполняться с помощью x-ms-версии 2011-08-18 или более поздней версии. Если не указано, значение по умолчанию равно 0. Указывает новое значение времени ожидания видимости в секундах, отсчитываемое относительно времени сервера. Новое значение должно быть больше или равно 0 и не может превышать 7 дней. Для времени ожидания видимости сообщения нельзя задать значение позже истечения срока. Для параметра visibilitytimeout должно быть задано значение, меньшее, чем значение времени жизни.

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

abortSignal

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

abortSignal?: AbortSignalLike

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

AbortSignalLike

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

customHeaders

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

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

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

{[key: string]: string}

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

messageTimeToLive

Необязательный элемент. Задает интервал срока существования сообщения в секундах. До версии 29.07.2017 максимальное допустимое время жизни — 7 дней. Для версии 2017-07-29 или более поздней максимальной продолжительности жизни может быть любое положительное число, а также -1, указывающее, что срок действия сообщения не истекает. Если этот параметр пропущен, по умолчанию срок существования составляет 7 дней.

messageTimeToLive?: number

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

number

Наследуется отMessagesEnqueueOptionalParams.messageTimeToLive

onDownloadProgress

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

onDownloadProgress?: (progress: TransferProgressEvent) => void

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

(progress: TransferProgressEvent) => void

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

onUploadProgress

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

onUploadProgress?: (progress: TransferProgressEvent) => void

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

(progress: TransferProgressEvent) => void

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

requestId

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

requestId?: string

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

string

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

serializerOptions

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

serializerOptions?: SerializerOptions

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

SerializerOptions

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

shouldDeserialize

Указывает, следует ли десериализовать httpOperationResponse. Если этот параметр не определен, необходимо десериализировать httpOperationResponse.

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

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

boolean | (response: HttpOperationResponse) => boolean

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

timeout

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

timeout?: number

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

number

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

timeoutInSeconds

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

timeoutInSeconds?: number

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

number

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

tracingContext

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

tracingContext?: Context

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

@azure/core-tracing.Context

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

tracingOptions

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

tracingOptions?: OperationTracingOptions

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

OperationTracingOptions

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

visibilityTimeout

Необязательный элемент. Если указан параметр, запрос должен выполняться с помощью x-ms-версии 2011-08-18 или более поздней версии. Если не указано, значение по умолчанию равно 0. Указывает новое значение времени ожидания видимости в секундах, отсчитываемое относительно времени сервера. Новое значение должно быть больше или равно 0 и не может превышать 7 дней. Для времени ожидания видимости сообщения нельзя задать значение позже истечения срока. Для параметра visibilitytimeout должно быть задано значение, меньшее, чем значение времени жизни.

visibilityTimeout?: number

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

number

Наследуется отMessagesEnqueueOptionalParams.visibilityTimeout