你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

CreateTopicOptions interface

表示主题上的可设置选项

扩展

属性

authorizationRules

有关主题的授权规则

autoDeleteOnIdle

删除实体之前的最大空闲时间。 这是以 ISO-8601 持续时间格式(例如 1 分钟为“PT1M”)指定的,“PT5S”为 5 秒。

ISO-8601 持续时间格式的详细信息:https://en.wikipedia.org/wiki/ISO_8601#Durations

availabilityStatus

消息传送实体的可用性状态。

defaultMessageTimeToLive

确定消息在关联订阅中的生存时间。 除非订阅使用较小的 TTL 显式创建,否则订阅将从主题继承 TTL。 根据是否启用死信,其 TTL 已过期的消息将移动到订阅的关联死信子队列,或者将被永久删除。 这是以 ISO-8601 持续时间格式(例如 1 分钟为“PT1M”)指定的,“PT5S”为 5 秒。

ISO-8601 持续时间格式的详细信息:https://en.wikipedia.org/wiki/ISO_8601#Durations

duplicateDetectionHistoryTimeWindow

指定服务总线将检测消息重复的时间跨度。 这是以 ISO-8601 持续时间格式(例如 1 分钟为“PT1M”)指定的,“PT5S”为 5 秒。

ISO-8601 持续时间格式的详细信息:https://en.wikipedia.org/wiki/ISO_8601#Durations

enableBatchedOperations

指定是否应允许批处理作。

enableExpress

指定是否在主题上启用快速实体。

enablePartitioning

指定是否应对主题进行分区

maxMessageSizeInKilobytes

发送到本主题的消息的最大消息大小(以 KB 为单位)。

(仅适用于高级层服务总线命名空间。)

maxSizeInMegabytes

指定最大主题大小(以 MB 为单位)。 任何尝试排队导致主题超过此值的消息都将失败。 主题中存储的所有消息或其任何订阅都计入此值。 驻留在一个或多个订阅中的消息的多个副本计为单个消息。 例如,如果订阅 s1 中存在一次消息 m,订阅 s2 中存在两次消息,则 m 计数为单个消息。

requiresDuplicateDetection

如果启用,主题将在 DuplicateDetectionHistoryTimeWindow 属性指定的时间范围内检测重复消息。 仅在创建主题时设置。

status

消息传送实体的状态。

supportOrdering

指定主题是否支持消息排序。

userMetadata

用户提供了与主题关联的元数据信息。 用于指定文本内容,例如标记、标签等。值不得超过以 utf-8 编码的 1024 字节。

继承属性

abortSignal

可用于中止请求的信号。

onResponse

在执行请求的作时,每次从服务器接收响应时调用的函数。 可以多次调用。

requestOptions

为此作创建和发送 HTTP 请求时使用的选项。

serializerOptions

用于替代序列化/取消序列化行为的选项。

tracingOptions

启用跟踪时使用的选项。

属性详细信息

authorizationRules

有关主题的授权规则

authorizationRules?: AuthorizationRule[]

属性值

autoDeleteOnIdle

删除实体之前的最大空闲时间。 这是以 ISO-8601 持续时间格式(例如 1 分钟为“PT1M”)指定的,“PT5S”为 5 秒。

ISO-8601 持续时间格式的详细信息:https://en.wikipedia.org/wiki/ISO_8601#Durations

autoDeleteOnIdle?: string

属性值

string

availabilityStatus

消息传送实体的可用性状态。

availabilityStatus?: EntityAvailabilityStatus

属性值

defaultMessageTimeToLive

确定消息在关联订阅中的生存时间。 除非订阅使用较小的 TTL 显式创建,否则订阅将从主题继承 TTL。 根据是否启用死信,其 TTL 已过期的消息将移动到订阅的关联死信子队列,或者将被永久删除。 这是以 ISO-8601 持续时间格式(例如 1 分钟为“PT1M”)指定的,“PT5S”为 5 秒。

ISO-8601 持续时间格式的详细信息:https://en.wikipedia.org/wiki/ISO_8601#Durations

defaultMessageTimeToLive?: string

属性值

string

duplicateDetectionHistoryTimeWindow

指定服务总线将检测消息重复的时间跨度。 这是以 ISO-8601 持续时间格式(例如 1 分钟为“PT1M”)指定的,“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

发送到本主题的消息的最大消息大小(以 KB 为单位)。

(仅适用于高级层服务总线命名空间。)

maxMessageSizeInKilobytes?: number

属性值

number

maxSizeInMegabytes

指定最大主题大小(以 MB 为单位)。 任何尝试排队导致主题超过此值的消息都将失败。 主题中存储的所有消息或其任何订阅都计入此值。 驻留在一个或多个订阅中的消息的多个副本计为单个消息。 例如,如果订阅 s1 中存在一次消息 m,订阅 s2 中存在两次消息,则 m 计数为单个消息。

maxSizeInMegabytes?: number

属性值

number

requiresDuplicateDetection

如果启用,主题将在 DuplicateDetectionHistoryTimeWindow 属性指定的时间范围内检测重复消息。 仅在创建主题时设置。

requiresDuplicateDetection?: boolean

属性值

boolean

status

消息传送实体的状态。

status?: EntityStatus

属性值

supportOrdering

指定主题是否支持消息排序。

supportOrdering?: boolean

属性值

boolean

userMetadata

用户提供了与主题关联的元数据信息。 用于指定文本内容,例如标记、标签等。值不得超过以 utf-8 编码的 1024 字节。

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