SbTopicProperties Class

  • Reference

Definition

Namespace:
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models
Assembly:
Az.ServiceBus.private.dll

The Topic Properties definition.

[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.DoNotFormat]
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.SbTopicPropertiesTypeConverter))]
public class SbTopicProperties : Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.ISbTopicProperties
[<Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.DoNotFormat>]
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.SbTopicPropertiesTypeConverter))>]
type SbTopicProperties = class
    interface ISbTopicProperties
    interface IJsonSerializable
Public Class SbTopicProperties
Implements ISbTopicProperties
Inheritance
Object
SbTopicProperties
Attributes
DoNotFormatAttribute TypeConverterAttribute
Implements
ISbTopicProperties IJsonSerializable

Constructors

SbTopicProperties()

Creates an new SbTopicProperties instance.

Properties

AccessedAt

Last time the message was sent, or a request was received, for this topic.
AutoDeleteOnIdle

ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
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.
DefaultMessageTimeToLive

ISO 8601 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

ISO8601 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.
EnableExpress

Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
EnablePartitioning

Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.
MaxMessageSizeInKilobytes

Maximum size (in KB) of the message payload that can be accepted by the topic. This property is only used in Premium today and default is 1024.
MaxSizeInMegabytes

Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.
RequiresDuplicateDetection

Value indicating if this topic requires duplicate detection.
SizeInByte

Size of the topic, in bytes.
Status

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

Number of subscriptions.
SupportOrdering

Value that indicates whether the topic supports ordering.
UpdatedAt

The exact time the message was updated.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of SbTopicProperties.
DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of SbTopicProperties.
FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.ISbTopicProperties.
FromJsonString(String)

Creates a new instance of SbTopicProperties, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)

Serializes this instance of SbTopicProperties into a JsonNode.
ToJsonString()

Serializes this instance to a json string.
ToString()

Applies to