CreateSubscriptionOptions interface
Представляет параметры набора в подписке
- Extends
Свойства
auto |
Максимальное время простоя перед удалением сущности. Это необходимо указать в формате длительности ISO-8601, например "PT1M" в течение 1 минуты, "PT5S" в течение 5 секунд. Дополнительные сведения о формате длительности ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations |
availability |
Состояние доступности сущности обмена сообщениями. |
dead |
Определяет, как служебная шина обрабатывает сообщение, вызывающее исключение во время оценки фильтра подписки. Если задано значение true, сообщение, вызвавшее исключение, будет перемещено в недоставленную очередь подписки. В противном случае он будет удален. По умолчанию этот параметр имеет значение true, что позволяет пользователю исследовать причину исключения. Это может произойти из неправильно сформированного сообщения или некоторых неправильных предположений, сделанных в фильтре о форме сообщения. Настройка только во время создания раздела. |
dead |
Если оно включено, а срок действия сообщения истекает, служебная шина перемещает сообщение из очереди в недоставленную очередь подписки. При отключении сообщение будет окончательно удалено из основной очереди подписки. Settable только во время создания подписки. |
default |
Определяет продолжительное время жизни сообщения в подписке. В зависимости от того, включена ли недоставка, сообщение, срок действия которого истек, будет перемещен в связанную подписку DeadLtterQueue или окончательно удален. Это необходимо указать в формате длительности ISO-8601, например "PT1M" в течение 1 минуты, "PT5S" в течение 5 секунд. Дополнительные сведения о формате длительности ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations |
default |
Представляет параметры для создания правила по умолчанию для подписки. |
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. Settable только во время создания подписки. |
status | Состояние сущности обмена сообщениями. |
user |
Пользователь предоставил сведения о метаданных, связанных с подпиской. Используется для указания текстового содержимого, например тегов, меток и т. д. Значение не должно превышать 1024 байтов, закодированных в utf-8. |
Унаследованные свойства
abort |
Сигнал, который можно использовать для прерывания запросов. |
on |
Функция, вызываемая каждый раз при получении ответа от сервера при выполнении запрошенной операции. Может вызываться несколько раз. |
request |
Параметры, используемые при создании и отправке HTTP-запросов для этой операции. |
serializer |
Параметры переопределения поведения сериализации и десериализации. |
tracing |
Параметры, используемые при включении трассировки. |
Сведения о свойстве
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
Если оно включено, а срок действия сообщения истекает, служебная шина перемещает сообщение из очереди в недоставленную очередь подписки. При отключении сообщение будет окончательно удалено из основной очереди подписки. 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
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. Settable только во время создания подписки.
requiresSession?: boolean
Значение свойства
boolean
status
userMetadata
Пользователь предоставил сведения о метаданных, связанных с подпиской. Используется для указания текстового содержимого, например тегов, меток и т. д. Значение не должно превышать 1024 байтов, закодированных в utf-8.
userMetadata?: string
Значение свойства
string
Сведения об унаследованном свойстве
abortSignal
Сигнал, который можно использовать для прерывания запросов.
abortSignal?: AbortSignalLike
Значение свойства
наследуется отOperationOptions.abortSignal
onResponse
Функция, вызываемая каждый раз при получении ответа от сервера при выполнении запрошенной операции. Может вызываться несколько раз.
onResponse?: RawResponseCallback
Значение свойства
наследуется отOperationOptions.onResponse
requestOptions
Параметры, используемые при создании и отправке HTTP-запросов для этой операции.
requestOptions?: OperationRequestOptions
Значение свойства
наследуется отOperationOptions.requestOptions
serializerOptions
Параметры переопределения поведения сериализации и десериализации.
serializerOptions?: SerializerOptions
Значение свойства
Наследуется отOperationOptions.serializerOptions
tracingOptions
Параметры, используемые при включении трассировки.
tracingOptions?: OperationTracingOptions
Значение свойства
наследуется отOperationOptions.tracingOptions