QueueSendMessageOptions interface

Пакет:

@azure/storage-queue

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

Extends

MessagesEnqueueOptionalParams,CommonOptions

Свойства

abortSignal

Реализация интерфейса AbortSignalLike для сигнала о запросе на отмену операции. Например, используйте контроллер @azure/abort-controller для создания AbortSignal.

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

messageTimeToLive	Необязательный. Указывает интервал времени в реальном времени для сообщения в секундах. До версии 2017-07-29 максимальный срок жизни составляет 7 дней. Для версии 2017-07-29 или более поздней, максимальное время жизни может быть любым положительным числом, а также -1, указывающих, что сообщение не истекает. Если этот параметр опущен, время жизни по умолчанию составляет 7 дней.
requestId	Предоставляет созданное клиентом непрозрачное значение с ограничением в 1 КБ символов, которое записывается в журналы аналитики при включении ведения журнала аналитики хранилища.
timeoutInSeconds	Параметр времени ожидания выражается в секундах. Дополнительные сведения см. в разделе Настройка времени ожидания для операций службы очередей.
tracingOptions	Параметры настройки диапазонов, созданных при включении трассировки.
visibilityTimeout	Необязательный. Если задано, запрос должен быть выполнен с помощью x-ms-версии 2011-08-18 или более поздней. Если значение не указано, значение по умолчанию равно 0. Задает новое значение времени ожидания видимости в секундах относительно времени сервера. Новое значение должно быть больше или равно 0, и не может быть больше 7 дней. Время ожидания видимости сообщения не может быть задано значением позже истечения срока действия. Значение видимости должно быть меньше значения времени в реальном времени.

Сведения о свойстве

abortSignal

Реализация интерфейса AbortSignalLike для сигнала о запросе на отмену операции. Например, используйте контроллер @azure/abort-controller для создания AbortSignal.

abortSignal?: AbortSignalLike

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

AbortSignalLike

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

messageTimeToLive

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

messageTimeToLive?: number

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

number

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

requestId

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

requestId?: string

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

string

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

timeoutInSeconds

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

timeoutInSeconds?: number

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

number

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

tracingOptions

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

tracingOptions?: OperationTracingOptions

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

OperationTracingOptions

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

visibilityTimeout

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

visibilityTimeout?: number

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

number

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