SubscriptionProperties interface

Пакет:

@azure/service-bus

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

Свойства

autoDeleteOnIdle	Максимальное время простоя перед удалением сущности. Это необходимо указать в формате длительности ISO-8601, например "PT1M" в течение 1 минуты, "PT5S" в течение 5 секунд. Дополнительные сведения о формате длительности ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
availabilityStatus	Состояние доступности сущности обмена сообщениями.
deadLetteringOnFilterEvaluationExceptions	Определяет, как служебная шина обрабатывает сообщение, вызывающее исключение во время оценки фильтра подписки. Если задано значение true, сообщение, вызвавшее исключение, будет перемещено в недоставленную очередь подписки. В противном случае он будет удален. По умолчанию этот параметр имеет значение true, что позволяет пользователю исследовать причину исключения. Это может произойти из неправильно сформированного сообщения или некоторых неправильных предположений, сделанных в фильтре о форме сообщения. Настройка только во время создания раздела.
deadLetteringOnMessageExpiration	Если оно включено, а срок действия сообщения истекает, служебная шина перемещает сообщение из очереди в недоставленную очередь подписки. При отключении сообщение будет окончательно удалено из основной очереди подписки. Settable только во время создания подписки.
defaultMessageTimeToLive	Определяет продолжительное время жизни сообщения в подписке. В зависимости от того, включена ли недоставка, сообщение, срок действия которого истек, будет перемещен в связанную подписку DeadLtterQueue или окончательно удален. Это необходимо указать в формате длительности ISO-8601, например "PT1M" в течение 1 минуты, "PT5S" в течение 5 секунд. Дополнительные сведения о формате длительности ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
enableBatchedOperations	Указывает, следует ли разрешать пакетные операции.
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	Максимальное количество сообщений, после которых, если оно по-прежнему не урегулировано, перемещается в подстроку недоставки.
requiresSession	Если задано значение true, подписка будет поддерживаться с учетом сеанса и будет поддерживаться только SessionReceiver. Подписка с поддержкой сеансов не поддерживается через REST. Settable только во время создания подписки.
status	Состояние сущности обмена сообщениями.
subscriptionName	Имя подписки
topicName	Имя раздела
userMetadata	Пользователь предоставил сведения о метаданных, связанных с подпиской. Используется для указания текстового содержимого, например тегов, меток и т. д. Значение не должно превышать 1024 байтов, закодированных в utf-8.

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

autoDeleteOnIdle

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

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

autoDeleteOnIdle: string

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

string

availabilityStatus

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

availabilityStatus?: EntityAvailabilityStatus

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

EntityAvailabilityStatus

deadLetteringOnFilterEvaluationExceptions

Определяет, как служебная шина обрабатывает сообщение, вызывающее исключение во время оценки фильтра подписки. Если задано значение true, сообщение, вызвавшее исключение, будет перемещено в недоставленную очередь подписки. В противном случае он будет удален. По умолчанию этот параметр имеет значение true, что позволяет пользователю исследовать причину исключения. Это может произойти из неправильно сформированного сообщения или некоторых неправильных предположений, сделанных в фильтре о форме сообщения. Настройка только во время создания раздела.

deadLetteringOnFilterEvaluationExceptions: boolean

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

boolean

deadLetteringOnMessageExpiration

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

deadLetteringOnMessageExpiration: boolean

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

boolean

defaultMessageTimeToLive

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

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

defaultMessageTimeToLive: string

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

string

enableBatchedOperations

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

enableBatchedOperations: 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

requiresSession

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

requiresSession: boolean

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

boolean

status

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

status: EntityStatus

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

EntityStatus

subscriptionName

Имя подписки

subscriptionName: string

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

string

topicName

Имя раздела

topicName: string

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

string

userMetadata

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

userMetadata?: string

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

string