Watch Aspire live streamsDocsTry Aspire

ServiceBusQueueProxy

Handle
📦 Aspire.Hosting.Azure.Provisioning.ServiceBus v13.6.0-preview.1.26478.8
interface ServiceBusQueueProxy {
readonly accessedOn: BicepValueProxy | datetimeoffset;
autoDeleteOnIdle: BicepValueProxy | timespan;
readonly countDetails: MessageCountDetailsProxy;
readonly createdOn: BicepValueProxy | datetimeoffset;
deadLetteringOnMessageExpiration: BicepValueProxy | boolean;
defaultMessageTimeToLive: BicepValueProxy | timespan;
duplicateDetectionHistoryTimeWindow: BicepValueProxy | timespan;
enableBatchedOperations: BicepValueProxy | boolean;
enableExpress: BicepValueProxy | boolean;
enablePartitioning: BicepValueProxy | boolean;
forwardDeadLetteredMessagesTo: BicepValueProxy | string;
forwardTo: BicepValueProxy | string;
readonly id: BicepValueProxy;
readonly location: BicepValueProxy;
lockDuration: BicepValueProxy | timespan;
maxDeliveryCount: BicepValueProxy | number;
maxMessageSizeInKilobytes: BicepValueProxy | number;
maxSizeInMegabytes: BicepValueProxy | number;
readonly messageCount: BicepValueProxy | number;
name: BicepValueProxy | string;
parent: ServiceBusNamespaceProxy;
requiresDuplicateDetection: BicepValueProxy | boolean;
requiresSession: BicepValueProxy | boolean;
readonly sizeInBytes: BicepValueProxy | number;
status: BicepValueProxy | ServiceBusMessagingEntityStatus;
readonly systemData: ServiceBusSystemDataProxy;
readonly updatedOn: BicepValueProxy | datetimeoffset;
addTo(infrastructure: AzureResourceInfrastructure): void;
clearAutoDeleteOnIdle(): void;
clearDeadLetteringOnMessageExpiration(): void;
clearDefaultMessageTimeToLive(): void;
clearDuplicateDetectionHistoryTimeWindow(): void;
clearEnableBatchedOperations(): void;
clearEnableExpress(): void;
clearEnablePartitioning(): void;
clearForwardDeadLetteredMessagesTo(): void;
clearForwardTo(): void;
clearLockDuration(): void;
clearMaxDeliveryCount(): void;
clearMaxMessageSizeInKilobytes(): void;
clearMaxSizeInMegabytes(): void;
clearName(): void;
clearRequiresDuplicateDetection(): void;
clearRequiresSession(): void;
clearStatus(): void;
}

Properties

propertyaccessedOnBicepValueProxy | datetimeoffsetget
Gets the AccessedOn provisioning property.
propertyautoDeleteOnIdleBicepValueProxy | timespanget · set
Gets or sets the AutoDeleteOnIdle provisioning property.
propertycountDetailsMessageCountDetailsProxyget
Gets the CountDetails provisioning property.
propertycreatedOnBicepValueProxy | datetimeoffsetget
Gets the CreatedOn provisioning property.
propertydeadLetteringOnMessageExpirationBicepValueProxy | booleanget · set
Gets or sets the DeadLetteringOnMessageExpiration provisioning property.
propertydefaultMessageTimeToLiveBicepValueProxy | timespanget · set
Gets or sets the DefaultMessageTimeToLive provisioning property.
propertyduplicateDetectionHistoryTimeWindowBicepValueProxy | timespanget · set
Gets or sets the DuplicateDetectionHistoryTimeWindow provisioning property.
propertyenableBatchedOperationsBicepValueProxy | booleanget · set
Gets or sets the EnableBatchedOperations provisioning property.
propertyenableExpressBicepValueProxy | booleanget · set
Gets or sets the EnableExpress provisioning property.
propertyenablePartitioningBicepValueProxy | booleanget · set
Gets or sets the EnablePartitioning provisioning property.
propertyforwardDeadLetteredMessagesToBicepValueProxy | stringget · set
Gets or sets the ForwardDeadLetteredMessagesTo provisioning property.
propertyforwardToBicepValueProxy | stringget · set
Gets or sets the ForwardTo provisioning property.
propertyidBicepValueProxyget
Gets the Id provisioning property.
propertylocationBicepValueProxyget
Gets the Location provisioning property.
propertylockDurationBicepValueProxy | timespanget · set
Gets or sets the LockDuration provisioning property.
propertymaxDeliveryCountBicepValueProxy | numberget · set
Gets or sets the MaxDeliveryCount provisioning property.
propertymaxMessageSizeInKilobytesBicepValueProxy | numberget · set
Gets or sets the MaxMessageSizeInKilobytes provisioning property.
propertymaxSizeInMegabytesBicepValueProxy | numberget · set
Gets or sets the MaxSizeInMegabytes provisioning property.
propertymessageCountBicepValueProxy | numberget
Gets the MessageCount provisioning property.
propertynameBicepValueProxy | stringget · set
Gets or sets the Name provisioning property.
propertyparentServiceBusNamespaceProxyget · set
Gets or sets the Parent provisioning property.
propertyrequiresDuplicateDetectionBicepValueProxy | booleanget · set
Gets or sets the RequiresDuplicateDetection provisioning property.
propertyrequiresSessionBicepValueProxy | booleanget · set
Gets or sets the RequiresSession provisioning property.
propertysizeInBytesBicepValueProxy | numberget
Gets the SizeInBytes provisioning property.
propertystatusBicepValueProxy | ServiceBusMessagingEntityStatusget · set
Gets or sets the Status provisioning property.
propertysystemDataServiceBusSystemDataProxyget
Gets the SystemData provisioning property.
propertyupdatedOnBicepValueProxy | datetimeoffsetget
Gets the UpdatedOn provisioning property.

Methods

methodaddTo
Adds this provisioning resource to the Azure resource infrastructure.
addTo(infrastructure: AzureResourceInfrastructure): void
infrastructureAzureResourceInfrastructure
Clears the AutoDeleteOnIdle provisioning property.
clearAutoDeleteOnIdle(): void
Clears the DeadLetteringOnMessageExpiration provisioning property.
clearDeadLetteringOnMessageExpiration(): void
Clears the DefaultMessageTimeToLive provisioning property.
clearDefaultMessageTimeToLive(): void
Clears the DuplicateDetectionHistoryTimeWindow provisioning property.
clearDuplicateDetectionHistoryTimeWindow(): void
Clears the EnableBatchedOperations provisioning property.
clearEnableBatchedOperations(): void
Clears the EnableExpress provisioning property.
clearEnableExpress(): void
Clears the EnablePartitioning provisioning property.
clearEnablePartitioning(): void
Clears the ForwardDeadLetteredMessagesTo provisioning property.
clearForwardDeadLetteredMessagesTo(): void
Clears the ForwardTo provisioning property.
clearForwardTo(): void
Clears the LockDuration provisioning property.
clearLockDuration(): void
Clears the MaxDeliveryCount provisioning property.
clearMaxDeliveryCount(): void
Clears the MaxMessageSizeInKilobytes provisioning property.
clearMaxMessageSizeInKilobytes(): void
Clears the MaxSizeInMegabytes provisioning property.
clearMaxSizeInMegabytes(): void
methodclearName
Clears the Name provisioning property.
clearName(): void
Clears the RequiresDuplicateDetection provisioning property.
clearRequiresDuplicateDetection(): void
Clears the RequiresSession provisioning property.
clearRequiresSession(): void
Clears the Status provisioning property.
clearStatus(): void