SBSubscription interface

Package:

@azure/arm-servicebus

Description of subscription resource.

Extends

ProxyResource

Properties

accessedAt	Last time there was a receive request to this subscription. NOTE: This property will not be serialized. It can only be populated by the server.
autoDeleteOnIdle	ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
clientAffineProperties	Properties specific to client affine subscriptions.
countDetails	Message count details NOTE: This property will not be serialized. It can only be populated by the server.
createdAt	Exact time the message was created. NOTE: This property will not be serialized. It can only be populated by the server.
deadLetteringOnFilterEvaluationExceptions	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. NOTE: This property will not be serialized. It can only be populated by the server.
requiresSession	Value indicating if a subscription supports the concept of sessions.
status	Enumerates the possible values for the status of a messaging entity.
systemData	The system meta data relating to this resource. NOTE: This property will not be serialized. It can only be populated by the server.
updatedAt	The exact time the message was updated. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
location	The geo-location where the resource lives NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

accessedAt

Last time there was a receive request to this subscription. NOTE: This property will not be serialized. It can only be populated by the server.

accessedAt?: Date

Property Value

Date

autoDeleteOnIdle

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

autoDeleteOnIdle?: string

Property Value

string

clientAffineProperties

Properties specific to client affine subscriptions.

clientAffineProperties?: SBClientAffineProperties

Property Value

SBClientAffineProperties

countDetails

Message count details NOTE: This property will not be serialized. It can only be populated by the server.

countDetails?: MessageCountDetails

Property Value

MessageCountDetails

createdAt

Exact time the message was created. NOTE: This property will not be serialized. It can only be populated by the server.

createdAt?: Date

Property Value

Date

deadLetteringOnFilterEvaluationExceptions

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

deadLetteringOnFilterEvaluationExceptions?: boolean

Property Value

boolean

deadLetteringOnMessageExpiration

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

deadLetteringOnMessageExpiration?: boolean

Property Value

boolean

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.

defaultMessageTimeToLive?: string

Property Value

string

duplicateDetectionHistoryTimeWindow

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

duplicateDetectionHistoryTimeWindow?: string

Property Value

string

enableBatchedOperations

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

enableBatchedOperations?: boolean

Property Value

boolean

forwardDeadLetteredMessagesTo

Queue/Topic name to forward the Dead Letter message

forwardDeadLetteredMessagesTo?: string

Property Value

string

forwardTo

Queue/Topic name to forward the messages

forwardTo?: string

Property Value

string

isClientAffine

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

isClientAffine?: boolean

Property Value

boolean

lockDuration

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

lockDuration?: string

Property Value

string

maxDeliveryCount

Number of maximum deliveries.

maxDeliveryCount?: number

Property Value

number

messageCount

Number of messages. NOTE: This property will not be serialized. It can only be populated by the server.

messageCount?: number

Property Value

number

requiresSession

Value indicating if a subscription supports the concept of sessions.

requiresSession?: boolean

Property Value

boolean

status

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

status?: EntityStatus

Property Value

EntityStatus

systemData

The system meta data relating to this resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

updatedAt

The exact time the message was updated. NOTE: This property will not be serialized. It can only be populated by the server.

updatedAt?: Date

Property Value

Date

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

location

The geo-location where the resource lives NOTE: This property will not be serialized. It can only be populated by the server.

location?: string

Property Value

string

Inherited From ProxyResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type