你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
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 |
如果启用并且消息过期，服务总线会将消息从队列移到订阅的死信子队列中。 如果禁用，消息将从订阅的主队列中永久删除。 只可以在创建订阅时设置。 |
| default |
确定消息在订阅中的存在时间长度。 根据是否启用死信，TTL 已过期的消息将移动到订阅的关联 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 |
默认锁定持续时间将应用于未定义锁定持续时间的订阅。 (如果启用了会话，则此锁定持续时间适用于会话，不适用于 messages。) 这是以 ISO-8601 持续时间格式指定的，例如“PT1M”1 分钟，“PT5S”指定 5 秒。 有关 ISO-8601 持续时间格式的详细信息： https://en.wikipedia.org/wiki/ISO_8601#Durations |
| max |
消息的最大传递计数，如果消息仍未解决，则会移动到死信子队列。 |
| requires |
如果设置为 true，则订阅将是会话感知订阅，并且仅支持 SessionReceiver。 通过 REST 不支持会话感知订阅。 只可以在创建订阅时设置。 |
| status | 消息传送实体的状态。 |
| user |
用户提供了与订阅关联的元数据信息。 用于指定文本内容，如标记、标签等。值不得超过以 utf-8 编码的 1024 字节。 |
继承属性
| 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
deadLetteringOnFilterEvaluationExceptions
确定服务总线如何处理在订阅的筛选器评估期间导致异常的消息。 如果该值设置为 true，则导致异常的消息将移到订阅的死信子队列中。 否则，将放弃它。 默认情况下，此参数设置为 true，使用户有机会调查异常的原因。 消息的格式错误或者在筛选器中对于消息的格式进行了一些不正确的假设，都会导致异常。 只可以在创建主题时设置。
deadLetteringOnFilterEvaluationExceptions?: boolean属性值
boolean
deadLetteringOnMessageExpiration
如果启用并且消息过期，服务总线会将消息从队列移到订阅的死信子队列中。 如果禁用，消息将从订阅的主队列中永久删除。 只可以在创建订阅时设置。
deadLetteringOnMessageExpiration?: boolean属性值
boolean
defaultMessageTimeToLive
确定消息在订阅中的存在时间长度。 根据是否启用死信，TTL 已过期的消息将移动到订阅的关联 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
默认锁定持续时间将应用于未定义锁定持续时间的订阅。 (如果启用了会话，则此锁定持续时间适用于会话，不适用于 messages。)
这是以 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
userMetadata
用户提供了与订阅关联的元数据信息。 用于指定文本内容，如标记、标签等。值不得超过以 utf-8 编码的 1024 字节。
userMetadata?: string属性值
string
继承属性详细信息
abortSignal
onResponse
在执行请求的操作时，每次从服务器收到响应时要调用的函数。 可以多次调用。
onResponse?: RawResponseCallback属性值
requestOptions
创建和发送此操作的 HTTP 请求时使用的选项。
requestOptions?: OperationRequestOptions属性值
serializerOptions
用于替代序列化/反序列化行为的选项。
serializerOptions?: SerializerOptions属性值
tracingOptions
启用跟踪时使用的选项。
tracingOptions?: OperationTracingOptions