SubscriptionProperties interface
Представляет входные данные для updateSubscription.
Свойства
| auto |
Максимальное время простоя перед удалением сущности. Это необходимо указать в формате длительности ISO-8601, например "PT1M" в течение 1 минуты, "PT5S" в течение 5 секунд. Дополнительные сведения о формате длительности ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations |
| availability |
Состояние доступности сущности обмена сообщениями. |
| dead |
Определяет, как служебная шина обрабатывает сообщение, которое вызывает исключение во время оценки фильтра подписки. Если задано значение true, сообщение, вызвавшее исключение, будет перемещено во вложенную очередь недоставленных сообщений подписки. В противном случае он будет удален. По умолчанию этому параметру присвоено значение true, что позволяет пользователю исследовать причину исключения. Оно может быть обусловлено недопустимой формой сообщения или неверными предположениями о его форме, сделанными при настройке фильтра. Настраивается только при создании раздела. |
| dead |
Если он включен и срок действия сообщения истекает, служебная шина перемещает сообщение из очереди во вложенную очередь недоставленных сообщений подписки. Если этот параметр отключен, сообщение будет окончательно удалено из основной очереди подписки. Этот параметр может быть задан только при создании подписки. |
| default |
Определяет длительность существования сообщения в подписке. В зависимости от того, включено ли недоставленное сообщение, срок жизни которого истек, будет либо перемещено в связанную с подпиской deadLtterQueue, либо окончательно удалено. Это необходимо указать в формате длительности ISO-8601, например "PT1M" в течение 1 минуты, "PT5S" в течение 5 секунд. Дополнительные сведения о формате длительности ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations |
| 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 |
Максимальное число доставок сообщений, после которого, если оно по-прежнему не урегулировано, перемещается во вложенную очередь недоставленных сообщений. |
| requires |
Если задано значение true, подписка будет поддерживать сеанс и будет поддерживаться только SessionReceiver. Подписка с поддержкой сеансов не поддерживается через REST. Этот параметр может быть задан только при создании подписки. |
| status | Состояние сущности обмена сообщениями. |
| subscription |
Имя подписки |
| topic |
Имя раздела |
| user |
Пользователь предоставил сведения о метаданных, связанных с подпиской. Используется для указания текстового содержимого, например тегов, меток и т. д. Значение не должно превышать 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Значение свойства
deadLetteringOnFilterEvaluationExceptions
Определяет, как служебная шина обрабатывает сообщение, которое вызывает исключение во время оценки фильтра подписки. Если задано значение true, сообщение, вызвавшее исключение, будет перемещено во вложенную очередь недоставленных сообщений подписки. В противном случае он будет удален. По умолчанию этому параметру присвоено значение true, что позволяет пользователю исследовать причину исключения. Оно может быть обусловлено недопустимой формой сообщения или неверными предположениями о его форме, сделанными при настройке фильтра. Настраивается только при создании раздела.
deadLetteringOnFilterEvaluationExceptions: booleanЗначение свойства
boolean
deadLetteringOnMessageExpiration
Если он включен и срок действия сообщения истекает, служебная шина перемещает сообщение из очереди во вложенную очередь недоставленных сообщений подписки. Если этот параметр отключен, сообщение будет окончательно удалено из основной очереди подписки. Этот параметр может быть задан только при создании подписки.
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. Этот параметр может быть задан только при создании подписки.
requiresSession: booleanЗначение свойства
boolean
status
subscriptionName
Имя подписки
subscriptionName: stringЗначение свойства
string
topicName
Имя раздела
topicName: stringЗначение свойства
string
userMetadata
Пользователь предоставил сведения о метаданных, связанных с подпиской. Используется для указания текстового содержимого, например тегов, меток и т. д. Значение не должно превышать 1024 байта в кодировке utf-8.
userMetadata?: stringЗначение свойства
string