AzureServiceBusQueueResource Class

Reference

Definition

Namespace:: Aspire.Hosting.Azure

Assembly:: Aspire.Hosting.Azure.ServiceBus.dll

Package:: Aspire.Hosting.Azure.ServiceBus v9.1.0

Source:: AzureServiceBusQueueResource.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents a Service Bus Queue.

public class AzureServiceBusQueueResource : Aspire.Hosting.ApplicationModel.Resource, Aspire.Hosting.ApplicationModel.IResourceWithConnectionString, Aspire.Hosting.ApplicationModel.IResourceWithParent<Aspire.Hosting.Azure.AzureServiceBusResource>, Aspire.Hosting.Azure.IResourceWithAzureFunctionsConfig

type AzureServiceBusQueueResource = class
    inherit Resource
    interface IResourceWithParent<AzureServiceBusResource>
    interface IResourceWithParent
    interface IResource
    interface IResourceWithConnectionString
    interface IManifestExpressionProvider
    interface IValueProvider
    interface IValueWithReferences
    interface IResourceWithAzureFunctionsConfig

Public Class AzureServiceBusQueueResource
Inherits Resource
Implements IResourceWithAzureFunctionsConfig, IResourceWithConnectionString, IResourceWithParent(Of AzureServiceBusResource)

Inheritance: Object

Resource
AzureServiceBusQueueResource

Implements: IManifestExpressionProvider IResource IResourceWithConnectionString IResourceWithParent IResourceWithParent<AzureServiceBusResource> IValueProvider IValueWithReferences IResourceWithAzureFunctionsConfig

Remarks

Use ConfigureInfrastructure<T>(IResourceBuilder<T>, Action<AzureResourceInfrastructure>) to configure specific Aspire.Hosting.Azure.Provisioning properties.

Constructors

AzureServiceBusQueueResource(String, String, AzureServiceBusResource)

Initializes a new instance of the AzureServiceBusQueueResource class.

Properties

Annotations	Gets the annotations associated with the resource. (Inherited from Resource)
ConnectionStringExpression	Gets the connection string expression for the Azure Service Bus Queue.
DeadLetteringOnMessageExpiration	A value that indicates whether this queue has dead letter support when a message expires.
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	ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
ForwardDeadLetteredMessagesTo	Queue/Topic name to forward the Dead Letter message.
ForwardTo	Queue/Topic name to forward the messages.
LockDuration	ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.
MaxDeliveryCount	The maximum delivery count. A message is automatically dead-lettered after this number of deliveries.
Name	Gets the name of the resource. (Inherited from Resource)
Parent	Gets the parent Azure Service Bus resource.
QueueName	The queue name.
RequiresDuplicateDetection	A value indicating if this queue requires duplicate detection.
RequiresSession	A value that indicates whether the queue supports the concept of sessions.

Explicit Interface Implementations

IResourceWithAzureFunctionsConfig.ApplyAzureFunctionsConfiguration(IDictionary<String,Object>, String)

Extension Methods

GetReplicaCount(IResource)	Gets the number of replicas for the specified resource. Defaults to `1` if no ReplicaAnnotation is found.
HasAnnotationIncludingAncestorsOfType<T>(IResource)	Gets whether `resource` or its ancestors have an annotation of type `T`
HasAnnotationOfType<T>(IResource)	Gets whether `resource` has an annotation of type `T`
TryGetAnnotationsIncludingAncestorsOfType<T>(IResource, IEnumerable<T>)	Attempts to retrieve all annotations of the specified type from the given resource including from parents.
TryGetAnnotationsOfType<T>(IResource, IEnumerable<T>)	Attempts to retrieve all annotations of the specified type from the given resource.
TryGetContainerImageName(IResource, String)	Attempts to get the container image name from the given resource.
TryGetContainerMounts(IResource, IEnumerable<ContainerMountAnnotation>)	Attempts to get the container mounts for the specified resource.
TryGetEndpoints(IResource, IEnumerable<EndpointAnnotation>)	Attempts to retrieve the endpoints for the given resource.
TryGetEnvironmentVariables(IResource, IEnumerable<EnvironmentCallbackAnnotation>)	Attempts to get the environment variables from the given resource.
TryGetLastAnnotation<T>(IResource, T)	Attempts to get the last annotation of the specified type from the resource.
IsContainer(IResource)	Determines whether the specified resource is a container resource.
IsExisting(IResource)	Determines if the resource is an existing resource.

Applies to

Share via