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

SubscriptionDescription 类

定义

表示订阅的说明。

[System.Runtime.Serialization.DataContract(Name="SubscriptionDescription", Namespace="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")]
public sealed class SubscriptionDescription : Microsoft.ServiceBus.Messaging.EntityDescription
[<System.Runtime.Serialization.DataContract(Name="SubscriptionDescription", Namespace="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")>]
type SubscriptionDescription = class
    inherit EntityDescription
Public NotInheritable Class SubscriptionDescription
Inherits EntityDescription
继承
SubscriptionDescription
属性

构造函数

SubscriptionDescription(String, String)

初始化 SubscriptionDescription 类的新实例。

字段

MessageTimeToLiveDefaultValue

消息生存时间默认值

属性

AccessedAt

获取上次收到此订阅的接收请求的时间。

AutoDeleteOnIdle

获取或设置 TimeSpan 自动删除订阅的空闲间隔。 最短持续时间为 5 分钟。

AvailabilityStatus

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

ClientAffineProperties

表示订阅的说明。

CreatedAt

获取消息的确切创建时间。

DefaultMessageTimeToLive

获取或设置默认消息生存时间值。 这是消息到期之前所要经过的持续时间,从向 Service Bus 发送该消息时算起。 这是未在消息本身上设置 时 TimeToLive 使用的默认值。早于 TimeToLive 值的消息将过期,不再保留在消息存储中。 订阅者将无法接收过期的消息。消息的 TimeToLive 值可以低于此处指定的值,但默认情况下,TimeToLive 设置为 MaxValue。 因此,此属性将成为应用于消息的默认生存时间值。

EnableBatchedOperations

获取或设置一个值,该值指示是否启用批处理操作。

EnableDeadLetteringOnFilterEvaluationExceptions

获取或设置值,该值指示订阅是否支持筛选器评估异常的死信。

EnableDeadLetteringOnMessageExpiration

获取或设置值,该值指示订阅在消息过期时是否支持死信。

ExtensionData

获取或设置包含额外数据的结构。

(继承自 EntityDescription)
ForwardDeadLetteredMessagesTo

获取或设置死信邮件转发到的收件人的路径。

ForwardTo

获取或设置邮件转发到的收件人的路径。

IsClientAffine

表示订阅的说明。

IsReadOnly

获取或设置一个值,该值指示实体说明是否为只读。

(继承自 EntityDescription)
LockDuration

获取或设置订阅的锁定持续时间时间跨度。

MaxDeliveryCount

获取或设置最大传递数。

MessageCount

获取消息数。

MessageCountDetails

获取有关订阅的消息详细信息。

Name

获取订阅说明的名称。

RequiresSession

获取或设置值,该值指示订阅是否支持会话的概念。

Status

获取或设置订阅的当前状态(启用或禁用)。 禁用实体时,该实体无法发送或接收消息。

TopicPath

获取此订阅说明所属的主题的路径。

UpdatedAt

获取消息已更新的确切时间。

UserMetadata

获取或设置用户元数据。

方法

ThrowIfReadOnly()

如果实体说明为只读,则引发异常。

(继承自 EntityDescription)

适用于