Share via


SbSubscriptionProperties Class

Definition

Description of Subscription Resource.

[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.DoNotFormat]
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.SbSubscriptionPropertiesTypeConverter))]
public class SbSubscriptionProperties : Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.ISbSubscriptionProperties
[<Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.DoNotFormat>]
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.SbSubscriptionPropertiesTypeConverter))>]
type SbSubscriptionProperties = class
    interface ISbSubscriptionProperties
    interface IJsonSerializable
Public Class SbSubscriptionProperties
Implements ISbSubscriptionProperties
Inheritance
SbSubscriptionProperties
Attributes
Implements

Constructors

SbSubscriptionProperties()

Creates an new SbSubscriptionProperties instance.

Properties

AccessedAt

Last time there was a receive request to this subscription.

AutoDeleteOnIdle

ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.

ClientAffinePropertyClientId

Indicates the Client ID of the application that created the client-affine subscription.

ClientAffinePropertyIsDurable

For client-affine subscriptions, this value indicates whether the subscription is durable or not.

ClientAffinePropertyIsShared

For client-affine subscriptions, this value indicates whether the subscription is shared or not.

CountDetailActiveMessageCount

Number of active messages in the queue, topic, or subscription.

CountDetailDeadLetterMessageCount

Number of messages that are dead lettered.

CountDetailScheduledMessageCount

Number of scheduled messages.

CountDetailTransferDeadLetterMessageCount

Number of messages transferred into dead letters.

CountDetailTransferMessageCount

Number of messages transferred to another queue, topic, or subscription.

CreatedAt

Exact time the message was created.

DeadLetteringOnFilterEvaluationException

Value that indicates whether a subscription has dead letter support on filter evaluation exceptions.

DeadLetteringOnMessageExpiration

Value that indicates whether a subscription has dead letter support when a message expires.

DefaultMessageTimeToLive

ISO 8061 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.

DuplicateDetectionHistoryTimeWindow

ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.

EnableBatchedOperations

Value that indicates whether server-side batched operations are enabled.

ForwardDeadLetteredMessagesTo

Queue/Topic name to forward the Dead Letter message

ForwardTo

Queue/Topic name to forward the messages

IsClientAffine

Value that indicates whether the subscription has an affinity to the client id.

LockDuration

ISO 8061 lock duration timespan for the subscription. The default value is 1 minute.

MaxDeliveryCount

Number of maximum deliveries.

MessageCount

Number of messages.

RequiresSession

Value indicating if a subscription supports the concept of sessions.

Status

Enumerates the possible values for the status of a messaging entity.

UpdatedAt

The exact time the message was updated.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of SbSubscriptionProperties.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of SbSubscriptionProperties.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.ISbSubscriptionProperties.

FromJsonString(String)

Creates a new instance of SbSubscriptionProperties, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of SbSubscriptionProperties into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()

Applies to