@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.65 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Get properties of an event subscription.
*
* Uses Azure REST API version 2025-02-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 function getEventSubscription(args: GetEventSubscriptionArgs, opts?: pulumi.InvokeOptions): Promise<GetEventSubscriptionResult>;
export interface GetEventSubscriptionArgs {
/**
* Name of the event subscription to be found.
*/
eventSubscriptionName: string;
/**
* The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.
*/
scope: string;
}
/**
* Event Subscription.
*/
export interface GetEventSubscriptionResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: 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?: outputs.eventgrid.StorageBlobDeadLetterDestinationResponse;
/**
* 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?: outputs.eventgrid.DeadLetterWithResourceIdentityResponse;
/**
* 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?: outputs.eventgrid.DeliveryWithResourceIdentityResponse;
/**
* 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?: 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;
/**
* The event delivery schema for the event subscription.
*/
readonly eventDeliverySchema?: string;
/**
* Expiration time of the event subscription.
*/
readonly expirationTimeUtc?: string;
/**
* Information about the filter for the event subscription.
*/
readonly filter?: outputs.eventgrid.EventSubscriptionFilterResponse;
/**
* Fully qualified identifier of the resource.
*/
readonly id: string;
/**
* List of user defined labels.
*/
readonly labels?: string[];
/**
* Name of the resource.
*/
readonly name: string;
/**
* Provisioning state of the event subscription.
*/
readonly provisioningState: 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?: outputs.eventgrid.RetryPolicyResponse;
/**
* The system metadata relating to the Event Grid resource.
*/
readonly systemData: outputs.eventgrid.SystemDataResponse;
/**
* Name of the topic of the event subscription.
*/
readonly topic: string;
/**
* Type of the resource.
*/
readonly type: string;
}
/**
* Get properties of an event subscription.
*
* Uses Azure REST API version 2025-02-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 function getEventSubscriptionOutput(args: GetEventSubscriptionOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetEventSubscriptionResult>;
export interface GetEventSubscriptionOutputArgs {
/**
* Name of the event subscription to be found.
*/
eventSubscriptionName: pulumi.Input<string>;
/**
* The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.
*/
scope: pulumi.Input<string>;
}