Share via


ServiceBusTopic Class

Definition

ServiceBusTopic.

public class ServiceBusTopic : Azure.Provisioning.Primitives.ProvisionableResource
public class ServiceBusTopic : Azure.Provisioning.Primitives.Resource
type ServiceBusTopic = class
    inherit ProvisionableResource
type ServiceBusTopic = class
    inherit Resource
Public Class ServiceBusTopic
Inherits ProvisionableResource
Public Class ServiceBusTopic
Inherits Resource
Inheritance
Inheritance

Constructors

ServiceBusTopic(String, String)

Creates a new ServiceBusTopic.

Properties

AccessedOn

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.

BicepIdentifier

Gets or sets the the Bicep identifier name of the resource. This can be used to refer to the resource in expressions, but is not the Azure name of the resource. This value can contain letters, numbers, and underscores.

(Inherited from NamedProvisionableConstruct)
CountDetails

Message count details.

CreatedOn

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.

DependsOn

Declares explicit dependencies on other resources.

(Inherited from ProvisionableResource)
DependsOn

Declares explicit dependencies on other resources.

(Inherited from Resource)
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.

Id

Gets the Id.

IdentifierName

Gets or sets the the Bicep identifier name of the resource. This can be used to refer to the resource in expressions, but is not the Azure name of the resource. This value can contain letters, numbers, and underscores.

(Inherited from NamedProvisioningConstruct)
IsExistingResource

Gets whether this is referencing an existing resource or we're defining a new resource.

(Inherited from ProvisionableResource)
IsExistingResource

Gets whether this is referencing an existing resource or we're defining a new resource.

(Inherited from Resource)
Location

The geo-location where the resource lives.

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.

Name

The topic name.

Parent

Gets or sets a reference to the parent ServiceBusNamespace.

RequiresDuplicateDetection

Value indicating if this topic requires duplicate detection.

ResourceType

Gets the type of the resource.

(Inherited from ProvisionableResource)
ResourceType

Gets the type of the resource.

(Inherited from Resource)
ResourceVersion

Gets or sets the version of the resource.

(Inherited from ProvisionableResource)
ResourceVersion

Gets or sets the version of the resource.

(Inherited from Resource)
SizeInBytes

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.

SystemData

Gets the SystemData.

UpdatedOn

The exact time the message was updated.

Methods

AssignOrReplace<T>(T, T) (Inherited from ProvisionableConstruct)
Build(ProvisioningBuildOptions)

Compose the resource into a provisioning plan that can be saved as Bicep or deployed directly.

(Inherited from ProvisionableResource)
Build(ProvisioningContext)

Compose the resource into a provisioning plan that can be saved as Bicep or deployed directly.

(Inherited from Resource)
Compile()

Compile the resource into a set of Bicep statements.

(Inherited from ProvisionableResource)
Compile()

Compile the resource into a set of Bicep statements.

(Inherited from Resource)
DefineDictionaryProperty<T>(String, String[], Boolean, Boolean) (Inherited from ProvisionableConstruct)
DefineListProperty<T>(String, String[], Boolean, Boolean) (Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], Boolean, Boolean, Boolean, String) (Inherited from ProvisionableConstruct)
DefineProperty<T>(String, String[], Boolean, Boolean, Boolean, BicepValue<T>, String) (Inherited from ProvisionableConstruct)
DefineProvisionableProperties()

Define all the provisionable properties of ServiceBusTopic.

DefineResource<T>(String, String[], Boolean, Boolean, T) (Inherited from ProvisionableResource)
FromExisting(String, String)

Creates a reference to an existing ServiceBusTopic.

GetProvisionableResources()

Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure.

(Inherited from Provisionable)
GetResources()

Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure.

(Inherited from Provisionable)
Initialize()

Initialize this construct.

(Inherited from ProvisionableConstruct)
OverrideWithExpression(BicepExpression) (Inherited from ProvisionableConstruct)
OverrideWithExpression(Expression)

Set this construct to represent the result of an expression. This is primarily meant to be called via FromExpression static methods on specific resources or constructs.

(Inherited from ProvisioningConstruct)
Resolve(ProvisioningBuildOptions)

Resolve any resources or properties that were not explicitly specified.

(Inherited from ProvisionableConstruct)
Resolve(ProvisioningBuildOptions)

Resolve any resources or properties that were not explicitly specified.

(Inherited from Provisionable)
Resolve(ProvisioningContext)

Resolve any resources or properties that were not explicitly specified.

(Inherited from Provisionable)
Resolve(ProvisioningContext)

Resolve any resources or properties that were not explicitly specified.

(Inherited from ProvisioningConstruct)
Validate(ProvisioningBuildOptions)

Validate the presence of any required members.

(Inherited from ProvisionableResource)
Validate(ProvisioningBuildOptions)

Validate the presence of any required members.

(Inherited from Provisionable)
Validate(ProvisioningContext)

Validate the presence of any required members.

(Inherited from Provisionable)
Validate(ProvisioningContext)

Validate the presence of any required members.

(Inherited from Resource)

Explicit Interface Implementations

IBicepValue.Assign(IBicepValue)

Assign a value to this property.

(Inherited from ProvisionableConstruct)
IBicepValue.Compile()

Compile this value to a Bicep expression.

(Inherited from ProvisionableConstruct)
IBicepValue.Expression

Gets the expression for this value if it's not a literal.

(Inherited from ProvisionableConstruct)
IBicepValue.IsEmpty

Gets whether this value is unset or empty.

(Inherited from ProvisionableConstruct)
IBicepValue.IsOutput

Tracks whether this is an output only property.

(Inherited from ProvisionableConstruct)
IBicepValue.IsRequired

Tracks whether this property is required.

(Inherited from ProvisionableConstruct)
IBicepValue.IsSecure

Tracks whether this contains a secure value.

(Inherited from ProvisionableConstruct)
IBicepValue.Kind

Gets the kind of this value (a literal value, an expression, or it's unset).

(Inherited from ProvisionableConstruct)
IBicepValue.LiteralValue

Get the value of this expression, if it's literal.

(Inherited from ProvisionableConstruct)
IBicepValue.Self

Gets information about where this value was defined.

(Inherited from ProvisionableConstruct)
IBicepValue.SetReadOnly()

Make this value readonly.

(Inherited from ProvisionableConstruct)
IBicepValue.Source

Gets information about where this value was assigned from.

(Inherited from ProvisionableConstruct)

Applies to