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.47.1 published on Monday, Jun 24, 2024 by Pulumi
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.47.1 published on Monday, Jun 24, 2024 by Pulumi
Returns a description for the specified queue. Azure REST API version: 2022-01-01-preview.
Other available API versions: 2015-08-01, 2022-10-01-preview.
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:servicebus:getQueue
arguments:
# arguments dictionary
The following arguments are supported:
- Namespace
Name string - The namespace name
- Queue
Name string - The queue name.
- Resource
Group stringName - Name of the Resource group within the Azure subscription.
- Namespace
Name string - The namespace name
- Queue
Name string - The queue name.
- Resource
Group stringName - Name of the Resource group within the Azure subscription.
- namespace
Name String - The namespace name
- queue
Name String - The queue name.
- resource
Group StringName - Name of the Resource group within the Azure subscription.
- namespace
Name string - The namespace name
- queue
Name string - The queue name.
- resource
Group stringName - Name of the Resource group within the Azure subscription.
- namespace_
name str - The namespace name
- queue_
name str - The queue name.
- resource_
group_ strname - Name of the Resource group within the Azure subscription.
- namespace
Name String - The namespace name
- queue
Name String - The queue name.
- resource
Group StringName - Name of the Resource group within the Azure subscription.
getQueue Result
The following output properties are available:
- Accessed
At string - Last time a message was sent, or the last time there was a receive request to this queue.
- Count
Details Pulumi.Azure Native. Service Bus. Outputs. Message Count Details Response - Message Count Details.
- Created
At 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
- Message
Count double - The number of messages in the queue.
- Name string
- The name of the resource
- Size
In doubleBytes - The size of the queue, in bytes.
- System
Data Pulumi.Azure Native. Service Bus. Outputs. System Data Response - 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"
- Updated
At string - The exact time the message was updated.
- Auto
Delete stringOn Idle - ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.
- Dead
Lettering boolOn Message Expiration - A value that indicates whether this queue has dead letter support when a message expires.
- Default
Message stringTime To Live - 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 stringHistory Time Window - ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
- Enable
Batched boolOperations - 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 stringLettered Messages To - Queue/Topic name to forward the Dead Letter message
- Forward
To string - Queue/Topic name to forward the messages
- Lock
Duration 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.
- Max
Delivery intCount - The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.
- Max
Message doubleSize In Kilobytes - 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 intIn Megabytes - The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.
- Requires
Duplicate boolDetection - 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 string
- Enumerates the possible values for the status of a messaging entity.
- Accessed
At string - Last time a message was sent, or the last time there was a receive request to this queue.
- Count
Details MessageCount Details Response - Message Count Details.
- Created
At 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
- Message
Count float64 - The number of messages in the queue.
- Name string
- The name of the resource
- Size
In float64Bytes - The size of the queue, in bytes.
- System
Data SystemData Response - 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"
- Updated
At string - The exact time the message was updated.
- Auto
Delete stringOn Idle - ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.
- Dead
Lettering boolOn Message Expiration - A value that indicates whether this queue has dead letter support when a message expires.
- Default
Message stringTime To Live - 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 stringHistory Time Window - ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
- Enable
Batched boolOperations - 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 stringLettered Messages To - Queue/Topic name to forward the Dead Letter message
- Forward
To string - Queue/Topic name to forward the messages
- Lock
Duration 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.
- Max
Delivery intCount - The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.
- Max
Message float64Size In Kilobytes - 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 intIn Megabytes - The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.
- Requires
Duplicate boolDetection - 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 string
- Enumerates the possible values for the status of a messaging entity.
- accessed
At String - Last time a message was sent, or the last time there was a receive request to this queue.
- count
Details MessageCount Details Response - Message Count Details.
- created
At 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
- message
Count Double - The number of messages in the queue.
- name String
- The name of the resource
- size
In DoubleBytes - The size of the queue, in bytes.
- system
Data SystemData Response - 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"
- updated
At String - The exact time the message was updated.
- auto
Delete StringOn Idle - ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.
- dead
Lettering BooleanOn Message Expiration - A value that indicates whether this queue has dead letter support when a message expires.
- default
Message StringTime To Live - 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 StringHistory Time Window - ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
- enable
Batched BooleanOperations - Value that indicates whether server-side batched operations are enabled.
- enable
Express 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.
- enable
Partitioning Boolean - A value that indicates whether the queue is to be partitioned across multiple message brokers.
- forward
Dead StringLettered Messages To - Queue/Topic name to forward the Dead Letter message
- forward
To String - Queue/Topic name to forward the messages
- lock
Duration 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.
- max
Delivery IntegerCount - The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.
- max
Message DoubleSize In Kilobytes - 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 IntegerIn Megabytes - The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.
- requires
Duplicate BooleanDetection - A value indicating if this queue requires duplicate detection.
- requires
Session 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 string - Last time a message was sent, or the last time there was a receive request to this queue.
- count
Details MessageCount Details Response - Message Count Details.
- created
At 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
- message
Count number - The number of messages in the queue.
- name string
- The name of the resource
- size
In numberBytes - The size of the queue, in bytes.
- system
Data SystemData Response - 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"
- updated
At string - The exact time the message was updated.
- auto
Delete stringOn Idle - ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.
- dead
Lettering booleanOn Message Expiration - A value that indicates whether this queue has dead letter support when a message expires.
- default
Message stringTime To Live - 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 stringHistory Time Window - ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
- enable
Batched booleanOperations - Value that indicates whether server-side batched operations are enabled.
- enable
Express 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.
- enable
Partitioning boolean - A value that indicates whether the queue is to be partitioned across multiple message brokers.
- forward
Dead stringLettered Messages To - Queue/Topic name to forward the Dead Letter message
- forward
To string - Queue/Topic name to forward the messages
- lock
Duration 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.
- max
Delivery numberCount - The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.
- max
Message numberSize In Kilobytes - 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 numberIn Megabytes - The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.
- requires
Duplicate booleanDetection - A value indicating if this queue requires duplicate detection.
- requires
Session 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 MessageCount Details Response - 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_ floatbytes - The size of the queue, in bytes.
- system_
data SystemData Response - 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_ stron_ idle - ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.
- dead_
lettering_ boolon_ message_ expiration - A value that indicates whether this queue has dead letter support when a message expires.
- default_
message_ strtime_ to_ live - 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_ strhistory_ time_ window - ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
- enable_
batched_ booloperations - 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_ strlettered_ messages_ to - 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_ intcount - The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.
- max_
message_ floatsize_ in_ kilobytes - 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_ intin_ megabytes - The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.
- requires_
duplicate_ booldetection - 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.
- accessed
At String - Last time a message was sent, or the last time there was a receive request to this queue.
- count
Details Property Map - Message Count Details.
- created
At 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
- message
Count Number - The number of messages in the queue.
- name String
- The name of the resource
- size
In NumberBytes - The size of the queue, in bytes.
- system
Data 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"
- updated
At String - The exact time the message was updated.
- auto
Delete StringOn Idle - ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.
- dead
Lettering BooleanOn Message Expiration - A value that indicates whether this queue has dead letter support when a message expires.
- default
Message StringTime To Live - 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 StringHistory Time Window - ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
- enable
Batched BooleanOperations - Value that indicates whether server-side batched operations are enabled.
- enable
Express 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.
- enable
Partitioning Boolean - A value that indicates whether the queue is to be partitioned across multiple message brokers.
- forward
Dead StringLettered Messages To - Queue/Topic name to forward the Dead Letter message
- forward
To String - Queue/Topic name to forward the messages
- lock
Duration 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.
- max
Delivery NumberCount - The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.
- max
Message NumberSize In Kilobytes - 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 NumberIn Megabytes - The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.
- requires
Duplicate BooleanDetection - A value indicating if this queue requires duplicate detection.
- requires
Session 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
- Active
Message doubleCount - Number of active messages in the queue, topic, or subscription.
- Dead
Letter doubleMessage Count - Number of messages that are dead lettered.
- Scheduled
Message doubleCount - Number of scheduled messages.
- Transfer
Dead doubleLetter Message Count - Number of messages transferred into dead letters.
- Transfer
Message doubleCount - Number of messages transferred to another queue, topic, or subscription.
- Active
Message float64Count - Number of active messages in the queue, topic, or subscription.
- Dead
Letter float64Message Count - Number of messages that are dead lettered.
- Scheduled
Message float64Count - Number of scheduled messages.
- Transfer
Dead float64Letter Message Count - Number of messages transferred into dead letters.
- Transfer
Message float64Count - Number of messages transferred to another queue, topic, or subscription.
- active
Message DoubleCount - Number of active messages in the queue, topic, or subscription.
- dead
Letter DoubleMessage Count - Number of messages that are dead lettered.
- scheduled
Message DoubleCount - Number of scheduled messages.
- transfer
Dead DoubleLetter Message Count - Number of messages transferred into dead letters.
- transfer
Message DoubleCount - Number of messages transferred to another queue, topic, or subscription.
- active
Message numberCount - Number of active messages in the queue, topic, or subscription.
- dead
Letter numberMessage Count - Number of messages that are dead lettered.
- scheduled
Message numberCount - Number of scheduled messages.
- transfer
Dead numberLetter Message Count - Number of messages transferred into dead letters.
- transfer
Message numberCount - Number of messages transferred to another queue, topic, or subscription.
- active_
message_ floatcount - Number of active messages in the queue, topic, or subscription.
- dead_
letter_ floatmessage_ count - Number of messages that are dead lettered.
- scheduled_
message_ floatcount - Number of scheduled messages.
- transfer_
dead_ floatletter_ message_ count - Number of messages transferred into dead letters.
- transfer_
message_ floatcount - Number of messages transferred to another queue, topic, or subscription.
- active
Message NumberCount - Number of active messages in the queue, topic, or subscription.
- dead
Letter NumberMessage Count - Number of messages that are dead lettered.
- scheduled
Message NumberCount - Number of scheduled messages.
- transfer
Dead NumberLetter Message Count - Number of messages transferred into dead letters.
- transfer
Message NumberCount - Number of messages transferred to another queue, topic, or subscription.
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The type of identity that last modified the resource.
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The type of identity that last modified the resource.
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The type of identity that last modified the resource.
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The type of identity that last modified the resource.
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The type of identity that last modified the resource.
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The type of identity that last modified the resource.
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - 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.47.1 published on Monday, Jun 24, 2024 by Pulumi