@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 8.6 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Description of subscription resource.
*
* Uses Azure REST API version 2024-01-01. In version 2.x of the Azure Native provider, it used API version 2022-01-01-preview.
*
* 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. 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 class Subscription extends pulumi.CustomResource {
/**
* Get an existing Subscription resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Subscription;
/**
* Returns true if the given object is an instance of Subscription. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Subscription;
/**
* Last time there was a receive request to this subscription.
*/
readonly accessedAt: pulumi.Output<string>;
/**
* ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
*/
readonly autoDeleteOnIdle: pulumi.Output<string | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Properties specific to client affine subscriptions.
*/
readonly clientAffineProperties: pulumi.Output<outputs.servicebus.SBClientAffinePropertiesResponse | undefined>;
/**
* Message count details
*/
readonly countDetails: pulumi.Output<outputs.servicebus.MessageCountDetailsResponse>;
/**
* Exact time the message was created.
*/
readonly createdAt: pulumi.Output<string>;
/**
* Value that indicates whether a subscription has dead letter support on filter evaluation exceptions.
*/
readonly deadLetteringOnFilterEvaluationExceptions: pulumi.Output<boolean | undefined>;
/**
* Value that indicates whether a subscription has dead letter support when a message expires.
*/
readonly deadLetteringOnMessageExpiration: pulumi.Output<boolean | undefined>;
/**
* ISO 8061 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: pulumi.Output<string | undefined>;
/**
* ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
*/
readonly duplicateDetectionHistoryTimeWindow: pulumi.Output<string | undefined>;
/**
* Value that indicates whether server-side batched operations are enabled.
*/
readonly enableBatchedOperations: pulumi.Output<boolean | undefined>;
/**
* Queue/Topic name to forward the Dead Letter message
*/
readonly forwardDeadLetteredMessagesTo: pulumi.Output<string | undefined>;
/**
* Queue/Topic name to forward the messages
*/
readonly forwardTo: pulumi.Output<string | undefined>;
/**
* Value that indicates whether the subscription has an affinity to the client id.
*/
readonly isClientAffine: pulumi.Output<boolean | undefined>;
/**
* The geo-location where the resource lives
*/
readonly location: pulumi.Output<string>;
/**
* ISO 8061 lock duration timespan for the subscription. The default value is 1 minute.
*/
readonly lockDuration: pulumi.Output<string | undefined>;
/**
* Number of maximum deliveries.
*/
readonly maxDeliveryCount: pulumi.Output<number | undefined>;
/**
* Number of messages.
*/
readonly messageCount: pulumi.Output<number>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* Value indicating if a subscription supports the concept of sessions.
*/
readonly requiresSession: pulumi.Output<boolean | undefined>;
/**
* Enumerates the possible values for the status of a messaging entity.
*/
readonly status: pulumi.Output<string | undefined>;
/**
* The system meta data relating to this resource.
*/
readonly systemData: pulumi.Output<outputs.servicebus.SystemDataResponse>;
/**
* The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
*/
readonly type: pulumi.Output<string>;
/**
* The exact time the message was updated.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* Create a Subscription resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: SubscriptionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Subscription resource.
*/
export interface SubscriptionArgs {
/**
* ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
*/
autoDeleteOnIdle?: pulumi.Input<string>;
/**
* Properties specific to client affine subscriptions.
*/
clientAffineProperties?: pulumi.Input<inputs.servicebus.SBClientAffinePropertiesArgs>;
/**
* Value that indicates whether a subscription has dead letter support on filter evaluation exceptions.
*/
deadLetteringOnFilterEvaluationExceptions?: pulumi.Input<boolean>;
/**
* Value that indicates whether a subscription has dead letter support when a message expires.
*/
deadLetteringOnMessageExpiration?: pulumi.Input<boolean>;
/**
* ISO 8061 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.
*/
defaultMessageTimeToLive?: pulumi.Input<string>;
/**
* ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
*/
duplicateDetectionHistoryTimeWindow?: pulumi.Input<string>;
/**
* Value that indicates whether server-side batched operations are enabled.
*/
enableBatchedOperations?: pulumi.Input<boolean>;
/**
* Queue/Topic name to forward the Dead Letter message
*/
forwardDeadLetteredMessagesTo?: pulumi.Input<string>;
/**
* Queue/Topic name to forward the messages
*/
forwardTo?: pulumi.Input<string>;
/**
* Value that indicates whether the subscription has an affinity to the client id.
*/
isClientAffine?: pulumi.Input<boolean>;
/**
* ISO 8061 lock duration timespan for the subscription. The default value is 1 minute.
*/
lockDuration?: pulumi.Input<string>;
/**
* Number of maximum deliveries.
*/
maxDeliveryCount?: pulumi.Input<number>;
/**
* The namespace name
*/
namespaceName: pulumi.Input<string>;
/**
* Value indicating if a subscription supports the concept of sessions.
*/
requiresSession?: pulumi.Input<boolean>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Enumerates the possible values for the status of a messaging entity.
*/
status?: pulumi.Input<enums.servicebus.EntityStatus>;
/**
* The subscription name.
*/
subscriptionName?: pulumi.Input<string>;
/**
* The topic name.
*/
topicName: pulumi.Input<string>;
}