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

SBSubscription interface

包:

@azure/arm-servicebus

订阅资源的说明。

扩展

ProxyResource

属性

accessedAt	上次收到此订阅的接收请求的时间。 注意：此属性不会被序列化。 它只能由服务器填充。
autoDeleteOnIdle	ISO 8061 timeSpan 空闲间隔之后，主题将自动删除。 最短持续时间为 5 分钟。
clientAffineProperties	特定于客户端仿射订阅的属性。
countDetails	消息计数详细信息 注意：此属性不会被序列化。 它只能由服务器填充。
createdAt	消息的确切创建时间。 注意：此属性不会被序列化。 它只能由服务器填充。
deadLetteringOnFilterEvaluationExceptions	指示订阅是否支持筛选器评估异常的死信的值。
deadLetteringOnMessageExpiration	指示消息过期时订阅是否支持死信的值。
defaultMessageTimeToLive	ISO 8061 默认消息时间跨度到实时值。 这是消息过期的持续时间，从消息发送到服务总线时开始。 这是未在消息本身上设置 TimeToLive 时使用的默认值。
duplicateDetectionHistoryTimeWindow	ISO 8601 timeSpan 结构，用于定义重复检测历史记录的持续时间。 默认值为 10 分钟。
enableBatchedOperations	指示是否启用服务器端批处理操作的值。
forwardDeadLetteredMessagesTo	用于转发死信消息的队列/主题名称
forwardTo	用于转发消息的队列/主题名称
isClientAffine	指示订阅是否与客户端 ID 关联的值。
lockDuration	订阅的 ISO 8061 锁定持续时间时间跨度。 默认值为 1 分钟。
maxDeliveryCount	最大传递数。
messageCount	消息数。 注意：此属性不会被序列化。 它只能由服务器填充。
requiresSession	指示订阅是否支持会话概念的值。
status	枚举消息实体状态的可能值。
systemData	与此资源相关的系统元数据。 注意：此属性不会被序列化。 它只能由服务器填充。
updatedAt	消息的确切更新时间。 注意：此属性不会被序列化。 它只能由服务器填充。

继承属性

id	资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意：此属性不会被序列化。 它只能由服务器填充。
location	资源所在的地理位置 注意：此属性不会被序列化。 它只能由服务器填充。
name	资源的名称 注意：此属性不会被序列化。 它只能由服务器填充。
type	资源类型。 例如，“Microsoft.EventHub/Namespaces”或“Microsoft.EventHub/Namespaces/EventHubs”注意：此属性不会被序列化。 它只能由服务器填充。

属性详细信息

accessedAt

上次收到此订阅的接收请求的时间。 注意：此属性不会被序列化。 它只能由服务器填充。

accessedAt?: Date

属性值

Date

autoDeleteOnIdle

ISO 8061 timeSpan 空闲间隔之后，主题将自动删除。 最短持续时间为 5 分钟。

autoDeleteOnIdle?: string

属性值

string

clientAffineProperties

特定于客户端仿射订阅的属性。

clientAffineProperties?: SBClientAffineProperties

属性值

SBClientAffineProperties

countDetails

消息计数详细信息 注意：此属性不会被序列化。 它只能由服务器填充。

countDetails?: MessageCountDetails

属性值

MessageCountDetails

createdAt

消息的确切创建时间。 注意：此属性不会被序列化。 它只能由服务器填充。

createdAt?: Date

属性值

Date

deadLetteringOnFilterEvaluationExceptions

指示订阅是否支持筛选器评估异常的死信的值。

deadLetteringOnFilterEvaluationExceptions?: boolean

属性值

boolean

deadLetteringOnMessageExpiration

指示消息过期时订阅是否支持死信的值。

deadLetteringOnMessageExpiration?: boolean

属性值

boolean

defaultMessageTimeToLive

ISO 8061 默认消息时间跨度到实时值。 这是消息过期的持续时间，从消息发送到服务总线时开始。 这是未在消息本身上设置 TimeToLive 时使用的默认值。

defaultMessageTimeToLive?: string

属性值

string

duplicateDetectionHistoryTimeWindow

ISO 8601 timeSpan 结构，用于定义重复检测历史记录的持续时间。 默认值为 10 分钟。

duplicateDetectionHistoryTimeWindow?: string

属性值

string

enableBatchedOperations

指示是否启用服务器端批处理操作的值。

enableBatchedOperations?: boolean

属性值

boolean

forwardDeadLetteredMessagesTo

用于转发死信消息的队列/主题名称

forwardDeadLetteredMessagesTo?: string

属性值

string

forwardTo

用于转发消息的队列/主题名称

forwardTo?: string

属性值

string

isClientAffine

指示订阅是否与客户端 ID 关联的值。

isClientAffine?: boolean

属性值

boolean

lockDuration

订阅的 ISO 8061 锁定持续时间时间跨度。 默认值为 1 分钟。

lockDuration?: string

属性值

string

maxDeliveryCount

最大传递数。

maxDeliveryCount?: number

属性值

number

messageCount

消息数。 注意：此属性不会被序列化。 它只能由服务器填充。

messageCount?: number

属性值

number

requiresSession

指示订阅是否支持会话概念的值。

requiresSession?: boolean

属性值

boolean

status

枚举消息实体状态的可能值。

status?: EntityStatus

属性值

EntityStatus

systemData

与此资源相关的系统元数据。 注意：此属性不会被序列化。 它只能由服务器填充。

systemData?: SystemData

属性值

SystemData

updatedAt

消息的确切更新时间。 注意：此属性不会被序列化。 它只能由服务器填充。

updatedAt?: Date

属性值

Date

继承属性详细信息

id

资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意：此属性不会被序列化。 它只能由服务器填充。

id?: string

属性值

string

继承自ProxyResource.id

location

资源所在的地理位置 注意：此属性不会被序列化。 它只能由服务器填充。

location?: string

属性值

string

继承自ProxyResource.location

name

资源的名称 注意：此属性不会被序列化。 它只能由服务器填充。

name?: string

属性值

string

继承自ProxyResource.name

type

资源类型。 例如，“Microsoft.EventHub/Namespaces”或“Microsoft.EventHub/Namespaces/EventHubs”注意：此属性不会被序列化。 它只能由服务器填充。

type?: string

属性值

string

继承自ProxyResource.type