azure.eventgrid.EventSubscription
Manages an EventGrid Event Subscription
Example Usage
using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
{
Location = "West Europe",
});
var exampleAccount = new Azure.Storage.Account("exampleAccount", new()
{
ResourceGroupName = exampleResourceGroup.Name,
Location = exampleResourceGroup.Location,
AccountTier = "Standard",
AccountReplicationType = "LRS",
Tags =
{
{ "environment", "staging" },
},
});
var exampleQueue = new Azure.Storage.Queue("exampleQueue", new()
{
StorageAccountName = exampleAccount.Name,
});
var exampleEventSubscription = new Azure.EventGrid.EventSubscription("exampleEventSubscription", new()
{
Scope = exampleResourceGroup.Id,
StorageQueueEndpoint = new Azure.EventGrid.Inputs.EventSubscriptionStorageQueueEndpointArgs
{
StorageAccountId = exampleAccount.Id,
QueueName = exampleQueue.Name,
},
});
});
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/eventgrid"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/storage"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleAccount, err := storage.NewAccount(ctx, "exampleAccount", &storage.AccountArgs{
ResourceGroupName: exampleResourceGroup.Name,
Location: exampleResourceGroup.Location,
AccountTier: pulumi.String("Standard"),
AccountReplicationType: pulumi.String("LRS"),
Tags: pulumi.StringMap{
"environment": pulumi.String("staging"),
},
})
if err != nil {
return err
}
exampleQueue, err := storage.NewQueue(ctx, "exampleQueue", &storage.QueueArgs{
StorageAccountName: exampleAccount.Name,
})
if err != nil {
return err
}
_, err = eventgrid.NewEventSubscription(ctx, "exampleEventSubscription", &eventgrid.EventSubscriptionArgs{
Scope: exampleResourceGroup.ID(),
StorageQueueEndpoint: &eventgrid.EventSubscriptionStorageQueueEndpointArgs{
StorageAccountId: exampleAccount.ID(),
QueueName: exampleQueue.Name,
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import com.pulumi.azure.storage.Queue;
import com.pulumi.azure.storage.QueueArgs;
import com.pulumi.azure.eventgrid.EventSubscription;
import com.pulumi.azure.eventgrid.EventSubscriptionArgs;
import com.pulumi.azure.eventgrid.inputs.EventSubscriptionStorageQueueEndpointArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
.location("West Europe")
.build());
var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
.resourceGroupName(exampleResourceGroup.name())
.location(exampleResourceGroup.location())
.accountTier("Standard")
.accountReplicationType("LRS")
.tags(Map.of("environment", "staging"))
.build());
var exampleQueue = new Queue("exampleQueue", QueueArgs.builder()
.storageAccountName(exampleAccount.name())
.build());
var exampleEventSubscription = new EventSubscription("exampleEventSubscription", EventSubscriptionArgs.builder()
.scope(exampleResourceGroup.id())
.storageQueueEndpoint(EventSubscriptionStorageQueueEndpointArgs.builder()
.storageAccountId(exampleAccount.id())
.queueName(exampleQueue.name())
.build())
.build());
}
}
import pulumi
import pulumi_azure as azure
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.storage.Account("exampleAccount",
resource_group_name=example_resource_group.name,
location=example_resource_group.location,
account_tier="Standard",
account_replication_type="LRS",
tags={
"environment": "staging",
})
example_queue = azure.storage.Queue("exampleQueue", storage_account_name=example_account.name)
example_event_subscription = azure.eventgrid.EventSubscription("exampleEventSubscription",
scope=example_resource_group.id,
storage_queue_endpoint=azure.eventgrid.EventSubscriptionStorageQueueEndpointArgs(
storage_account_id=example_account.id,
queue_name=example_queue.name,
))
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.storage.Account("exampleAccount", {
resourceGroupName: exampleResourceGroup.name,
location: exampleResourceGroup.location,
accountTier: "Standard",
accountReplicationType: "LRS",
tags: {
environment: "staging",
},
});
const exampleQueue = new azure.storage.Queue("exampleQueue", {storageAccountName: exampleAccount.name});
const exampleEventSubscription = new azure.eventgrid.EventSubscription("exampleEventSubscription", {
scope: exampleResourceGroup.id,
storageQueueEndpoint: {
storageAccountId: exampleAccount.id,
queueName: exampleQueue.name,
},
});
resources:
exampleResourceGroup:
type: azure:core:ResourceGroup
properties:
location: West Europe
exampleAccount:
type: azure:storage:Account
properties:
resourceGroupName: ${exampleResourceGroup.name}
location: ${exampleResourceGroup.location}
accountTier: Standard
accountReplicationType: LRS
tags:
environment: staging
exampleQueue:
type: azure:storage:Queue
properties:
storageAccountName: ${exampleAccount.name}
exampleEventSubscription:
type: azure:eventgrid:EventSubscription
properties:
scope: ${exampleResourceGroup.id}
storageQueueEndpoint:
storageAccountId: ${exampleAccount.id}
queueName: ${exampleQueue.name}
Create EventSubscription Resource
new EventSubscription(name: string, args: EventSubscriptionArgs, opts?: CustomResourceOptions);@overload
def EventSubscription(resource_name: str,
opts: Optional[ResourceOptions] = None,
advanced_filter: Optional[EventSubscriptionAdvancedFilterArgs] = None,
advanced_filtering_on_arrays_enabled: Optional[bool] = None,
azure_function_endpoint: Optional[EventSubscriptionAzureFunctionEndpointArgs] = None,
dead_letter_identity: Optional[EventSubscriptionDeadLetterIdentityArgs] = None,
delivery_identity: Optional[EventSubscriptionDeliveryIdentityArgs] = None,
delivery_properties: Optional[Sequence[EventSubscriptionDeliveryPropertyArgs]] = None,
event_delivery_schema: Optional[str] = None,
eventhub_endpoint_id: Optional[str] = None,
expiration_time_utc: Optional[str] = None,
hybrid_connection_endpoint_id: Optional[str] = None,
included_event_types: Optional[Sequence[str]] = None,
labels: Optional[Sequence[str]] = None,
name: Optional[str] = None,
retry_policy: Optional[EventSubscriptionRetryPolicyArgs] = None,
scope: Optional[str] = None,
service_bus_queue_endpoint_id: Optional[str] = None,
service_bus_topic_endpoint_id: Optional[str] = None,
storage_blob_dead_letter_destination: Optional[EventSubscriptionStorageBlobDeadLetterDestinationArgs] = None,
storage_queue_endpoint: Optional[EventSubscriptionStorageQueueEndpointArgs] = None,
subject_filter: Optional[EventSubscriptionSubjectFilterArgs] = None,
webhook_endpoint: Optional[EventSubscriptionWebhookEndpointArgs] = None)
@overload
def EventSubscription(resource_name: str,
args: EventSubscriptionArgs,
opts: Optional[ResourceOptions] = None)func NewEventSubscription(ctx *Context, name string, args EventSubscriptionArgs, opts ...ResourceOption) (*EventSubscription, error)public EventSubscription(string name, EventSubscriptionArgs args, CustomResourceOptions? opts = null)
public EventSubscription(String name, EventSubscriptionArgs args)
public EventSubscription(String name, EventSubscriptionArgs args, CustomResourceOptions options)
type: azure:eventgrid:EventSubscription
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EventSubscriptionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args EventSubscriptionArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args EventSubscriptionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EventSubscriptionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args EventSubscriptionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
EventSubscription Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The EventSubscription resource accepts the following input properties:
- Scope string
Specifies the scope at which the EventGrid Event Subscription should be created. Changing this forces a new resource to be created.
- Advanced
Filter EventSubscription Advanced Filter Args A
advanced_filterblock as defined below.- Advanced
Filtering boolOn Arrays Enabled Specifies whether advanced filters should be evaluated against an array of values instead of expecting a singular value. Defaults to
false.- Azure
Function EventEndpoint Subscription Azure Function Endpoint Args An
azure_function_endpointblock as defined below.- Dead
Letter EventIdentity Subscription Dead Letter Identity Args A
dead_letter_identityblock as defined below.- Delivery
Identity EventSubscription Delivery Identity Args A
delivery_identityblock as defined below.- Delivery
Properties List<EventSubscription Delivery Property Args> One or more
delivery_propertyblocks as defined below.- Event
Delivery stringSchema Specifies the event delivery schema for the event subscription. Possible values include:
EventGridSchema,CloudEventSchemaV1_0,CustomInputSchema. Defaults toEventGridSchema. Changing this forces a new resource to be created.- Eventhub
Endpoint stringId Specifies the id where the Event Hub is located.
- Expiration
Time stringUtc Specifies the expiration time of the event subscription (Datetime Format
RFC 3339).- Hybrid
Connection stringEndpoint Id Specifies the id where the Hybrid Connection is located.
- Included
Event List<string>Types A list of applicable event types that need to be part of the event subscription.
- Labels List<string>
A list of labels to assign to the event subscription.
- Name string
Specifies the name of the EventGrid Event Subscription resource. Changing this forces a new resource to be created.
- Retry
Policy EventSubscription Retry Policy Args A
retry_policyblock as defined below.- Service
Bus stringQueue Endpoint Id Specifies the id where the Service Bus Queue is located.
- Service
Bus stringTopic Endpoint Id Specifies the id where the Service Bus Topic is located.
- Storage
Blob EventDead Letter Destination Subscription Storage Blob Dead Letter Destination Args A
storage_blob_dead_letter_destinationblock as defined below.- Storage
Queue EventEndpoint Subscription Storage Queue Endpoint Args A
storage_queue_endpointblock as defined below.- Subject
Filter EventSubscription Subject Filter Args A
subject_filterblock as defined below.- Webhook
Endpoint EventSubscription Webhook Endpoint Args A
webhook_endpointblock as defined below.
- Scope string
Specifies the scope at which the EventGrid Event Subscription should be created. Changing this forces a new resource to be created.
- Advanced
Filter EventSubscription Advanced Filter Args A
advanced_filterblock as defined below.- Advanced
Filtering boolOn Arrays Enabled Specifies whether advanced filters should be evaluated against an array of values instead of expecting a singular value. Defaults to
false.- Azure
Function EventEndpoint Subscription Azure Function Endpoint Args An
azure_function_endpointblock as defined below.- Dead
Letter EventIdentity Subscription Dead Letter Identity Args A
dead_letter_identityblock as defined below.- Delivery
Identity EventSubscription Delivery Identity Args A
delivery_identityblock as defined below.- Delivery
Properties []EventSubscription Delivery Property Args One or more
delivery_propertyblocks as defined below.- Event
Delivery stringSchema Specifies the event delivery schema for the event subscription. Possible values include:
EventGridSchema,CloudEventSchemaV1_0,CustomInputSchema. Defaults toEventGridSchema. Changing this forces a new resource to be created.- Eventhub
Endpoint stringId Specifies the id where the Event Hub is located.
- Expiration
Time stringUtc Specifies the expiration time of the event subscription (Datetime Format
RFC 3339).- Hybrid
Connection stringEndpoint Id Specifies the id where the Hybrid Connection is located.
- Included
Event []stringTypes A list of applicable event types that need to be part of the event subscription.
- Labels []string
A list of labels to assign to the event subscription.
- Name string
Specifies the name of the EventGrid Event Subscription resource. Changing this forces a new resource to be created.
- Retry
Policy EventSubscription Retry Policy Args A
retry_policyblock as defined below.- Service
Bus stringQueue Endpoint Id Specifies the id where the Service Bus Queue is located.
- Service
Bus stringTopic Endpoint Id Specifies the id where the Service Bus Topic is located.
- Storage
Blob EventDead Letter Destination Subscription Storage Blob Dead Letter Destination Args A
storage_blob_dead_letter_destinationblock as defined below.- Storage
Queue EventEndpoint Subscription Storage Queue Endpoint Args A
storage_queue_endpointblock as defined below.- Subject
Filter EventSubscription Subject Filter Args A
subject_filterblock as defined below.- Webhook
Endpoint EventSubscription Webhook Endpoint Args A
webhook_endpointblock as defined below.
- scope String
Specifies the scope at which the EventGrid Event Subscription should be created. Changing this forces a new resource to be created.
- advanced
Filter EventSubscription Advanced Filter Args A
advanced_filterblock as defined below.- advanced
Filtering BooleanOn Arrays Enabled Specifies whether advanced filters should be evaluated against an array of values instead of expecting a singular value. Defaults to
false.- azure
Function EventEndpoint Subscription Azure Function Endpoint Args An
azure_function_endpointblock as defined below.- dead
Letter EventIdentity Subscription Dead Letter Identity Args A
dead_letter_identityblock as defined below.- delivery
Identity EventSubscription Delivery Identity Args A
delivery_identityblock as defined below.- delivery
Properties List<EventSubscription Delivery Property Args> One or more
delivery_propertyblocks as defined below.- event
Delivery StringSchema Specifies the event delivery schema for the event subscription. Possible values include:
EventGridSchema,CloudEventSchemaV1_0,CustomInputSchema. Defaults toEventGridSchema. Changing this forces a new resource to be created.- eventhub
Endpoint StringId Specifies the id where the Event Hub is located.
- expiration
Time StringUtc Specifies the expiration time of the event subscription (Datetime Format
RFC 3339).- hybrid
Connection StringEndpoint Id Specifies the id where the Hybrid Connection is located.
- included
Event List<String>Types A list of applicable event types that need to be part of the event subscription.
- labels List<String>
A list of labels to assign to the event subscription.
- name String
Specifies the name of the EventGrid Event Subscription resource. Changing this forces a new resource to be created.
- retry
Policy EventSubscription Retry Policy Args A
retry_policyblock as defined below.- service
Bus StringQueue Endpoint Id Specifies the id where the Service Bus Queue is located.
- service
Bus StringTopic Endpoint Id Specifies the id where the Service Bus Topic is located.
- storage
Blob EventDead Letter Destination Subscription Storage Blob Dead Letter Destination Args A
storage_blob_dead_letter_destinationblock as defined below.- storage
Queue EventEndpoint Subscription Storage Queue Endpoint Args A
storage_queue_endpointblock as defined below.- subject
Filter EventSubscription Subject Filter Args A
subject_filterblock as defined below.- webhook
Endpoint EventSubscription Webhook Endpoint Args A
webhook_endpointblock as defined below.
- scope string
Specifies the scope at which the EventGrid Event Subscription should be created. Changing this forces a new resource to be created.
- advanced
Filter EventSubscription Advanced Filter Args A
advanced_filterblock as defined below.- advanced
Filtering booleanOn Arrays Enabled Specifies whether advanced filters should be evaluated against an array of values instead of expecting a singular value. Defaults to
false.- azure
Function EventEndpoint Subscription Azure Function Endpoint Args An
azure_function_endpointblock as defined below.- dead
Letter EventIdentity Subscription Dead Letter Identity Args A
dead_letter_identityblock as defined below.- delivery
Identity EventSubscription Delivery Identity Args A
delivery_identityblock as defined below.- delivery
Properties EventSubscription Delivery Property Args[] One or more
delivery_propertyblocks as defined below.- event
Delivery stringSchema Specifies the event delivery schema for the event subscription. Possible values include:
EventGridSchema,CloudEventSchemaV1_0,CustomInputSchema. Defaults toEventGridSchema. Changing this forces a new resource to be created.- eventhub
Endpoint stringId Specifies the id where the Event Hub is located.
- expiration
Time stringUtc Specifies the expiration time of the event subscription (Datetime Format
RFC 3339).- hybrid
Connection stringEndpoint Id Specifies the id where the Hybrid Connection is located.
- included
Event string[]Types A list of applicable event types that need to be part of the event subscription.
- labels string[]
A list of labels to assign to the event subscription.
- name string
Specifies the name of the EventGrid Event Subscription resource. Changing this forces a new resource to be created.
- retry
Policy EventSubscription Retry Policy Args A
retry_policyblock as defined below.- service
Bus stringQueue Endpoint Id Specifies the id where the Service Bus Queue is located.
- service
Bus stringTopic Endpoint Id Specifies the id where the Service Bus Topic is located.
- storage
Blob EventDead Letter Destination Subscription Storage Blob Dead Letter Destination Args A
storage_blob_dead_letter_destinationblock as defined below.- storage
Queue EventEndpoint Subscription Storage Queue Endpoint Args A
storage_queue_endpointblock as defined below.- subject
Filter EventSubscription Subject Filter Args A
subject_filterblock as defined below.- webhook
Endpoint EventSubscription Webhook Endpoint Args A
webhook_endpointblock as defined below.
- scope str
Specifies the scope at which the EventGrid Event Subscription should be created. Changing this forces a new resource to be created.
- advanced_
filter EventSubscription Advanced Filter Args A
advanced_filterblock as defined below.- advanced_
filtering_ boolon_ arrays_ enabled Specifies whether advanced filters should be evaluated against an array of values instead of expecting a singular value. Defaults to
false.- azure_
function_ Eventendpoint Subscription Azure Function Endpoint Args An
azure_function_endpointblock as defined below.- dead_
letter_ Eventidentity Subscription Dead Letter Identity Args A
dead_letter_identityblock as defined below.- delivery_
identity EventSubscription Delivery Identity Args A
delivery_identityblock as defined below.- delivery_
properties Sequence[EventSubscription Delivery Property Args] One or more
delivery_propertyblocks as defined below.- event_
delivery_ strschema Specifies the event delivery schema for the event subscription. Possible values include:
EventGridSchema,CloudEventSchemaV1_0,CustomInputSchema. Defaults toEventGridSchema. Changing this forces a new resource to be created.- eventhub_
endpoint_ strid Specifies the id where the Event Hub is located.
- expiration_
time_ strutc Specifies the expiration time of the event subscription (Datetime Format
RFC 3339).- hybrid_
connection_ strendpoint_ id Specifies the id where the Hybrid Connection is located.
- included_
event_ Sequence[str]types A list of applicable event types that need to be part of the event subscription.
- labels Sequence[str]
A list of labels to assign to the event subscription.
- name str
Specifies the name of the EventGrid Event Subscription resource. Changing this forces a new resource to be created.
- retry_
policy EventSubscription Retry Policy Args A
retry_policyblock as defined below.- service_
bus_ strqueue_ endpoint_ id Specifies the id where the Service Bus Queue is located.
- service_
bus_ strtopic_ endpoint_ id Specifies the id where the Service Bus Topic is located.
- storage_
blob_ Eventdead_ letter_ destination Subscription Storage Blob Dead Letter Destination Args A
storage_blob_dead_letter_destinationblock as defined below.- storage_
queue_ Eventendpoint Subscription Storage Queue Endpoint Args A
storage_queue_endpointblock as defined below.- subject_
filter EventSubscription Subject Filter Args A
subject_filterblock as defined below.- webhook_
endpoint EventSubscription Webhook Endpoint Args A
webhook_endpointblock as defined below.
- scope String
Specifies the scope at which the EventGrid Event Subscription should be created. Changing this forces a new resource to be created.
- advanced
Filter Property Map A
advanced_filterblock as defined below.- advanced
Filtering BooleanOn Arrays Enabled Specifies whether advanced filters should be evaluated against an array of values instead of expecting a singular value. Defaults to
false.- azure
Function Property MapEndpoint An
azure_function_endpointblock as defined below.- dead
Letter Property MapIdentity A
dead_letter_identityblock as defined below.- delivery
Identity Property Map A
delivery_identityblock as defined below.- delivery
Properties List<Property Map> One or more
delivery_propertyblocks as defined below.- event
Delivery StringSchema Specifies the event delivery schema for the event subscription. Possible values include:
EventGridSchema,CloudEventSchemaV1_0,CustomInputSchema. Defaults toEventGridSchema. Changing this forces a new resource to be created.- eventhub
Endpoint StringId Specifies the id where the Event Hub is located.
- expiration
Time StringUtc Specifies the expiration time of the event subscription (Datetime Format
RFC 3339).- hybrid
Connection StringEndpoint Id Specifies the id where the Hybrid Connection is located.
- included
Event List<String>Types A list of applicable event types that need to be part of the event subscription.
- labels List<String>
A list of labels to assign to the event subscription.
- name String
Specifies the name of the EventGrid Event Subscription resource. Changing this forces a new resource to be created.
- retry
Policy Property Map A
retry_policyblock as defined below.- service
Bus StringQueue Endpoint Id Specifies the id where the Service Bus Queue is located.
- service
Bus StringTopic Endpoint Id Specifies the id where the Service Bus Topic is located.
- storage
Blob Property MapDead Letter Destination A
storage_blob_dead_letter_destinationblock as defined below.- storage
Queue Property MapEndpoint A
storage_queue_endpointblock as defined below.- subject
Filter Property Map A
subject_filterblock as defined below.- webhook
Endpoint Property Map A
webhook_endpointblock as defined below.
Outputs
All input properties are implicitly available as output properties. Additionally, the EventSubscription resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Id string
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
- id string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Look up Existing EventSubscription Resource
Get an existing EventSubscription resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: EventSubscriptionState, opts?: CustomResourceOptions): EventSubscription@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
advanced_filter: Optional[EventSubscriptionAdvancedFilterArgs] = None,
advanced_filtering_on_arrays_enabled: Optional[bool] = None,
azure_function_endpoint: Optional[EventSubscriptionAzureFunctionEndpointArgs] = None,
dead_letter_identity: Optional[EventSubscriptionDeadLetterIdentityArgs] = None,
delivery_identity: Optional[EventSubscriptionDeliveryIdentityArgs] = None,
delivery_properties: Optional[Sequence[EventSubscriptionDeliveryPropertyArgs]] = None,
event_delivery_schema: Optional[str] = None,
eventhub_endpoint_id: Optional[str] = None,
expiration_time_utc: Optional[str] = None,
hybrid_connection_endpoint_id: Optional[str] = None,
included_event_types: Optional[Sequence[str]] = None,
labels: Optional[Sequence[str]] = None,
name: Optional[str] = None,
retry_policy: Optional[EventSubscriptionRetryPolicyArgs] = None,
scope: Optional[str] = None,
service_bus_queue_endpoint_id: Optional[str] = None,
service_bus_topic_endpoint_id: Optional[str] = None,
storage_blob_dead_letter_destination: Optional[EventSubscriptionStorageBlobDeadLetterDestinationArgs] = None,
storage_queue_endpoint: Optional[EventSubscriptionStorageQueueEndpointArgs] = None,
subject_filter: Optional[EventSubscriptionSubjectFilterArgs] = None,
webhook_endpoint: Optional[EventSubscriptionWebhookEndpointArgs] = None) -> EventSubscriptionfunc GetEventSubscription(ctx *Context, name string, id IDInput, state *EventSubscriptionState, opts ...ResourceOption) (*EventSubscription, error)public static EventSubscription Get(string name, Input<string> id, EventSubscriptionState? state, CustomResourceOptions? opts = null)public static EventSubscription get(String name, Output<String> id, EventSubscriptionState state, CustomResourceOptions options)Resource lookup is not supported in YAML- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Advanced
Filter EventSubscription Advanced Filter Args A
advanced_filterblock as defined below.- Advanced
Filtering boolOn Arrays Enabled Specifies whether advanced filters should be evaluated against an array of values instead of expecting a singular value. Defaults to
false.- Azure
Function EventEndpoint Subscription Azure Function Endpoint Args An
azure_function_endpointblock as defined below.- Dead
Letter EventIdentity Subscription Dead Letter Identity Args A
dead_letter_identityblock as defined below.- Delivery
Identity EventSubscription Delivery Identity Args A
delivery_identityblock as defined below.- Delivery
Properties List<EventSubscription Delivery Property Args> One or more
delivery_propertyblocks as defined below.- Event
Delivery stringSchema Specifies the event delivery schema for the event subscription. Possible values include:
EventGridSchema,CloudEventSchemaV1_0,CustomInputSchema. Defaults toEventGridSchema. Changing this forces a new resource to be created.- Eventhub
Endpoint stringId Specifies the id where the Event Hub is located.
- Expiration
Time stringUtc Specifies the expiration time of the event subscription (Datetime Format
RFC 3339).- Hybrid
Connection stringEndpoint Id Specifies the id where the Hybrid Connection is located.
- Included
Event List<string>Types A list of applicable event types that need to be part of the event subscription.
- Labels List<string>
A list of labels to assign to the event subscription.
- Name string
Specifies the name of the EventGrid Event Subscription resource. Changing this forces a new resource to be created.
- Retry
Policy EventSubscription Retry Policy Args A
retry_policyblock as defined below.- Scope string
Specifies the scope at which the EventGrid Event Subscription should be created. Changing this forces a new resource to be created.
- Service
Bus stringQueue Endpoint Id Specifies the id where the Service Bus Queue is located.
- Service
Bus stringTopic Endpoint Id Specifies the id where the Service Bus Topic is located.
- Storage
Blob EventDead Letter Destination Subscription Storage Blob Dead Letter Destination Args A
storage_blob_dead_letter_destinationblock as defined below.- Storage
Queue EventEndpoint Subscription Storage Queue Endpoint Args A
storage_queue_endpointblock as defined below.- Subject
Filter EventSubscription Subject Filter Args A
subject_filterblock as defined below.- Webhook
Endpoint EventSubscription Webhook Endpoint Args A
webhook_endpointblock as defined below.
- Advanced
Filter EventSubscription Advanced Filter Args A
advanced_filterblock as defined below.- Advanced
Filtering boolOn Arrays Enabled Specifies whether advanced filters should be evaluated against an array of values instead of expecting a singular value. Defaults to
false.- Azure
Function EventEndpoint Subscription Azure Function Endpoint Args An
azure_function_endpointblock as defined below.- Dead
Letter EventIdentity Subscription Dead Letter Identity Args A
dead_letter_identityblock as defined below.- Delivery
Identity EventSubscription Delivery Identity Args A
delivery_identityblock as defined below.- Delivery
Properties []EventSubscription Delivery Property Args One or more
delivery_propertyblocks as defined below.- Event
Delivery stringSchema Specifies the event delivery schema for the event subscription. Possible values include:
EventGridSchema,CloudEventSchemaV1_0,CustomInputSchema. Defaults toEventGridSchema. Changing this forces a new resource to be created.- Eventhub
Endpoint stringId Specifies the id where the Event Hub is located.
- Expiration
Time stringUtc Specifies the expiration time of the event subscription (Datetime Format
RFC 3339).- Hybrid
Connection stringEndpoint Id Specifies the id where the Hybrid Connection is located.
- Included
Event []stringTypes A list of applicable event types that need to be part of the event subscription.
- Labels []string
A list of labels to assign to the event subscription.
- Name string
Specifies the name of the EventGrid Event Subscription resource. Changing this forces a new resource to be created.
- Retry
Policy EventSubscription Retry Policy Args A
retry_policyblock as defined below.- Scope string
Specifies the scope at which the EventGrid Event Subscription should be created. Changing this forces a new resource to be created.
- Service
Bus stringQueue Endpoint Id Specifies the id where the Service Bus Queue is located.
- Service
Bus stringTopic Endpoint Id Specifies the id where the Service Bus Topic is located.
- Storage
Blob EventDead Letter Destination Subscription Storage Blob Dead Letter Destination Args A
storage_blob_dead_letter_destinationblock as defined below.- Storage
Queue EventEndpoint Subscription Storage Queue Endpoint Args A
storage_queue_endpointblock as defined below.- Subject
Filter EventSubscription Subject Filter Args A
subject_filterblock as defined below.- Webhook
Endpoint EventSubscription Webhook Endpoint Args A
webhook_endpointblock as defined below.
- advanced
Filter EventSubscription Advanced Filter Args A
advanced_filterblock as defined below.- advanced
Filtering BooleanOn Arrays Enabled Specifies whether advanced filters should be evaluated against an array of values instead of expecting a singular value. Defaults to
false.- azure
Function EventEndpoint Subscription Azure Function Endpoint Args An
azure_function_endpointblock as defined below.- dead
Letter EventIdentity Subscription Dead Letter Identity Args A
dead_letter_identityblock as defined below.- delivery
Identity EventSubscription Delivery Identity Args A
delivery_identityblock as defined below.- delivery
Properties List<EventSubscription Delivery Property Args> One or more
delivery_propertyblocks as defined below.- event
Delivery StringSchema Specifies the event delivery schema for the event subscription. Possible values include:
EventGridSchema,CloudEventSchemaV1_0,CustomInputSchema. Defaults toEventGridSchema. Changing this forces a new resource to be created.- eventhub
Endpoint StringId Specifies the id where the Event Hub is located.
- expiration
Time StringUtc Specifies the expiration time of the event subscription (Datetime Format
RFC 3339).- hybrid
Connection StringEndpoint Id Specifies the id where the Hybrid Connection is located.
- included
Event List<String>Types A list of applicable event types that need to be part of the event subscription.
- labels List<String>
A list of labels to assign to the event subscription.
- name String
Specifies the name of the EventGrid Event Subscription resource. Changing this forces a new resource to be created.
- retry
Policy EventSubscription Retry Policy Args A
retry_policyblock as defined below.- scope String
Specifies the scope at which the EventGrid Event Subscription should be created. Changing this forces a new resource to be created.
- service
Bus StringQueue Endpoint Id Specifies the id where the Service Bus Queue is located.
- service
Bus StringTopic Endpoint Id Specifies the id where the Service Bus Topic is located.
- storage
Blob EventDead Letter Destination Subscription Storage Blob Dead Letter Destination Args A
storage_blob_dead_letter_destinationblock as defined below.- storage
Queue EventEndpoint Subscription Storage Queue Endpoint Args A
storage_queue_endpointblock as defined below.- subject
Filter EventSubscription Subject Filter Args A
subject_filterblock as defined below.- webhook
Endpoint EventSubscription Webhook Endpoint Args A
webhook_endpointblock as defined below.
- advanced
Filter EventSubscription Advanced Filter Args A
advanced_filterblock as defined below.- advanced
Filtering booleanOn Arrays Enabled Specifies whether advanced filters should be evaluated against an array of values instead of expecting a singular value. Defaults to
false.- azure
Function EventEndpoint Subscription Azure Function Endpoint Args An
azure_function_endpointblock as defined below.- dead
Letter EventIdentity Subscription Dead Letter Identity Args A
dead_letter_identityblock as defined below.- delivery
Identity EventSubscription Delivery Identity Args A
delivery_identityblock as defined below.- delivery
Properties EventSubscription Delivery Property Args[] One or more
delivery_propertyblocks as defined below.- event
Delivery stringSchema Specifies the event delivery schema for the event subscription. Possible values include:
EventGridSchema,CloudEventSchemaV1_0,CustomInputSchema. Defaults toEventGridSchema. Changing this forces a new resource to be created.- eventhub
Endpoint stringId Specifies the id where the Event Hub is located.
- expiration
Time stringUtc Specifies the expiration time of the event subscription (Datetime Format
RFC 3339).- hybrid
Connection stringEndpoint Id Specifies the id where the Hybrid Connection is located.
- included
Event string[]Types A list of applicable event types that need to be part of the event subscription.
- labels string[]
A list of labels to assign to the event subscription.
- name string
Specifies the name of the EventGrid Event Subscription resource. Changing this forces a new resource to be created.
- retry
Policy EventSubscription Retry Policy Args A
retry_policyblock as defined below.- scope string
Specifies the scope at which the EventGrid Event Subscription should be created. Changing this forces a new resource to be created.
- service
Bus stringQueue Endpoint Id Specifies the id where the Service Bus Queue is located.
- service
Bus stringTopic Endpoint Id Specifies the id where the Service Bus Topic is located.
- storage
Blob EventDead Letter Destination Subscription Storage Blob Dead Letter Destination Args A
storage_blob_dead_letter_destinationblock as defined below.- storage
Queue EventEndpoint Subscription Storage Queue Endpoint Args A
storage_queue_endpointblock as defined below.- subject
Filter EventSubscription Subject Filter Args A
subject_filterblock as defined below.- webhook
Endpoint EventSubscription Webhook Endpoint Args A
webhook_endpointblock as defined below.
- advanced_
filter EventSubscription Advanced Filter Args A
advanced_filterblock as defined below.- advanced_
filtering_ boolon_ arrays_ enabled Specifies whether advanced filters should be evaluated against an array of values instead of expecting a singular value. Defaults to
false.- azure_
function_ Eventendpoint Subscription Azure Function Endpoint Args An
azure_function_endpointblock as defined below.- dead_
letter_ Eventidentity Subscription Dead Letter Identity Args A
dead_letter_identityblock as defined below.- delivery_
identity EventSubscription Delivery Identity Args A
delivery_identityblock as defined below.- delivery_
properties Sequence[EventSubscription Delivery Property Args] One or more
delivery_propertyblocks as defined below.- event_
delivery_ strschema Specifies the event delivery schema for the event subscription. Possible values include:
EventGridSchema,CloudEventSchemaV1_0,CustomInputSchema. Defaults toEventGridSchema. Changing this forces a new resource to be created.- eventhub_
endpoint_ strid Specifies the id where the Event Hub is located.
- expiration_
time_ strutc Specifies the expiration time of the event subscription (Datetime Format
RFC 3339).- hybrid_
connection_ strendpoint_ id Specifies the id where the Hybrid Connection is located.
- included_
event_ Sequence[str]types A list of applicable event types that need to be part of the event subscription.
- labels Sequence[str]
A list of labels to assign to the event subscription.
- name str
Specifies the name of the EventGrid Event Subscription resource. Changing this forces a new resource to be created.
- retry_
policy EventSubscription Retry Policy Args A
retry_policyblock as defined below.- scope str
Specifies the scope at which the EventGrid Event Subscription should be created. Changing this forces a new resource to be created.
- service_
bus_ strqueue_ endpoint_ id Specifies the id where the Service Bus Queue is located.
- service_
bus_ strtopic_ endpoint_ id Specifies the id where the Service Bus Topic is located.
- storage_
blob_ Eventdead_ letter_ destination Subscription Storage Blob Dead Letter Destination Args A
storage_blob_dead_letter_destinationblock as defined below.- storage_
queue_ Eventendpoint Subscription Storage Queue Endpoint Args A
storage_queue_endpointblock as defined below.- subject_
filter EventSubscription Subject Filter Args A
subject_filterblock as defined below.- webhook_
endpoint EventSubscription Webhook Endpoint Args A
webhook_endpointblock as defined below.
- advanced
Filter Property Map A
advanced_filterblock as defined below.- advanced
Filtering BooleanOn Arrays Enabled Specifies whether advanced filters should be evaluated against an array of values instead of expecting a singular value. Defaults to
false.- azure
Function Property MapEndpoint An
azure_function_endpointblock as defined below.- dead
Letter Property MapIdentity A
dead_letter_identityblock as defined below.- delivery
Identity Property Map A
delivery_identityblock as defined below.- delivery
Properties List<Property Map> One or more
delivery_propertyblocks as defined below.- event
Delivery StringSchema Specifies the event delivery schema for the event subscription. Possible values include:
EventGridSchema,CloudEventSchemaV1_0,CustomInputSchema. Defaults toEventGridSchema. Changing this forces a new resource to be created.- eventhub
Endpoint StringId Specifies the id where the Event Hub is located.
- expiration
Time StringUtc Specifies the expiration time of the event subscription (Datetime Format
RFC 3339).- hybrid
Connection StringEndpoint Id Specifies the id where the Hybrid Connection is located.
- included
Event List<String>Types A list of applicable event types that need to be part of the event subscription.
- labels List<String>
A list of labels to assign to the event subscription.
- name String
Specifies the name of the EventGrid Event Subscription resource. Changing this forces a new resource to be created.
- retry
Policy Property Map A
retry_policyblock as defined below.- scope String
Specifies the scope at which the EventGrid Event Subscription should be created. Changing this forces a new resource to be created.
- service
Bus StringQueue Endpoint Id Specifies the id where the Service Bus Queue is located.
- service
Bus StringTopic Endpoint Id Specifies the id where the Service Bus Topic is located.
- storage
Blob Property MapDead Letter Destination A
storage_blob_dead_letter_destinationblock as defined below.- storage
Queue Property MapEndpoint A
storage_queue_endpointblock as defined below.- subject
Filter Property Map A
subject_filterblock as defined below.- webhook
Endpoint Property Map A
webhook_endpointblock as defined below.
Supporting Types
EventSubscriptionAdvancedFilter
- Bool
Equals List<EventSubscription Advanced Filter Bool Equal> Compares a value of an event using a single boolean value.
- Is
Not List<EventNulls Subscription Advanced Filter Is Not Null> Evaluates if a value of an event isn't NULL or undefined.
- Is
Null List<EventOr Undefineds Subscription Advanced Filter Is Null Or Undefined> Evaluates if a value of an event is NULL or undefined.
- Number
Greater List<EventThan Or Equals Subscription Advanced Filter Number Greater Than Or Equal> Compares a value of an event using a single floating point number.
- Number
Greater List<EventThans Subscription Advanced Filter Number Greater Than> Compares a value of an event using a single floating point number.
- Number
In List<EventRanges Subscription Advanced Filter Number In Range> Compares a value of an event using multiple floating point number ranges.
- Number
Ins List<EventSubscription Advanced Filter Number In> Compares a value of an event using multiple floating point numbers.
- Number
Less List<EventThan Or Equals Subscription Advanced Filter Number Less Than Or Equal> Compares a value of an event using a single floating point number.
- Number
Less List<EventThans Subscription Advanced Filter Number Less Than> Compares a value of an event using a single floating point number.
- Number
Not List<EventIn Ranges Subscription Advanced Filter Number Not In Range> Compares a value of an event using multiple floating point number ranges.
- Number
Not List<EventIns Subscription Advanced Filter Number Not In> Compares a value of an event using multiple floating point numbers.
- String
Begins List<EventWiths Subscription Advanced Filter String Begins With> Compares a value of an event using multiple string values.
- String
Contains List<EventSubscription Advanced Filter String Contain> Compares a value of an event using multiple string values.
- String
Ends List<EventWiths Subscription Advanced Filter String Ends With> Compares a value of an event using multiple string values.
- String
Ins List<EventSubscription Advanced Filter String In> Compares a value of an event using multiple string values.
- String
Not List<EventBegins Withs Subscription Advanced Filter String Not Begins With> Compares a value of an event using multiple string values.
- String
Not List<EventContains Subscription Advanced Filter String Not Contain> Compares a value of an event using multiple string values.
- String
Not List<EventEnds Withs Subscription Advanced Filter String Not Ends With> Compares a value of an event using multiple string values.
- String
Not List<EventIns Subscription Advanced Filter String Not In> Compares a value of an event using multiple string values.
- Bool
Equals []EventSubscription Advanced Filter Bool Equal Compares a value of an event using a single boolean value.
- Is
Not []EventNulls Subscription Advanced Filter Is Not Null Evaluates if a value of an event isn't NULL or undefined.
- Is
Null []EventOr Undefineds Subscription Advanced Filter Is Null Or Undefined Evaluates if a value of an event is NULL or undefined.
- Number
Greater []EventThan Or Equals Subscription Advanced Filter Number Greater Than Or Equal Compares a value of an event using a single floating point number.
- Number
Greater []EventThans Subscription Advanced Filter Number Greater Than Compares a value of an event using a single floating point number.
- Number
In []EventRanges Subscription Advanced Filter Number In Range Compares a value of an event using multiple floating point number ranges.
- Number
Ins []EventSubscription Advanced Filter Number In Compares a value of an event using multiple floating point numbers.
- Number
Less []EventThan Or Equals Subscription Advanced Filter Number Less Than Or Equal Compares a value of an event using a single floating point number.
- Number
Less []EventThans Subscription Advanced Filter Number Less Than Compares a value of an event using a single floating point number.
- Number
Not []EventIn Ranges Subscription Advanced Filter Number Not In Range Compares a value of an event using multiple floating point number ranges.
- Number
Not []EventIns Subscription Advanced Filter Number Not In Compares a value of an event using multiple floating point numbers.
- String
Begins []EventWiths Subscription Advanced Filter String Begins With Compares a value of an event using multiple string values.
- String
Contains []EventSubscription Advanced Filter String Contain Compares a value of an event using multiple string values.
- String
Ends []EventWiths Subscription Advanced Filter String Ends With Compares a value of an event using multiple string values.
- String
Ins []EventSubscription Advanced Filter String In Compares a value of an event using multiple string values.
- String
Not []EventBegins Withs Subscription Advanced Filter String Not Begins With Compares a value of an event using multiple string values.
- String
Not []EventContains Subscription Advanced Filter String Not Contain Compares a value of an event using multiple string values.
- String
Not []EventEnds Withs Subscription Advanced Filter String Not Ends With Compares a value of an event using multiple string values.
- String
Not []EventIns Subscription Advanced Filter String Not In Compares a value of an event using multiple string values.
- bool
Equals List<EventSubscription Advanced Filter Bool Equal> Compares a value of an event using a single boolean value.
- is
Not List<EventNulls Subscription Advanced Filter Is Not Null> Evaluates if a value of an event isn't NULL or undefined.
- is
Null List<EventOr Undefineds Subscription Advanced Filter Is Null Or Undefined> Evaluates if a value of an event is NULL or undefined.
- number
Greater List<EventThan Or Equals Subscription Advanced Filter Number Greater Than Or Equal> Compares a value of an event using a single floating point number.
- number
Greater List<EventThans Subscription Advanced Filter Number Greater Than> Compares a value of an event using a single floating point number.
- number
In List<EventRanges Subscription Advanced Filter Number In Range> Compares a value of an event using multiple floating point number ranges.
- number
Ins List<EventSubscription Advanced Filter Number In> Compares a value of an event using multiple floating point numbers.
- number
Less List<EventThan Or Equals Subscription Advanced Filter Number Less Than Or Equal> Compares a value of an event using a single floating point number.
- number
Less List<EventThans Subscription Advanced Filter Number Less Than> Compares a value of an event using a single floating point number.
- number
Not List<EventIn Ranges Subscription Advanced Filter Number Not In Range> Compares a value of an event using multiple floating point number ranges.
- number
Not List<EventIns Subscription Advanced Filter Number Not In> Compares a value of an event using multiple floating point numbers.
- string
Begins List<EventWiths Subscription Advanced Filter String Begins With> Compares a value of an event using multiple string values.
- string
Contains List<EventSubscription Advanced Filter String Contain> Compares a value of an event using multiple string values.
- string
Ends List<EventWiths Subscription Advanced Filter String Ends With> Compares a value of an event using multiple string values.
- string
Ins List<EventSubscription Advanced Filter String In> Compares a value of an event using multiple string values.
- string
Not List<EventBegins Withs Subscription Advanced Filter String Not Begins With> Compares a value of an event using multiple string values.
- string
Not List<EventContains Subscription Advanced Filter String Not Contain> Compares a value of an event using multiple string values.
- string
Not List<EventEnds Withs Subscription Advanced Filter String Not Ends With> Compares a value of an event using multiple string values.
- string
Not List<EventIns Subscription Advanced Filter String Not In> Compares a value of an event using multiple string values.
- bool
Equals EventSubscription Advanced Filter Bool Equal[] Compares a value of an event using a single boolean value.
- is
Not EventNulls Subscription Advanced Filter Is Not Null[] Evaluates if a value of an event isn't NULL or undefined.
- is
Null EventOr Undefineds Subscription Advanced Filter Is Null Or Undefined[] Evaluates if a value of an event is NULL or undefined.
- number
Greater EventThan Or Equals Subscription Advanced Filter Number Greater Than Or Equal[] Compares a value of an event using a single floating point number.
- number
Greater EventThans Subscription Advanced Filter Number Greater Than[] Compares a value of an event using a single floating point number.
- number
In EventRanges Subscription Advanced Filter Number In Range[] Compares a value of an event using multiple floating point number ranges.
- number
Ins EventSubscription Advanced Filter Number In[] Compares a value of an event using multiple floating point numbers.
- number
Less EventThan Or Equals Subscription Advanced Filter Number Less Than Or Equal[] Compares a value of an event using a single floating point number.
- number
Less EventThans Subscription Advanced Filter Number Less Than[] Compares a value of an event using a single floating point number.
- number
Not EventIn Ranges Subscription Advanced Filter Number Not In Range[] Compares a value of an event using multiple floating point number ranges.
- number
Not EventIns Subscription Advanced Filter Number Not In[] Compares a value of an event using multiple floating point numbers.
- string
Begins EventWiths Subscription Advanced Filter String Begins With[] Compares a value of an event using multiple string values.
- string
Contains EventSubscription Advanced Filter String Contain[] Compares a value of an event using multiple string values.
- string
Ends EventWiths Subscription Advanced Filter String Ends With[] Compares a value of an event using multiple string values.
- string
Ins EventSubscription Advanced Filter String In[] Compares a value of an event using multiple string values.
- string
Not EventBegins Withs Subscription Advanced Filter String Not Begins With[] Compares a value of an event using multiple string values.
- string
Not EventContains Subscription Advanced Filter String Not Contain[] Compares a value of an event using multiple string values.
- string
Not EventEnds Withs Subscription Advanced Filter String Not Ends With[] Compares a value of an event using multiple string values.
- string
Not EventIns Subscription Advanced Filter String Not In[] Compares a value of an event using multiple string values.
- bool_
equals Sequence[EventSubscription Advanced Filter Bool Equal] Compares a value of an event using a single boolean value.
- is_
not_ Sequence[Eventnulls Subscription Advanced Filter Is Not Null] Evaluates if a value of an event isn't NULL or undefined.
- is_
null_ Sequence[Eventor_ undefineds Subscription Advanced Filter Is Null Or Undefined] Evaluates if a value of an event is NULL or undefined.
- number_
greater_ Sequence[Eventthan_ or_ equals Subscription Advanced Filter Number Greater Than Or Equal] Compares a value of an event using a single floating point number.
- number_
greater_ Sequence[Eventthans Subscription Advanced Filter Number Greater Than] Compares a value of an event using a single floating point number.
- number_
in_ Sequence[Eventranges Subscription Advanced Filter Number In Range] Compares a value of an event using multiple floating point number ranges.
- number_
ins Sequence[EventSubscription Advanced Filter Number In] Compares a value of an event using multiple floating point numbers.
- number_
less_ Sequence[Eventthan_ or_ equals Subscription Advanced Filter Number Less Than Or Equal] Compares a value of an event using a single floating point number.
- number_
less_ Sequence[Eventthans Subscription Advanced Filter Number Less Than] Compares a value of an event using a single floating point number.
- number_
not_ Sequence[Eventin_ ranges Subscription Advanced Filter Number Not In Range] Compares a value of an event using multiple floating point number ranges.
- number_
not_ Sequence[Eventins Subscription Advanced Filter Number Not In] Compares a value of an event using multiple floating point numbers.
- string_
begins_ Sequence[Eventwiths Subscription Advanced Filter String Begins With] Compares a value of an event using multiple string values.
- string_
contains Sequence[EventSubscription Advanced Filter String Contain] Compares a value of an event using multiple string values.
- string_
ends_ Sequence[Eventwiths Subscription Advanced Filter String Ends With] Compares a value of an event using multiple string values.
- string_
ins Sequence[EventSubscription Advanced Filter String In] Compares a value of an event using multiple string values.
- string_
not_ Sequence[Eventbegins_ withs Subscription Advanced Filter String Not Begins With] Compares a value of an event using multiple string values.
- string_
not_ Sequence[Eventcontains Subscription Advanced Filter String Not Contain] Compares a value of an event using multiple string values.
- string_
not_ Sequence[Eventends_ withs Subscription Advanced Filter String Not Ends With] Compares a value of an event using multiple string values.
- string_
not_ Sequence[Eventins Subscription Advanced Filter String Not In] Compares a value of an event using multiple string values.
- bool
Equals List<Property Map> Compares a value of an event using a single boolean value.
- is
Not List<Property Map>Nulls Evaluates if a value of an event isn't NULL or undefined.
- is
Null List<Property Map>Or Undefineds Evaluates if a value of an event is NULL or undefined.
- number
Greater List<Property Map>Than Or Equals Compares a value of an event using a single floating point number.
- number
Greater List<Property Map>Thans Compares a value of an event using a single floating point number.
- number
In List<Property Map>Ranges Compares a value of an event using multiple floating point number ranges.
- number
Ins List<Property Map> Compares a value of an event using multiple floating point numbers.
- number
Less List<Property Map>Than Or Equals Compares a value of an event using a single floating point number.
- number
Less List<Property Map>Thans Compares a value of an event using a single floating point number.
- number
Not List<Property Map>In Ranges Compares a value of an event using multiple floating point number ranges.
- number
Not List<Property Map>Ins Compares a value of an event using multiple floating point numbers.
- string
Begins List<Property Map>Withs Compares a value of an event using multiple string values.
- string
Contains List<Property Map> Compares a value of an event using multiple string values.
- string
Ends List<Property Map>Withs Compares a value of an event using multiple string values.
- string
Ins List<Property Map> Compares a value of an event using multiple string values.
- string
Not List<Property Map>Begins Withs Compares a value of an event using multiple string values.
- string
Not List<Property Map>Contains Compares a value of an event using multiple string values.
- string
Not List<Property Map>Ends Withs Compares a value of an event using multiple string values.
- string
Not List<Property Map>Ins Compares a value of an event using multiple string values.
EventSubscriptionAdvancedFilterBoolEqual
EventSubscriptionAdvancedFilterIsNotNull
- Key string
Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.
- Key string
Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.
- key String
Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.
- key string
Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.
- key str
Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.
- key String
Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.
EventSubscriptionAdvancedFilterIsNullOrUndefined
- Key string
Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.
- Key string
Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.
- key String
Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.
- key string
Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.
- key str
Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.
- key String
Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.
EventSubscriptionAdvancedFilterNumberGreaterThan
EventSubscriptionAdvancedFilterNumberGreaterThanOrEqual
EventSubscriptionAdvancedFilterNumberIn
EventSubscriptionAdvancedFilterNumberInRange
EventSubscriptionAdvancedFilterNumberLessThan
EventSubscriptionAdvancedFilterNumberLessThanOrEqual
EventSubscriptionAdvancedFilterNumberNotIn
EventSubscriptionAdvancedFilterNumberNotInRange
EventSubscriptionAdvancedFilterStringBeginsWith
EventSubscriptionAdvancedFilterStringContain
EventSubscriptionAdvancedFilterStringEndsWith
EventSubscriptionAdvancedFilterStringIn
EventSubscriptionAdvancedFilterStringNotBeginsWith
EventSubscriptionAdvancedFilterStringNotContain
EventSubscriptionAdvancedFilterStringNotEndsWith
EventSubscriptionAdvancedFilterStringNotIn
EventSubscriptionAzureFunctionEndpoint
- Function
Id string Specifies the ID of the Function where the Event Subscription will receive events. This must be the functions ID in format {function_app.id}/functions/{name}.
- Max
Events intPer Batch Maximum number of events per batch.
- Preferred
Batch intSize In Kilobytes Preferred batch size in Kilobytes.
- Function
Id string Specifies the ID of the Function where the Event Subscription will receive events. This must be the functions ID in format {function_app.id}/functions/{name}.
- Max
Events intPer Batch Maximum number of events per batch.
- Preferred
Batch intSize In Kilobytes Preferred batch size in Kilobytes.
- function
Id String Specifies the ID of the Function where the Event Subscription will receive events. This must be the functions ID in format {function_app.id}/functions/{name}.
- max
Events IntegerPer Batch Maximum number of events per batch.
- preferred
Batch IntegerSize In Kilobytes Preferred batch size in Kilobytes.
- function
Id string Specifies the ID of the Function where the Event Subscription will receive events. This must be the functions ID in format {function_app.id}/functions/{name}.
- max
Events numberPer Batch Maximum number of events per batch.
- preferred
Batch numberSize In Kilobytes Preferred batch size in Kilobytes.
- function_
id str Specifies the ID of the Function where the Event Subscription will receive events. This must be the functions ID in format {function_app.id}/functions/{name}.
- max_
events_ intper_ batch Maximum number of events per batch.
- preferred_
batch_ intsize_ in_ kilobytes Preferred batch size in Kilobytes.
- function
Id String Specifies the ID of the Function where the Event Subscription will receive events. This must be the functions ID in format {function_app.id}/functions/{name}.
- max
Events NumberPer Batch Maximum number of events per batch.
- preferred
Batch NumberSize In Kilobytes Preferred batch size in Kilobytes.
EventSubscriptionDeadLetterIdentity
- Type string
Specifies the type of Managed Service Identity that is used for dead lettering. Allowed value is
SystemAssigned,UserAssigned.- User
Assigned stringIdentity The user identity associated with the resource.
- Type string
Specifies the type of Managed Service Identity that is used for dead lettering. Allowed value is
SystemAssigned,UserAssigned.- User
Assigned stringIdentity The user identity associated with the resource.
- type String
Specifies the type of Managed Service Identity that is used for dead lettering. Allowed value is
SystemAssigned,UserAssigned.- user
Assigned StringIdentity The user identity associated with the resource.
- type string
Specifies the type of Managed Service Identity that is used for dead lettering. Allowed value is
SystemAssigned,UserAssigned.- user
Assigned stringIdentity The user identity associated with the resource.
- type str
Specifies the type of Managed Service Identity that is used for dead lettering. Allowed value is
SystemAssigned,UserAssigned.- user_
assigned_ stridentity The user identity associated with the resource.
- type String
Specifies the type of Managed Service Identity that is used for dead lettering. Allowed value is
SystemAssigned,UserAssigned.- user
Assigned StringIdentity The user identity associated with the resource.
EventSubscriptionDeliveryIdentity
- Type string
Specifies the type of Managed Service Identity that is used for event delivery. Allowed value is
SystemAssigned,UserAssigned.- User
Assigned stringIdentity The user identity associated with the resource.
- Type string
Specifies the type of Managed Service Identity that is used for event delivery. Allowed value is
SystemAssigned,UserAssigned.- User
Assigned stringIdentity The user identity associated with the resource.
- type String
Specifies the type of Managed Service Identity that is used for event delivery. Allowed value is
SystemAssigned,UserAssigned.- user
Assigned StringIdentity The user identity associated with the resource.
- type string
Specifies the type of Managed Service Identity that is used for event delivery. Allowed value is
SystemAssigned,UserAssigned.- user
Assigned stringIdentity The user identity associated with the resource.
- type str
Specifies the type of Managed Service Identity that is used for event delivery. Allowed value is
SystemAssigned,UserAssigned.- user_
assigned_ stridentity The user identity associated with the resource.
- type String
Specifies the type of Managed Service Identity that is used for event delivery. Allowed value is
SystemAssigned,UserAssigned.- user
Assigned StringIdentity The user identity associated with the resource.
EventSubscriptionDeliveryProperty
- Header
Name string The name of the header to send on to the destination
- Type string
Either
StaticorDynamic- Secret bool
True if the
valueis a secret and should be protected, otherwise false. If True, then this value won't be returned from Azure API calls- Source
Field string If the
typeisDynamic, then provide the payload field to be used as the value. Valid source fields differ by subscription type.- Value string
If the
typeisStatic, then provide the value to use
- Header
Name string The name of the header to send on to the destination
- Type string
Either
StaticorDynamic- Secret bool
True if the
valueis a secret and should be protected, otherwise false. If True, then this value won't be returned from Azure API calls- Source
Field string If the
typeisDynamic, then provide the payload field to be used as the value. Valid source fields differ by subscription type.- Value string
If the
typeisStatic, then provide the value to use
- header
Name String The name of the header to send on to the destination
- type String
Either
StaticorDynamic- secret Boolean
True if the
valueis a secret and should be protected, otherwise false. If True, then this value won't be returned from Azure API calls- source
Field String If the
typeisDynamic, then provide the payload field to be used as the value. Valid source fields differ by subscription type.- value String
If the
typeisStatic, then provide the value to use
- header
Name string The name of the header to send on to the destination
- type string
Either
StaticorDynamic- secret boolean
True if the
valueis a secret and should be protected, otherwise false. If True, then this value won't be returned from Azure API calls- source
Field string If the
typeisDynamic, then provide the payload field to be used as the value. Valid source fields differ by subscription type.- value string
If the
typeisStatic, then provide the value to use
- header_
name str The name of the header to send on to the destination
- type str
Either
StaticorDynamic- secret bool
True if the
valueis a secret and should be protected, otherwise false. If True, then this value won't be returned from Azure API calls- source_
field str If the
typeisDynamic, then provide the payload field to be used as the value. Valid source fields differ by subscription type.- value str
If the
typeisStatic, then provide the value to use
- header
Name String The name of the header to send on to the destination
- type String
Either
StaticorDynamic- secret Boolean
True if the
valueis a secret and should be protected, otherwise false. If True, then this value won't be returned from Azure API calls- source
Field String If the
typeisDynamic, then provide the payload field to be used as the value. Valid source fields differ by subscription type.- value String
If the
typeisStatic, then provide the value to use
EventSubscriptionRetryPolicy
- Event
Time intTo Live Specifies the time to live (in minutes) for events. Supported range is
1to1440. See official documentation for more details.- Max
Delivery intAttempts Specifies the maximum number of delivery retry attempts for events.
- Event
Time intTo Live Specifies the time to live (in minutes) for events. Supported range is
1to1440. See official documentation for more details.- Max
Delivery intAttempts Specifies the maximum number of delivery retry attempts for events.
- event
Time IntegerTo Live Specifies the time to live (in minutes) for events. Supported range is
1to1440. See official documentation for more details.- max
Delivery IntegerAttempts Specifies the maximum number of delivery retry attempts for events.
- event
Time numberTo Live Specifies the time to live (in minutes) for events. Supported range is
1to1440. See official documentation for more details.- max
Delivery numberAttempts Specifies the maximum number of delivery retry attempts for events.
- event_
time_ intto_ live Specifies the time to live (in minutes) for events. Supported range is
1to1440. See official documentation for more details.- max_
delivery_ intattempts Specifies the maximum number of delivery retry attempts for events.
- event
Time NumberTo Live Specifies the time to live (in minutes) for events. Supported range is
1to1440. See official documentation for more details.- max
Delivery NumberAttempts Specifies the maximum number of delivery retry attempts for events.
EventSubscriptionStorageBlobDeadLetterDestination
- Storage
Account stringId Specifies the id of the storage account id where the storage blob is located.
- Storage
Blob stringContainer Name Specifies the name of the Storage blob container that is the destination of the deadletter events.
- Storage
Account stringId Specifies the id of the storage account id where the storage blob is located.
- Storage
Blob stringContainer Name Specifies the name of the Storage blob container that is the destination of the deadletter events.
- storage
Account StringId Specifies the id of the storage account id where the storage blob is located.
- storage
Blob StringContainer Name Specifies the name of the Storage blob container that is the destination of the deadletter events.
- storage
Account stringId Specifies the id of the storage account id where the storage blob is located.
- storage
Blob stringContainer Name Specifies the name of the Storage blob container that is the destination of the deadletter events.
- storage_
account_ strid Specifies the id of the storage account id where the storage blob is located.
- storage_
blob_ strcontainer_ name Specifies the name of the Storage blob container that is the destination of the deadletter events.
- storage
Account StringId Specifies the id of the storage account id where the storage blob is located.
- storage
Blob StringContainer Name Specifies the name of the Storage blob container that is the destination of the deadletter events.
EventSubscriptionStorageQueueEndpoint
- Queue
Name string Specifies the name of the storage queue where the Event Subscription will receive events.
- Storage
Account stringId Specifies the id of the storage account id where the storage queue is located.
- Queue
Message intTime To Live In Seconds Storage queue message time to live in seconds.
- Queue
Name string Specifies the name of the storage queue where the Event Subscription will receive events.
- Storage
Account stringId Specifies the id of the storage account id where the storage queue is located.
- Queue
Message intTime To Live In Seconds Storage queue message time to live in seconds.
- queue
Name String Specifies the name of the storage queue where the Event Subscription will receive events.
- storage
Account StringId Specifies the id of the storage account id where the storage queue is located.
- queue
Message IntegerTime To Live In Seconds Storage queue message time to live in seconds.
- queue
Name string Specifies the name of the storage queue where the Event Subscription will receive events.
- storage
Account stringId Specifies the id of the storage account id where the storage queue is located.
- queue
Message numberTime To Live In Seconds Storage queue message time to live in seconds.
- queue_
name str Specifies the name of the storage queue where the Event Subscription will receive events.
- storage_
account_ strid Specifies the id of the storage account id where the storage queue is located.
- queue_
message_ inttime_ to_ live_ in_ seconds Storage queue message time to live in seconds.
- queue
Name String Specifies the name of the storage queue where the Event Subscription will receive events.
- storage
Account StringId Specifies the id of the storage account id where the storage queue is located.
- queue
Message NumberTime To Live In Seconds Storage queue message time to live in seconds.
EventSubscriptionSubjectFilter
- Case
Sensitive bool Specifies if
subject_begins_withandsubject_ends_withcase sensitive. This value- Subject
Begins stringWith A string to filter events for an event subscription based on a resource path prefix.
- Subject
Ends stringWith A string to filter events for an event subscription based on a resource path suffix.
- Case
Sensitive bool Specifies if
subject_begins_withandsubject_ends_withcase sensitive. This value- Subject
Begins stringWith A string to filter events for an event subscription based on a resource path prefix.
- Subject
Ends stringWith A string to filter events for an event subscription based on a resource path suffix.
- case
Sensitive Boolean Specifies if
subject_begins_withandsubject_ends_withcase sensitive. This value- subject
Begins StringWith A string to filter events for an event subscription based on a resource path prefix.
- subject
Ends StringWith A string to filter events for an event subscription based on a resource path suffix.
- case
Sensitive boolean Specifies if
subject_begins_withandsubject_ends_withcase sensitive. This value- subject
Begins stringWith A string to filter events for an event subscription based on a resource path prefix.
- subject
Ends stringWith A string to filter events for an event subscription based on a resource path suffix.
- case_
sensitive bool Specifies if
subject_begins_withandsubject_ends_withcase sensitive. This value- subject_
begins_ strwith A string to filter events for an event subscription based on a resource path prefix.
- subject_
ends_ strwith A string to filter events for an event subscription based on a resource path suffix.
- case
Sensitive Boolean Specifies if
subject_begins_withandsubject_ends_withcase sensitive. This value- subject
Begins StringWith A string to filter events for an event subscription based on a resource path prefix.
- subject
Ends StringWith A string to filter events for an event subscription based on a resource path suffix.
EventSubscriptionWebhookEndpoint
- Url string
Specifies the url of the webhook where the Event Subscription will receive events.
- Active
Directory stringApp Id Or Uri The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests.
- Active
Directory stringTenant Id The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests.
- Base
Url string The base url of the webhook where the Event Subscription will receive events.
- Max
Events intPer Batch Maximum number of events per batch.
- Preferred
Batch intSize In Kilobytes Preferred batch size in Kilobytes.
- Url string
Specifies the url of the webhook where the Event Subscription will receive events.
- Active
Directory stringApp Id Or Uri The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests.
- Active
Directory stringTenant Id The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests.
- Base
Url string The base url of the webhook where the Event Subscription will receive events.
- Max
Events intPer Batch Maximum number of events per batch.
- Preferred
Batch intSize In Kilobytes Preferred batch size in Kilobytes.
- url String
Specifies the url of the webhook where the Event Subscription will receive events.
- active
Directory StringApp Id Or Uri The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests.
- active
Directory StringTenant Id The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests.
- base
Url String The base url of the webhook where the Event Subscription will receive events.
- max
Events IntegerPer Batch Maximum number of events per batch.
- preferred
Batch IntegerSize In Kilobytes Preferred batch size in Kilobytes.
- url string
Specifies the url of the webhook where the Event Subscription will receive events.
- active
Directory stringApp Id Or Uri The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests.
- active
Directory stringTenant Id The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests.
- base
Url string The base url of the webhook where the Event Subscription will receive events.
- max
Events numberPer Batch Maximum number of events per batch.
- preferred
Batch numberSize In Kilobytes Preferred batch size in Kilobytes.
- url str
Specifies the url of the webhook where the Event Subscription will receive events.
- active_
directory_ strapp_ id_ or_ uri The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests.
- active_
directory_ strtenant_ id The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests.
- base_
url str The base url of the webhook where the Event Subscription will receive events.
- max_
events_ intper_ batch Maximum number of events per batch.
- preferred_
batch_ intsize_ in_ kilobytes Preferred batch size in Kilobytes.
- url String
Specifies the url of the webhook where the Event Subscription will receive events.
- active
Directory StringApp Id Or Uri The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests.
- active
Directory StringTenant Id The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests.
- base
Url String The base url of the webhook where the Event Subscription will receive events.
- max
Events NumberPer Batch Maximum number of events per batch.
- preferred
Batch NumberSize In Kilobytes Preferred batch size in Kilobytes.
Import
EventGrid Event Subscription’s can be imported using the resource id, e.g.
$ pulumi import azure:eventgrid/eventSubscription:EventSubscription eventSubscription1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.EventGrid/topics/topic1/providers/Microsoft.EventGrid/eventSubscriptions/eventSubscription1
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azurermTerraform Provider.