Поделиться через


QueueProperties interface

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

Свойства

authorizationRules

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

autoDeleteOnIdle

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

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

availabilityStatus

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

deadLetteringOnMessageExpiration

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

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. Параметр settable можно задать только во время создания очереди.

requiresSession

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

status

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

userMetadata

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

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

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

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

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. Параметр settable можно задать только во время создания очереди.

requiresDuplicateDetection: boolean

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

boolean

requiresSession

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

requiresSession: boolean

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

boolean

status

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

status: EntityStatus

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

userMetadata

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

userMetadata: string

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

string