SbSubscription Class

Definition

Namespace:

Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models

Assembly:

Az.ServiceBus.private.dll

Description of subscription resource.

[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.DoNotFormat]
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.SbSubscriptionTypeConverter))]
public class SbSubscription : Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.ISbSubscription, Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Runtime.IValidates

[<Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.DoNotFormat>]
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.SbSubscriptionTypeConverter))>]
type SbSubscription = class
    interface ISbSubscription
    interface IJsonSerializable
    interface IProxyResource
    interface IValidates

Public Class SbSubscription
Implements ISbSubscription, IValidates

Inheritance

Object

SbSubscription

Attributes

DoNotFormatAttribute TypeConverterAttribute

Implements

IProxyResource ISbSubscription IJsonSerializable IValidates

Constructors

SbSubscription()

Creates an new SbSubscription 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.
ClientId	Indicates the Client ID of the application that created the client-affine subscription.
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
Id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
IsClientAffine	Value that indicates whether the subscription has an affinity to the client id.
IsDurable	For client-affine subscriptions, this value indicates whether the subscription is durable or not.
IsShared	For client-affine subscriptions, this value indicates whether the subscription is shared or not.
Location	The geo-location where the resource lives
LockDuration	ISO 8061 lock duration timespan for the subscription. The default value is 1 minute.
MaxDeliveryCount	Number of maximum deliveries.
MessageCount	Number of messages.
Name	The name of the resource
RequiresSession	Value indicating if a subscription supports the concept of sessions.
ResourceGroupName	Gets the resource group name
Status	Enumerates the possible values for the status of a messaging entity.
SystemDataCreatedAt	The timestamp of resource creation (UTC).
SystemDataCreatedBy	The identity that created the resource.
SystemDataCreatedByType	The type of identity that created the resource.
SystemDataLastModifiedAt	The type of identity that last modified the resource.
SystemDataLastModifiedBy	The identity that last modified the resource.
SystemDataLastModifiedByType	The type of identity that last modified the resource.
Type	The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
UpdatedAt	The exact time the message was updated.

Methods

DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of SbSubscription.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of SbSubscription.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.ISbSubscription.
FromJsonString(String)	Creates a new instance of SbSubscription, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of SbSubscription into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
ToString()
Validate(IEventListener)	Validates that this object meets the validation criteria.