CreateTopicOptions interface
Представляет параметры, которые можно задать в разделе
- Extends
Свойства
authorization |
Правила авторизации по этой теме |
auto |
Максимальное время простоя перед удалением сущности. Это необходимо указать в формате длительности ISO-8601, например "PT1M" в течение 1 минуты, "PT5S" в течение 5 секунд. Дополнительные сведения о формате длительности ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations |
availability |
Состояние доступности сущности обмена сообщениями. |
default |
определяет срок жизни сообщений в связанных подписках. Подписки наследуют срок жизни (TTL) из раздела, если только они не созданы явно с меньшим TTL. В зависимости от того, включена ли недоставленная рассылка, сообщение, срок жизни которого истек, будет либо перемещено во вложенную очередь недоставленных сообщений подписки, либо будет удалено безвозвратно. Это необходимо указать в формате длительности ISO-8601, например "PT1M" в течение 1 минуты, "PT5S" в течение 5 секунд. Дополнительные сведения о формате длительности ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations |
duplicate |
Указывает период времени, в течение которого служебная шина будет обнаруживать дублирование сообщений. Это необходимо указать в формате длительности ISO-8601, например "PT1M" в течение 1 минуты, "PT5S" в течение 5 секунд. Дополнительные сведения о формате длительности ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations |
enable |
Указывает, разрешены ли пакетные операции. |
enable |
Указывает, включены ли экспресс-сущности в разделе. |
enable |
Указывает, следует ли секционировать раздел. |
max |
Максимальный размер сообщения в килобайтах для сообщений, отправленных в этот раздел. (Настраивается только для пространства имен служебной шины уровня "Премиум".) |
max |
задает максимальный размер раздела в мегабайтах. Любая попытка постановки в очередь сообщения, которая приведет к превышению этого значения в разделе, завершится ошибкой. Все сообщения, которые сохраняются в разделе или любой из его подписок учитываются при определении этого значения. Несколько копий сообщения, которые находятся в одной или нескольких подписках, считаются одним сообщением. Например, если сообщение m существует один раз в подписке s1 и дважды в подписке s2, m считается одним сообщением. |
requires |
Если этот параметр включен, раздел будет обнаруживать повторяющиеся сообщения в течение периода времени, заданного свойством DuplicateDetectionHistoryTimeWindow. Настраивается только при создании раздела. |
status | Состояние сущности обмена сообщениями. |
support |
Указывает, поддерживает ли раздел упорядочение сообщений. |
user |
Пользователь предоставил метаданные, связанные с разделом. Используется для указания текстового содержимого, например тегов, меток и т. д. Значение не должно превышать 1024 байта в кодировке utf-8. |
Унаследованные свойства
abort |
Сигнал, который можно использовать для прерывания запросов. |
on |
Функция, вызываемая при каждом получении ответа от сервера при выполнении запрошенной операции. Может вызываться несколько раз. |
request |
Параметры, используемые при создании и отправке HTTP-запросов для этой операции. |
serializer |
Параметры для переопределения поведения сериализации или десериализации. |
tracing |
Параметры, используемые при включенной трассировке. |
Сведения о свойстве
authorizationRules
Правила авторизации по этой теме
authorizationRules?: AuthorizationRule[]
Значение свойства
autoDeleteOnIdle
Максимальное время простоя перед удалением сущности. Это необходимо указать в формате длительности ISO-8601, например "PT1M" в течение 1 минуты, "PT5S" в течение 5 секунд.
Дополнительные сведения о формате длительности ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
autoDeleteOnIdle?: string
Значение свойства
string
availabilityStatus
Состояние доступности сущности обмена сообщениями.
availabilityStatus?: EntityAvailabilityStatus
Значение свойства
defaultMessageTimeToLive
определяет срок жизни сообщений в связанных подписках. Подписки наследуют срок жизни (TTL) из раздела, если только они не созданы явно с меньшим TTL. В зависимости от того, включена ли недоставленная рассылка, сообщение, срок жизни которого истек, будет либо перемещено во вложенную очередь недоставленных сообщений подписки, либо будет удалено безвозвратно. Это необходимо указать в формате длительности ISO-8601, например "PT1M" в течение 1 минуты, "PT5S" в течение 5 секунд.
Дополнительные сведения о формате длительности ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
defaultMessageTimeToLive?: string
Значение свойства
string
duplicateDetectionHistoryTimeWindow
Указывает период времени, в течение которого служебная шина будет обнаруживать дублирование сообщений. Это необходимо указать в формате длительности ISO-8601, например "PT1M" в течение 1 минуты, "PT5S" в течение 5 секунд.
Дополнительные сведения о формате длительности ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
duplicateDetectionHistoryTimeWindow?: string
Значение свойства
string
enableBatchedOperations
Указывает, разрешены ли пакетные операции.
enableBatchedOperations?: boolean
Значение свойства
boolean
enableExpress
Указывает, включены ли экспресс-сущности в разделе.
enableExpress?: boolean
Значение свойства
boolean
enablePartitioning
Указывает, следует ли секционировать раздел.
enablePartitioning?: boolean
Значение свойства
boolean
maxMessageSizeInKilobytes
Максимальный размер сообщения в килобайтах для сообщений, отправленных в этот раздел.
(Настраивается только для пространства имен служебной шины уровня "Премиум".)
maxMessageSizeInKilobytes?: number
Значение свойства
number
maxSizeInMegabytes
задает максимальный размер раздела в мегабайтах. Любая попытка постановки в очередь сообщения, которая приведет к превышению этого значения в разделе, завершится ошибкой. Все сообщения, которые сохраняются в разделе или любой из его подписок учитываются при определении этого значения. Несколько копий сообщения, которые находятся в одной или нескольких подписках, считаются одним сообщением. Например, если сообщение m существует один раз в подписке s1 и дважды в подписке s2, m считается одним сообщением.
maxSizeInMegabytes?: number
Значение свойства
number
requiresDuplicateDetection
Если этот параметр включен, раздел будет обнаруживать повторяющиеся сообщения в течение периода времени, заданного свойством DuplicateDetectionHistoryTimeWindow. Настраивается только при создании раздела.
requiresDuplicateDetection?: boolean
Значение свойства
boolean
status
supportOrdering
Указывает, поддерживает ли раздел упорядочение сообщений.
supportOrdering?: boolean
Значение свойства
boolean
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