Share via


CreateSubscriptionOptions Class

Definition

Represents the metadata description of the subscription.

public class CreateSubscriptionOptions : IEquatable<Azure.Messaging.ServiceBus.Administration.CreateSubscriptionOptions>
type CreateSubscriptionOptions = class
    interface IEquatable<CreateSubscriptionOptions>
Public Class CreateSubscriptionOptions
Implements IEquatable(Of CreateSubscriptionOptions)
Inheritance
CreateSubscriptionOptions
Implements

Constructors

CreateSubscriptionOptions(String, String)

Initializes a new instance of SubscriptionDescription class with the specified name and topic name.

CreateSubscriptionOptions(SubscriptionProperties)

Initializes a new instance of CreateSubscriptionOptions based on the specified SubscriptionProperties instance. This is useful for creating a new subscription based on the properties of an existing subscription.

Properties

AutoDeleteOnIdle

The TimeSpan idle interval after which the subscription is automatically deleted.

DeadLetteringOnMessageExpiration

Indicates whether this subscription has dead letter support when a message expires.

DefaultMessageTimeToLive

The default time to live value for the messages. This is the duration after which the message expires, starting from when the message is sent to Service Bus.

EnableBatchedOperations

Indicates whether server-side batched operations are enabled.

EnableDeadLetteringOnFilterEvaluationExceptions

indicates whether messages need to be forwarded to dead-letter sub queue when subscription rule evaluation fails.

ForwardDeadLetteredMessagesTo

The name of the recipient entity to which all the dead-lettered messages of this subscription are forwarded to.

ForwardTo

The name of the recipient entity to which all the messages sent to the subscription are forwarded to.

LockDuration

Duration of a peek lock receive. i.e., the amount of time that the message is locked by a given receiver so that no other receiver receives the same message.

MaxDeliveryCount

The maximum delivery count of a message before it is dead-lettered.

RequiresSession

This indicates whether the subscription supports the concept of session. Sessionful-messages follow FIFO ordering.

Status

The current status of the subscription (Enabled / Disabled).

SubscriptionName

Name of the subscription.

TopicName

Name of the topic under which subscription exists.

UserMetadata

Custom metadata that user can associate with the subscription.

Methods

Equals(CreateSubscriptionOptions)

Determines whether the specified object is equal to the current object.

Equals(Object)

Determines whether the specified object is equal to the current object.

GetHashCode()

Returns a hash code for this instance.

Operators

Equality(CreateSubscriptionOptions, CreateSubscriptionOptions)
Inequality(CreateSubscriptionOptions, CreateSubscriptionOptions)

Applies to