QueueProperties interface

  • Ссылка
Пакет:
@azure/service-bus

Представляет входные данные для updateQueue.

Свойства

authorizationRules

Правила авторизации в очереди
autoDeleteOnIdle

Максимальное время простоя перед удалением сущности. Это необходимо указать в формате длительности ISO-8601, например "PT1M" в течение 1 минуты, "PT5S" в течение 5 секунд.

Дополнительные сведения о формате длительности ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
availabilityStatus

Состояние доступности сущности обмена сообщениями.
deadLetteringOnMessageExpiration

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

В зависимости от того, включена ли deadLettering, сообщение автоматически перемещается во вложенную очередь недоставленных сообщений или удаляется, если оно хранится в очереди дольше указанного времени. Это значение перезаписывается значением TTL, заданным в сообщении, тогда и только тогда, когда TTL сообщения меньше TTL, заданного в очереди. Это значение неизменяемо после создания очереди. Это необходимо указать в формате длительности ISO-8601, например "PT1M" в течение 1 минуты, "PT5S" в течение 5 секунд.

Дополнительные сведения о формате длительности ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
duplicateDetectionHistoryTimeWindow

Указывает промежуток времени, в течение которого служебная шина обнаруживает дублирование сообщений. Это необходимо указать в формате длительности ISO-8601, например "PT1M" в течение 1 минуты, "PT5S" в течение 5 секунд.

Дополнительные сведения о формате длительности ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
enableBatchedOperations

Указывает, разрешены ли пакетные операции.
enableExpress

Указывает, включены ли экспресс-сущности в очереди.
enablePartitioning

Указывает, следует ли секционировать очередь.
forwardDeadLetteredMessagesTo

Абсолютный URL-адрес или имя очереди или раздела, в которые пересылаются недоставленные сообщения. Например, абсолютный URL-адрес будет иметь форму sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
forwardTo

Абсолютный URL-адрес или имя очереди или раздела, в которые пересылаются сообщения. Например, абсолютный URL-адрес будет иметь форму sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
lockDuration

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

Это необходимо указать в формате длительности ISO-8601, например "PT1M" в течение 1 минуты, "PT5S" в течение 5 секунд.

Дополнительные сведения о формате длительности ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
maxDeliveryCount

Максимальное число доставок сообщений, после которого, если оно по-прежнему не урегулировано, перемещается во вложенную очередь недоставленных сообщений.
maxMessageSizeInKilobytes

Максимальный размер сообщения в килобайтах для сообщений, отправленных в эту очередь.

Неприменимо, если при создании ServiceBusAdministrationClientвыбрана версия службы "2017-04".
maxSizeInMegabytes

задает максимальный размер очереди в мегабайтах. Любая попытка постановки сообщения в очередь, которая вызывает превышение очереди, приведет к сбою.
name

Имя очереди
requiresDuplicateDetection

Если этот параметр включен, раздел будет обнаруживать повторяющиеся сообщения в течение периода времени, заданного свойством DuplicateDetectionHistoryTimeWindow. Настраивается только при создании очереди.
requiresSession

Если задано значение true, очередь будет поддерживать сеанс и будет поддерживаться только SessionReceiver. Очереди с учетом сеансов не поддерживаются через REST. Настраивается только при создании очереди.
status

Состояние сущности обмена сообщениями.
userMetadata

Пользователь предоставил метаданные, связанные с очередью. Используется для указания текстового содержимого, например тегов, меток и т. д. Значение не должно превышать 1024 байта в кодировке utf-8.

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

authorizationRules

Правила авторизации в очереди

authorizationRules?: AuthorizationRule[]

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

AuthorizationRule[]

autoDeleteOnIdle

Максимальное время простоя перед удалением сущности. Это необходимо указать в формате длительности ISO-8601, например "PT1M" в течение 1 минуты, "PT5S" в течение 5 секунд.

Дополнительные сведения о формате длительности ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations

autoDeleteOnIdle: string

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

string

availabilityStatus

Состояние доступности сущности обмена сообщениями.

availabilityStatus: EntityAvailabilityStatus

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

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

Максимальный размер сообщения в килобайтах для сообщений, отправленных в эту очередь.

Неприменимо, если при создании ServiceBusAdministrationClientвыбрана версия службы "2017-04".

maxMessageSizeInKilobytes?: number

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

number

maxSizeInMegabytes

задает максимальный размер очереди в мегабайтах. Любая попытка постановки сообщения в очередь, которая вызывает превышение очереди, приведет к сбою.

maxSizeInMegabytes: number

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

number

name

Имя очереди

name: string

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

string

requiresDuplicateDetection

Если этот параметр включен, раздел будет обнаруживать повторяющиеся сообщения в течение периода времени, заданного свойством DuplicateDetectionHistoryTimeWindow. Настраивается только при создании очереди.

requiresDuplicateDetection: boolean

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

boolean

requiresSession

Если задано значение true, очередь будет поддерживать сеанс и будет поддерживаться только SessionReceiver. Очереди с учетом сеансов не поддерживаются через REST. Настраивается только при создании очереди.

requiresSession: boolean

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

boolean

status

Состояние сущности обмена сообщениями.

status: EntityStatus

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

EntityStatus

userMetadata

Пользователь предоставил метаданные, связанные с очередью. Используется для указания текстового содержимого, например тегов, меток и т. д. Значение не должно превышать 1024 байта в кодировке utf-8.

userMetadata: string

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

string