@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 9.13 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";
/**
* Event Subscription.
*
* Uses Azure REST API version 2025-02-15. In version 2.x of the Azure Native provider, it used API version 2022-06-15.
*
* Other available API versions: 2022-06-15, 2023-06-01-preview, 2023-12-15-preview, 2024-06-01-preview, 2024-12-15-preview, 2025-04-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native eventgrid [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class TopicEventSubscription extends pulumi.CustomResource {
/**
* Get an existing TopicEventSubscription 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): TopicEventSubscription;
/**
* Returns true if the given object is an instance of TopicEventSubscription. 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 TopicEventSubscription;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination.
* Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering.
*/
readonly deadLetterDestination: pulumi.Output<outputs.eventgrid.StorageBlobDeadLetterDestinationResponse | undefined>;
/**
* The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination.
* Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering.
*/
readonly deadLetterWithResourceIdentity: pulumi.Output<outputs.eventgrid.DeadLetterWithResourceIdentityResponse | undefined>;
/**
* Information about the destination where events have to be delivered for the event subscription.
* Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering.
*/
readonly deliveryWithResourceIdentity: pulumi.Output<outputs.eventgrid.DeliveryWithResourceIdentityResponse | undefined>;
/**
* Information about the destination where events have to be delivered for the event subscription.
* Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering.
*/
readonly destination: pulumi.Output<outputs.eventgrid.AzureFunctionEventSubscriptionDestinationResponse | outputs.eventgrid.EventHubEventSubscriptionDestinationResponse | outputs.eventgrid.HybridConnectionEventSubscriptionDestinationResponse | outputs.eventgrid.MonitorAlertEventSubscriptionDestinationResponse | outputs.eventgrid.NamespaceTopicEventSubscriptionDestinationResponse | outputs.eventgrid.ServiceBusQueueEventSubscriptionDestinationResponse | outputs.eventgrid.ServiceBusTopicEventSubscriptionDestinationResponse | outputs.eventgrid.StorageQueueEventSubscriptionDestinationResponse | outputs.eventgrid.WebHookEventSubscriptionDestinationResponse | undefined>;
/**
* The event delivery schema for the event subscription.
*/
readonly eventDeliverySchema: pulumi.Output<string | undefined>;
/**
* Expiration time of the event subscription.
*/
readonly expirationTimeUtc: pulumi.Output<string | undefined>;
/**
* Information about the filter for the event subscription.
*/
readonly filter: pulumi.Output<outputs.eventgrid.EventSubscriptionFilterResponse | undefined>;
/**
* List of user defined labels.
*/
readonly labels: pulumi.Output<string[] | undefined>;
/**
* Name of the resource.
*/
readonly name: pulumi.Output<string>;
/**
* Provisioning state of the event subscription.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events.
*/
readonly retryPolicy: pulumi.Output<outputs.eventgrid.RetryPolicyResponse | undefined>;
/**
* The system metadata relating to the Event Grid resource.
*/
readonly systemData: pulumi.Output<outputs.eventgrid.SystemDataResponse>;
/**
* Name of the topic of the event subscription.
*/
readonly topic: pulumi.Output<string>;
/**
* Type of the resource.
*/
readonly type: pulumi.Output<string>;
/**
* Create a TopicEventSubscription 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: TopicEventSubscriptionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a TopicEventSubscription resource.
*/
export interface TopicEventSubscriptionArgs {
/**
* The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination.
* Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering.
*/
deadLetterDestination?: pulumi.Input<inputs.eventgrid.StorageBlobDeadLetterDestinationArgs>;
/**
* The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination.
* Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering.
*/
deadLetterWithResourceIdentity?: pulumi.Input<inputs.eventgrid.DeadLetterWithResourceIdentityArgs>;
/**
* Information about the destination where events have to be delivered for the event subscription.
* Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering.
*/
deliveryWithResourceIdentity?: pulumi.Input<inputs.eventgrid.DeliveryWithResourceIdentityArgs>;
/**
* Information about the destination where events have to be delivered for the event subscription.
* Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering.
*/
destination?: pulumi.Input<inputs.eventgrid.AzureFunctionEventSubscriptionDestinationArgs | inputs.eventgrid.EventHubEventSubscriptionDestinationArgs | inputs.eventgrid.HybridConnectionEventSubscriptionDestinationArgs | inputs.eventgrid.MonitorAlertEventSubscriptionDestinationArgs | inputs.eventgrid.NamespaceTopicEventSubscriptionDestinationArgs | inputs.eventgrid.ServiceBusQueueEventSubscriptionDestinationArgs | inputs.eventgrid.ServiceBusTopicEventSubscriptionDestinationArgs | inputs.eventgrid.StorageQueueEventSubscriptionDestinationArgs | inputs.eventgrid.WebHookEventSubscriptionDestinationArgs>;
/**
* The event delivery schema for the event subscription.
*/
eventDeliverySchema?: pulumi.Input<string | enums.eventgrid.EventDeliverySchema>;
/**
* Name of the event subscription to be created. Event subscription names must be between 3 and 64 characters in length and use alphanumeric letters only.
*/
eventSubscriptionName?: pulumi.Input<string>;
/**
* Expiration time of the event subscription.
*/
expirationTimeUtc?: pulumi.Input<string>;
/**
* Information about the filter for the event subscription.
*/
filter?: pulumi.Input<inputs.eventgrid.EventSubscriptionFilterArgs>;
/**
* List of user defined labels.
*/
labels?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The name of the resource group within the user's subscription.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events.
*/
retryPolicy?: pulumi.Input<inputs.eventgrid.RetryPolicyArgs>;
/**
* Name of the domain topic.
*/
topicName: pulumi.Input<string>;
}