Azure Native v2.89.1, Mar 2 25

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.servicebus.getQueue

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi

pulumi/pulumi-azure-native

Using getQueue

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getQueue(args: GetQueueArgs, opts?: InvokeOptions): Promise<GetQueueResult>
function getQueueOutput(args: GetQueueOutputArgs, opts?: InvokeOptions): Output<GetQueueResult>

def get_queue(namespace_name: Optional[str] = None,
              queue_name: Optional[str] = None,
              resource_group_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetQueueResult
def get_queue_output(namespace_name: Optional[pulumi.Input[str]] = None,
              queue_name: Optional[pulumi.Input[str]] = None,
              resource_group_name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetQueueResult]

func LookupQueue(ctx *Context, args *LookupQueueArgs, opts ...InvokeOption) (*LookupQueueResult, error)
func LookupQueueOutput(ctx *Context, args *LookupQueueOutputArgs, opts ...InvokeOption) LookupQueueResultOutput

> Note: This function is named LookupQueue in the Go SDK.

public static class GetQueue 
{
    public static Task<GetQueueResult> InvokeAsync(GetQueueArgs args, InvokeOptions? opts = null)
    public static Output<GetQueueResult> Invoke(GetQueueInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetQueueResult> getQueue(GetQueueArgs args, InvokeOptions options)
public static Output<GetQueueResult> getQueue(GetQueueArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:servicebus:getQueue
  arguments:
    # arguments dictionary

The following arguments are supported:

NamespaceName string: The namespace name
QueueName string: The queue name.
ResourceGroupName string: Name of the Resource group within the Azure subscription.

NamespaceName string: The namespace name
QueueName string: The queue name.
ResourceGroupName string: Name of the Resource group within the Azure subscription.

namespaceName String: The namespace name
queueName String: The queue name.
resourceGroupName String: Name of the Resource group within the Azure subscription.

namespaceName string: The namespace name
queueName string: The queue name.
resourceGroupName string: Name of the Resource group within the Azure subscription.

namespace_name str: The namespace name
queue_name str: The queue name.
resource_group_name str: Name of the Resource group within the Azure subscription.

namespaceName String: The namespace name
queueName String: The queue name.
resourceGroupName String: Name of the Resource group within the Azure subscription.

getQueue Result

The following output properties are available:

AccessedAt string: Last time a message was sent, or the last time there was a receive request to this queue.
CountDetails Pulumi.AzureNative.ServiceBus.Outputs.MessageCountDetailsResponse: Message Count Details.
CreatedAt string: The exact time the message was created.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string: The geo-location where the resource lives
MessageCount double: The number of messages in the queue.
Name string: The name of the resource
SizeInBytes double: The size of the queue, in bytes.
SystemData Pulumi.AzureNative.ServiceBus.Outputs.SystemDataResponse: The system meta data relating to this resource.
Type string: The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
UpdatedAt string: The exact time the message was updated.
AutoDeleteOnIdle string: ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.
DeadLetteringOnMessageExpiration bool: A value that indicates whether this queue has dead letter support when a message expires.
DefaultMessageTimeToLive string: 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 string: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
EnableBatchedOperations bool: Value that indicates whether server-side batched operations are enabled.
EnableExpress bool: A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.
EnablePartitioning bool: A value that indicates whether the queue is to be partitioned across multiple message brokers.
ForwardDeadLetteredMessagesTo string: Queue/Topic name to forward the Dead Letter message
ForwardTo string: Queue/Topic name to forward the messages
LockDuration string: 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 int: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.
MaxMessageSizeInKilobytes double: Maximum size (in KB) of the message payload that can be accepted by the queue. This property is only used in Premium today and default is 1024.
MaxSizeInMegabytes int: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.
RequiresDuplicateDetection bool: A value indicating if this queue requires duplicate detection.
RequiresSession bool: A value that indicates whether the queue supports the concept of sessions.
Status string: Enumerates the possible values for the status of a messaging entity.

AccessedAt string: Last time a message was sent, or the last time there was a receive request to this queue.
CountDetails MessageCountDetailsResponse: Message Count Details.
CreatedAt string: The exact time the message was created.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string: The geo-location where the resource lives
MessageCount float64: The number of messages in the queue.
Name string: The name of the resource
SizeInBytes float64: The size of the queue, in bytes.
SystemData SystemDataResponse: The system meta data relating to this resource.
Type string: The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
UpdatedAt string: The exact time the message was updated.
AutoDeleteOnIdle string: ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.
DeadLetteringOnMessageExpiration bool: A value that indicates whether this queue has dead letter support when a message expires.
DefaultMessageTimeToLive string: 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 string: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
EnableBatchedOperations bool: Value that indicates whether server-side batched operations are enabled.
EnableExpress bool: A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.
EnablePartitioning bool: A value that indicates whether the queue is to be partitioned across multiple message brokers.
ForwardDeadLetteredMessagesTo string: Queue/Topic name to forward the Dead Letter message
ForwardTo string: Queue/Topic name to forward the messages
LockDuration string: 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 int: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.
MaxMessageSizeInKilobytes float64: Maximum size (in KB) of the message payload that can be accepted by the queue. This property is only used in Premium today and default is 1024.
MaxSizeInMegabytes int: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.
RequiresDuplicateDetection bool: A value indicating if this queue requires duplicate detection.
RequiresSession bool: A value that indicates whether the queue supports the concept of sessions.
Status string: Enumerates the possible values for the status of a messaging entity.

accessedAt String: Last time a message was sent, or the last time there was a receive request to this queue.
countDetails MessageCountDetailsResponse: Message Count Details.
createdAt String: The exact time the message was created.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String: The geo-location where the resource lives
messageCount Double: The number of messages in the queue.
name String: The name of the resource
sizeInBytes Double: The size of the queue, in bytes.
systemData SystemDataResponse: The system meta data relating to this resource.
type String: The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
updatedAt String: The exact time the message was updated.
autoDeleteOnIdle String: ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.
deadLetteringOnMessageExpiration Boolean: A value that indicates whether this queue has dead letter support when a message expires.
defaultMessageTimeToLive String: 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 String: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
enableBatchedOperations Boolean: Value that indicates whether server-side batched operations are enabled.
enableExpress Boolean: A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.
enablePartitioning Boolean: A value that indicates whether the queue is to be partitioned across multiple message brokers.
forwardDeadLetteredMessagesTo String: Queue/Topic name to forward the Dead Letter message
forwardTo String: Queue/Topic name to forward the messages
lockDuration String: 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 Integer: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.
maxMessageSizeInKilobytes Double: Maximum size (in KB) of the message payload that can be accepted by the queue. This property is only used in Premium today and default is 1024.
maxSizeInMegabytes Integer: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.
requiresDuplicateDetection Boolean: A value indicating if this queue requires duplicate detection.
requiresSession Boolean: A value that indicates whether the queue supports the concept of sessions.
status String: Enumerates the possible values for the status of a messaging entity.

accessedAt string: Last time a message was sent, or the last time there was a receive request to this queue.
countDetails MessageCountDetailsResponse: Message Count Details.
createdAt string: The exact time the message was created.
id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location string: The geo-location where the resource lives
messageCount number: The number of messages in the queue.
name string: The name of the resource
sizeInBytes number: The size of the queue, in bytes.
systemData SystemDataResponse: The system meta data relating to this resource.
type string: The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
updatedAt string: The exact time the message was updated.
autoDeleteOnIdle string: ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.
deadLetteringOnMessageExpiration boolean: A value that indicates whether this queue has dead letter support when a message expires.
defaultMessageTimeToLive string: 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 string: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
enableBatchedOperations boolean: Value that indicates whether server-side batched operations are enabled.
enableExpress boolean: A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.
enablePartitioning boolean: A value that indicates whether the queue is to be partitioned across multiple message brokers.
forwardDeadLetteredMessagesTo string: Queue/Topic name to forward the Dead Letter message
forwardTo string: Queue/Topic name to forward the messages
lockDuration string: 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 number: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.
maxMessageSizeInKilobytes number: Maximum size (in KB) of the message payload that can be accepted by the queue. This property is only used in Premium today and default is 1024.
maxSizeInMegabytes number: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.
requiresDuplicateDetection boolean: A value indicating if this queue requires duplicate detection.
requiresSession boolean: A value that indicates whether the queue supports the concept of sessions.
status string: Enumerates the possible values for the status of a messaging entity.

accessed_at str: Last time a message was sent, or the last time there was a receive request to this queue.
count_details MessageCountDetailsResponse: Message Count Details.
created_at str: The exact time the message was created.
id str: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location str: The geo-location where the resource lives
message_count float: The number of messages in the queue.
name str: The name of the resource
size_in_bytes float: The size of the queue, in bytes.
system_data SystemDataResponse: The system meta data relating to this resource.
type str: The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
updated_at str: The exact time the message was updated.
auto_delete_on_idle str: ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.
dead_lettering_on_message_expiration bool: A value that indicates whether this queue has dead letter support when a message expires.
default_message_time_to_live str: 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.
duplicate_detection_history_time_window str: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
enable_batched_operations bool: Value that indicates whether server-side batched operations are enabled.
enable_express bool: A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.
enable_partitioning bool: A value that indicates whether the queue is to be partitioned across multiple message brokers.
forward_dead_lettered_messages_to str: Queue/Topic name to forward the Dead Letter message
forward_to str: Queue/Topic name to forward the messages
lock_duration str: 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.
max_delivery_count int: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.
max_message_size_in_kilobytes float: Maximum size (in KB) of the message payload that can be accepted by the queue. This property is only used in Premium today and default is 1024.
max_size_in_megabytes int: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.
requires_duplicate_detection bool: A value indicating if this queue requires duplicate detection.
requires_session bool: A value that indicates whether the queue supports the concept of sessions.
status str: Enumerates the possible values for the status of a messaging entity.

accessedAt String: Last time a message was sent, or the last time there was a receive request to this queue.
countDetails Property Map: Message Count Details.
createdAt String: The exact time the message was created.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String: The geo-location where the resource lives
messageCount Number: The number of messages in the queue.
name String: The name of the resource
sizeInBytes Number: The size of the queue, in bytes.
systemData Property Map: The system meta data relating to this resource.
type String: The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
updatedAt String: The exact time the message was updated.
autoDeleteOnIdle String: ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.
deadLetteringOnMessageExpiration Boolean: A value that indicates whether this queue has dead letter support when a message expires.
defaultMessageTimeToLive String: 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 String: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
enableBatchedOperations Boolean: Value that indicates whether server-side batched operations are enabled.
enableExpress Boolean: A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.
enablePartitioning Boolean: A value that indicates whether the queue is to be partitioned across multiple message brokers.
forwardDeadLetteredMessagesTo String: Queue/Topic name to forward the Dead Letter message
forwardTo String: Queue/Topic name to forward the messages
lockDuration String: 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 Number: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.
maxMessageSizeInKilobytes Number: Maximum size (in KB) of the message payload that can be accepted by the queue. This property is only used in Premium today and default is 1024.
maxSizeInMegabytes Number: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.
requiresDuplicateDetection Boolean: A value indicating if this queue requires duplicate detection.
requiresSession Boolean: A value that indicates whether the queue supports the concept of sessions.
status String: Enumerates the possible values for the status of a messaging entity.

Supporting Types

MessageCountDetailsResponse

ActiveMessageCount double: Number of active messages in the queue, topic, or subscription.
DeadLetterMessageCount double: Number of messages that are dead lettered.
ScheduledMessageCount double: Number of scheduled messages.
TransferDeadLetterMessageCount double: Number of messages transferred into dead letters.
TransferMessageCount double: Number of messages transferred to another queue, topic, or subscription.

ActiveMessageCount float64: Number of active messages in the queue, topic, or subscription.
DeadLetterMessageCount float64: Number of messages that are dead lettered.
ScheduledMessageCount float64: Number of scheduled messages.
TransferDeadLetterMessageCount float64: Number of messages transferred into dead letters.
TransferMessageCount float64: Number of messages transferred to another queue, topic, or subscription.

activeMessageCount Double: Number of active messages in the queue, topic, or subscription.
deadLetterMessageCount Double: Number of messages that are dead lettered.
scheduledMessageCount Double: Number of scheduled messages.
transferDeadLetterMessageCount Double: Number of messages transferred into dead letters.
transferMessageCount Double: Number of messages transferred to another queue, topic, or subscription.

activeMessageCount number: Number of active messages in the queue, topic, or subscription.
deadLetterMessageCount number: Number of messages that are dead lettered.
scheduledMessageCount number: Number of scheduled messages.
transferDeadLetterMessageCount number: Number of messages transferred into dead letters.
transferMessageCount number: Number of messages transferred to another queue, topic, or subscription.

active_message_count float: Number of active messages in the queue, topic, or subscription.
dead_letter_message_count float: Number of messages that are dead lettered.
scheduled_message_count float: Number of scheduled messages.
transfer_dead_letter_message_count float: Number of messages transferred into dead letters.
transfer_message_count float: Number of messages transferred to another queue, topic, or subscription.

activeMessageCount Number: Number of active messages in the queue, topic, or subscription.
deadLetterMessageCount Number: Number of messages that are dead lettered.
scheduledMessageCount Number: Number of scheduled messages.
transferDeadLetterMessageCount Number: Number of messages transferred into dead letters.
transferMessageCount Number: Number of messages transferred to another queue, topic, or subscription.

SystemDataResponse

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The type of identity that last modified the resource.
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The type of identity that last modified the resource.
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The type of identity that last modified the resource.
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

createdAt string: The timestamp of resource creation (UTC).
createdBy string: The identity that created the resource.
createdByType string: The type of identity that created the resource.
lastModifiedAt string: The type of identity that last modified the resource.
lastModifiedBy string: The identity that last modified the resource.
lastModifiedByType string: The type of identity that last modified the resource.

created_at str: The timestamp of resource creation (UTC).
created_by str: The identity that created the resource.
created_by_type str: The type of identity that created the resource.
last_modified_at str: The type of identity that last modified the resource.
last_modified_by str: The identity that last modified the resource.
last_modified_by_type str: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The type of identity that last modified the resource.
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.servicebus.getQueue

On this page

On this page

Using getQueue

getQueue Result

Supporting Types

MessageCountDetailsResponse

SystemDataResponse

Package Details

On this page

On this page