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

CreateSubscriptionOptions interface

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

Представляет параметры, устанавливаемые в подписке

Extends
OperationOptions

Свойства

autoDeleteOnIdle

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

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

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

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

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

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

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

Представляет параметры для создания правила по умолчанию для подписки.
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. Этот параметр может быть задан только при создании подписки.
status

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

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

Унаследованные свойства

abortSignal

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

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

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

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

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

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

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

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

deadLetteringOnMessageExpiration?: boolean

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

boolean

defaultMessageTimeToLive

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

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

defaultMessageTimeToLive?: string

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

string

defaultRuleOptions

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

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

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

{ action?: SqlRuleAction, filter?: CorrelationRuleFilter | SqlRuleFilter, name: 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

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

status?: EntityStatus

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

EntityStatus

userMetadata

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

userMetadata?: string

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

string

Сведения об унаследованном свойстве

abortSignal

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

abortSignal?: AbortSignalLike

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

AbortSignalLike

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

onResponse

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

onResponse?: RawResponseCallback

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

RawResponseCallback

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

requestOptions

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

requestOptions?: OperationRequestOptions

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

OperationRequestOptions

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

serializerOptions

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

serializerOptions?: SerializerOptions

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

SerializerOptions

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

tracingOptions

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

tracingOptions?: OperationTracingOptions

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

OperationTracingOptions

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