CreateQueueOptions interface
Представляет параметры, устанавливаемые в очереди.
- Extends
Свойства
authorization |
Правила авторизации в очереди |
auto |
Максимальное время простоя перед удалением сущности. Это необходимо указать в формате длительности ISO-8601, например "PT1M" в течение 1 минуты, "PT5S" в течение 5 секунд. Дополнительные сведения о формате длительности ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations |
availability |
Состояние доступности сущности обмена сообщениями. |
dead |
Если она включена и срок действия сообщения истекает, служебная шина перемещает сообщение из очереди во вложенную очередь недоставленных сообщений очереди. Если этот параметр отключен, сообщение будет окончательно удалено из очереди. Настраивается только при создании очереди. |
default |
В зависимости от того, включено ли deadLettering, сообщение автоматически перемещается во вложенную очередь недоставленных сообщений или удаляется, если оно хранится в очереди дольше указанного времени. Это значение перезаписывается значением TTL, заданным в сообщении, тогда и только тогда, когда TTL сообщения меньше TTL, заданного в очереди. Это значение неизменяемо после создания очереди. Это необходимо указать в формате длительности ISO-8601, например "PT1M" в течение 1 минуты, "PT5S" в течение 5 секунд. Дополнительные сведения о формате длительности ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations |
duplicate |
Указывает период времени, в течение которого служебная шина обнаруживает дублирование сообщений. Это необходимо указать в формате длительности ISO-8601, например "PT1M" в течение 1 минуты, "PT5S" в течение 5 секунд. Дополнительные сведения о формате длительности ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations |
enable |
Указывает, разрешены ли пакетные операции. |
enable |
Указывает, включены ли экспресс-сущности в очереди. |
enable |
Указывает, следует ли секционировать очередь. |
forward |
Абсолютный URL-адрес или имя очереди или раздела, в которые пересылаются недоставленные сообщения.
Например, абсолютный URL-адрес будет иметь форму |
forward |
Абсолютный URL-адрес или имя очереди или раздела, в которые пересылаются сообщения.
Например, абсолютный URL-адрес будет иметь форму |
lock |
определяет время в секундах, в течение которого сообщение должно быть блокировано для обработки получателем. По истечении этого периода сообщение разблокируется и становится доступным для потребления следующим получателем. (Если сеансы включены, эта длительность блокировки применима для сеансов, а не для сообщений.) Это необходимо указать в формате длительности ISO-8601, например "PT1M" в течение 1 минуты, "PT5S" в течение 5 секунд. Дополнительные сведения о формате длительности ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations |
max |
Максимальное число доставок сообщений, после которого, если оно по-прежнему не урегулировано, перемещается во вложенную очередь недоставленных сообщений. |
max |
Максимальный размер сообщения в килобайтах для сообщений, отправленных в эту очередь. (Настраивается только для пространства имен служебной шины уровня "Премиум".) |
max |
задает максимальный размер очереди в мегабайтах. Любая попытка постановки сообщения в очередь, которая вызывает превышение очереди, приведет к сбою. |
requires |
Если этот параметр включен, раздел будет обнаруживать повторяющиеся сообщения в течение периода времени, заданного свойством DuplicateDetectionHistoryTimeWindow. Настраивается только при создании очереди. |
requires |
Если задано значение true, очередь будет поддерживать сеанс и будет поддерживаться только SessionReceiver. Очереди с учетом сеансов не поддерживаются через REST. Настраивается только при создании очереди. |
status | Состояние сущности обмена сообщениями. |
user |
Пользователь предоставил метаданные, связанные с очередью. Используется для указания текстового содержимого, например тегов, меток и т. д. Значение не должно превышать 1024 байта в кодировке utf-8. |
Унаследованные свойства
abort |
Сигнал, который можно использовать для прерывания запросов. |
on |
Функция, вызываемая каждый раз при получении ответа от сервера при выполнении запрошенной операции. Может вызываться несколько раз. |
request |
Параметры, используемые при создании и отправке HTTP-запросов для этой операции. |
serializer |
Параметры для переопределения поведения сериализации или десериализации. |
tracing |
Параметры, используемые при включенной трассировке. |
Сведения о свойстве
authorizationRules
Правила авторизации в очереди
authorizationRules?: AuthorizationRule[]
Значение свойства
autoDeleteOnIdle
Максимальное время простоя перед удалением сущности. Это необходимо указать в формате длительности ISO-8601, например "PT1M" в течение 1 минуты, "PT5S" в течение 5 секунд.
Дополнительные сведения о формате длительности ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
autoDeleteOnIdle?: string
Значение свойства
string
availabilityStatus
Состояние доступности сущности обмена сообщениями.
availabilityStatus?: EntityAvailabilityStatus
Значение свойства
deadLetteringOnMessageExpiration
Если она включена и срок действия сообщения истекает, служебная шина перемещает сообщение из очереди во вложенную очередь недоставленных сообщений очереди. Если этот параметр отключен, сообщение будет окончательно удалено из очереди. Настраивается только при создании очереди.
deadLetteringOnMessageExpiration?: boolean
Значение свойства
boolean
defaultMessageTimeToLive
В зависимости от того, включено ли deadLettering, сообщение автоматически перемещается во вложенную очередь недоставленных сообщений или удаляется, если оно хранится в очереди дольше указанного времени. Это значение перезаписывается значением TTL, заданным в сообщении, тогда и только тогда, когда TTL сообщения меньше TTL, заданного в очереди. Это значение неизменяемо после создания очереди. Это необходимо указать в формате длительности ISO-8601, например "PT1M" в течение 1 минуты, "PT5S" в течение 5 секунд.
Дополнительные сведения о формате длительности ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
defaultMessageTimeToLive?: string
Значение свойства
string
duplicateDetectionHistoryTimeWindow
Указывает период времени, в течение которого служебная шина обнаруживает дублирование сообщений. Это необходимо указать в формате длительности ISO-8601, например "PT1M" в течение 1 минуты, "PT5S" в течение 5 секунд.
Дополнительные сведения о формате длительности ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
duplicateDetectionHistoryTimeWindow?: string
Значение свойства
string
enableBatchedOperations
Указывает, разрешены ли пакетные операции.
enableBatchedOperations?: boolean
Значение свойства
boolean
enableExpress
Указывает, включены ли экспресс-сущности в очереди.
enableExpress?: boolean
Значение свойства
boolean
enablePartitioning
Указывает, следует ли секционировать очередь.
enablePartitioning?: boolean
Значение свойства
boolean
forwardDeadLetteredMessagesTo
Абсолютный URL-адрес или имя очереди или раздела, в которые пересылаются недоставленные сообщения.
Например, абсолютный URL-адрес будет иметь форму sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
forwardDeadLetteredMessagesTo?: string
Значение свойства
string
forwardTo
Абсолютный URL-адрес или имя очереди или раздела, в которые пересылаются сообщения.
Например, абсолютный URL-адрес будет иметь форму sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
forwardTo?: string
Значение свойства
string
lockDuration
определяет время в секундах, в течение которого сообщение должно быть блокировано для обработки получателем. По истечении этого периода сообщение разблокируется и становится доступным для потребления следующим получателем. (Если сеансы включены, эта длительность блокировки применима для сеансов, а не для сообщений.)
Это необходимо указать в формате длительности ISO-8601, например "PT1M" в течение 1 минуты, "PT5S" в течение 5 секунд.
Дополнительные сведения о формате длительности ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
lockDuration?: string
Значение свойства
string
maxDeliveryCount
Максимальное число доставок сообщений, после которого, если оно по-прежнему не урегулировано, перемещается во вложенную очередь недоставленных сообщений.
maxDeliveryCount?: number
Значение свойства
number
maxMessageSizeInKilobytes
Максимальный размер сообщения в килобайтах для сообщений, отправленных в эту очередь.
(Настраивается только для пространства имен служебной шины уровня "Премиум".)
maxMessageSizeInKilobytes?: number
Значение свойства
number
maxSizeInMegabytes
задает максимальный размер очереди в мегабайтах. Любая попытка постановки сообщения в очередь, которая вызывает превышение очереди, приведет к сбою.
maxSizeInMegabytes?: number
Значение свойства
number
requiresDuplicateDetection
Если этот параметр включен, раздел будет обнаруживать повторяющиеся сообщения в течение периода времени, заданного свойством DuplicateDetectionHistoryTimeWindow. Настраивается только при создании очереди.
requiresDuplicateDetection?: boolean
Значение свойства
boolean
requiresSession
Если задано значение true, очередь будет поддерживать сеанс и будет поддерживаться только SessionReceiver. Очереди с учетом сеансов не поддерживаются через REST. Настраивается только при создании очереди.
requiresSession?: boolean
Значение свойства
boolean
status
userMetadata
Пользователь предоставил метаданные, связанные с очередью. Используется для указания текстового содержимого, например тегов, меток и т. д. Значение не должно превышать 1024 байта в кодировке utf-8.
userMetadata?: string
Значение свойства
string
Сведения об унаследованном свойстве
abortSignal
Сигнал, который можно использовать для прерывания запросов.
abortSignal?: AbortSignalLike
Значение свойства
Наследуется отOperationOptions.abortSignal
onResponse
Функция, вызываемая каждый раз при получении ответа от сервера при выполнении запрошенной операции. Может вызываться несколько раз.
onResponse?: RawResponseCallback
Значение свойства
Наследуется отOperationOptions.onResponse
requestOptions
Параметры, используемые при создании и отправке HTTP-запросов для этой операции.
requestOptions?: OperationRequestOptions
Значение свойства
Наследуется отOperationOptions.requestOptions
serializerOptions
Параметры для переопределения поведения сериализации или десериализации.
serializerOptions?: SerializerOptions
Значение свойства
Наследуется отOperationOptions.serializerOptions
tracingOptions
Параметры, используемые при включенной трассировке.
tracingOptions?: OperationTracingOptions
Значение свойства
Наследуется отOperationOptions.tracingOptions