CreateSubscriptionOptions interface

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

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

autoDeleteOnIdle?: string

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

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

availabilityStatus?: EntityAvailabilityStatus

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

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

deadLetteringOnFilterEvaluationExceptions?: boolean

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

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

deadLetteringOnMessageExpiration?: boolean

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

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

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

defaultMessageTimeToLive?: string

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

Представляет параметры для создания правила по умолчанию для подписки.

defaultRuleOptions?: { action?: SqlRuleAction, filter?: CorrelationRuleFilter | SqlRuleFilter, name: string }

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

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

enableBatchedOperations?: boolean

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

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

forwardDeadLetteredMessagesTo?: string

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

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

forwardTo?: string

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

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

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

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

lockDuration?: string

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

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

maxDeliveryCount?: number

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

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

requiresSession?: boolean

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

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

status?: EntityStatus

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

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

userMetadata?: string

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

Сигнал, который можно использовать для прерывания запросов.

abortSignal?: AbortSignalLike

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

Наследуется отOperationOptions.abortSignal

Функция, вызываемая при каждом получении ответа от сервера при выполнении запрошенной операции. Может вызываться несколько раз.

onResponse?: RawResponseCallback

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

Наследуется отOperationOptions.onResponse

Параметры, используемые при создании и отправке HTTP-запросов для этой операции.

requestOptions?: OperationRequestOptions

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

Наследуется отOperationOptions.requestOptions

Параметры для переопределения поведения сериализации или десериализации.

serializerOptions?: SerializerOptions

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

Наследуется отOperationOptions.serializerOptions

Параметры, используемые при включенной трассировке.

tracingOptions?: OperationTracingOptions

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

Наследуется отOperationOptions.tracingOptions