@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.37 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Returns a description for the specified queue.
*
* Uses Azure REST API version 2024-01-01.
*
* Other available API versions: 2018-01-01-preview, 2021-01-01-preview, 2021-06-01-preview, 2021-11-01, 2022-01-01-preview, 2022-10-01-preview, 2023-01-01-preview, 2025-05-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native servicebus [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getQueue(args: GetQueueArgs, opts?: pulumi.InvokeOptions): Promise<GetQueueResult>;
export interface GetQueueArgs {
/**
* The namespace name
*/
namespaceName: string;
/**
* The queue name.
*/
queueName: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
}
/**
* Description of queue Resource.
*/
export interface GetQueueResult {
/**
* Last time a message was sent, or the last time there was a receive request to this queue.
*/
readonly accessedAt: string;
/**
* ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.
*/
readonly autoDeleteOnIdle?: string;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* Message Count Details.
*/
readonly countDetails: outputs.servicebus.MessageCountDetailsResponse;
/**
* The exact time the message was created.
*/
readonly createdAt: string;
/**
* A value that indicates whether this queue has dead letter support when a message expires.
*/
readonly deadLetteringOnMessageExpiration?: boolean;
/**
* 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.
*/
readonly defaultMessageTimeToLive?: string;
/**
* ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
*/
readonly duplicateDetectionHistoryTimeWindow?: string;
/**
* Value that indicates whether server-side batched operations are enabled.
*/
readonly enableBatchedOperations?: 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.
*/
readonly enableExpress?: boolean;
/**
* A value that indicates whether the queue is to be partitioned across multiple message brokers.
*/
readonly enablePartitioning?: boolean;
/**
* Queue/Topic name to forward the Dead Letter message
*/
readonly forwardDeadLetteredMessagesTo?: string;
/**
* Queue/Topic name to forward the messages
*/
readonly forwardTo?: string;
/**
* Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
*/
readonly id: string;
/**
* The geo-location where the resource lives
*/
readonly location: 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.
*/
readonly lockDuration?: string;
/**
* The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.
*/
readonly maxDeliveryCount?: 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.
*/
readonly maxMessageSizeInKilobytes?: number;
/**
* The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.
*/
readonly maxSizeInMegabytes?: number;
/**
* The number of messages in the queue.
*/
readonly messageCount: number;
/**
* The name of the resource
*/
readonly name: string;
/**
* A value indicating if this queue requires duplicate detection.
*/
readonly requiresDuplicateDetection?: boolean;
/**
* A value that indicates whether the queue supports the concept of sessions.
*/
readonly requiresSession?: boolean;
/**
* The size of the queue, in bytes.
*/
readonly sizeInBytes: number;
/**
* Enumerates the possible values for the status of a messaging entity.
*/
readonly status?: string;
/**
* The system meta data relating to this resource.
*/
readonly systemData: outputs.servicebus.SystemDataResponse;
/**
* The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
*/
readonly type: string;
/**
* The exact time the message was updated.
*/
readonly updatedAt: string;
}
/**
* Returns a description for the specified queue.
*
* Uses Azure REST API version 2024-01-01.
*
* Other available API versions: 2018-01-01-preview, 2021-01-01-preview, 2021-06-01-preview, 2021-11-01, 2022-01-01-preview, 2022-10-01-preview, 2023-01-01-preview, 2025-05-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native servicebus [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getQueueOutput(args: GetQueueOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetQueueResult>;
export interface GetQueueOutputArgs {
/**
* The namespace name
*/
namespaceName: pulumi.Input<string>;
/**
* The queue name.
*/
queueName: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
}