EventSubscription

Manages an EventGrid Event Subscription

Create a EventSubscription Resource

new EventSubscription(name: string, args: EventSubscriptionArgs, opts?: CustomResourceOptions);

def EventSubscription(resource_name, opts=None, advanced_filter=None, azure_function_endpoint=None, event_delivery_schema=None, eventhub_endpoint=None, eventhub_endpoint_id=None, expiration_time_utc=None, hybrid_connection_endpoint=None, hybrid_connection_endpoint_id=None, included_event_types=None, labels=None, name=None, retry_policy=None, scope=None, service_bus_queue_endpoint_id=None, service_bus_topic_endpoint_id=None, storage_blob_dead_letter_destination=None, storage_queue_endpoint=None, subject_filter=None, topic_name=None, webhook_endpoint=None, __props__=None);

func NewEventSubscription(ctx *Context, name string, args EventSubscriptionArgs, opts ...ResourceOption) (*EventSubscription, error)

public EventSubscription(string name, EventSubscriptionArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

EventSubscription Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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.

AdvancedFilter EventSubscriptionAdvancedFilterArgs

A advanced_filter block as defined below.

AzureFunctionEndpoint EventSubscriptionAzureFunctionEndpointArgs

An azure_function_endpoint block as defined below.

EventDeliverySchema string

Specifies the event delivery schema for the event subscription. Possible values include: EventGridSchema, CloudEventSchemaV1_0, CustomInputSchema. Defaults to EventGridSchema. Changing this forces a new resource to be created.

EventhubEndpoint EventSubscriptionEventhubEndpointArgs

A eventhub_endpoint block as defined below.

Deprecated: Deprecated in favour of eventhub_endpoint_id

EventhubEndpointId string

Specifies the id where the Event Hub is located.

ExpirationTimeUtc string

Specifies the expiration time of the event subscription (Datetime Format RFC 3339).

HybridConnectionEndpoint EventSubscriptionHybridConnectionEndpointArgs

A hybrid_connection_endpoint block as defined below.

Deprecated: Deprecated in favour of hybrid_connection_endpoint_id

HybridConnectionEndpointId string

Specifies the id where the Hybrid Connection is located.

IncludedEventTypes List<string>

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.

RetryPolicy EventSubscriptionRetryPolicyArgs

A retry_policy block as defined below.

ServiceBusQueueEndpointId string

Specifies the id where the Service Bus Queue is located.

ServiceBusTopicEndpointId string

Specifies the id where the Service Bus Topic is located.

StorageBlobDeadLetterDestination EventSubscriptionStorageBlobDeadLetterDestinationArgs

A storage_blob_dead_letter_destination block as defined below.

StorageQueueEndpoint EventSubscriptionStorageQueueEndpointArgs

A storage_queue_endpoint block as defined below.

SubjectFilter EventSubscriptionSubjectFilterArgs

A subject_filter block as defined below.

TopicName string

(Optional) Specifies the name of the topic to associate with the event subscription.

WebhookEndpoint EventSubscriptionWebhookEndpointArgs

A webhook_endpoint block 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.

AdvancedFilter EventSubscriptionAdvancedFilter

A advanced_filter block as defined below.

AzureFunctionEndpoint EventSubscriptionAzureFunctionEndpoint

An azure_function_endpoint block as defined below.

EventDeliverySchema string

EventhubEndpoint EventSubscriptionEventhubEndpoint

A eventhub_endpoint block as defined below.

Deprecated: Deprecated in favour of eventhub_endpoint_id

EventhubEndpointId string

Specifies the id where the Event Hub is located.

ExpirationTimeUtc string

Specifies the expiration time of the event subscription (Datetime Format RFC 3339).

HybridConnectionEndpoint EventSubscriptionHybridConnectionEndpoint

A hybrid_connection_endpoint block as defined below.

Deprecated: Deprecated in favour of hybrid_connection_endpoint_id

HybridConnectionEndpointId string

Specifies the id where the Hybrid Connection is located.

IncludedEventTypes []string

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.

RetryPolicy EventSubscriptionRetryPolicy

A retry_policy block as defined below.

ServiceBusQueueEndpointId string

Specifies the id where the Service Bus Queue is located.

ServiceBusTopicEndpointId string

Specifies the id where the Service Bus Topic is located.

StorageBlobDeadLetterDestination EventSubscriptionStorageBlobDeadLetterDestination

A storage_blob_dead_letter_destination block as defined below.

StorageQueueEndpoint EventSubscriptionStorageQueueEndpoint

A storage_queue_endpoint block as defined below.

SubjectFilter EventSubscriptionSubjectFilter

A subject_filter block as defined below.

TopicName string

(Optional) Specifies the name of the topic to associate with the event subscription.

WebhookEndpoint EventSubscriptionWebhookEndpoint

A webhook_endpoint block 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.

advancedFilter EventSubscriptionAdvancedFilter

A advanced_filter block as defined below.

azureFunctionEndpoint EventSubscriptionAzureFunctionEndpoint

An azure_function_endpoint block as defined below.

eventDeliverySchema string

eventhubEndpoint EventSubscriptionEventhubEndpoint

A eventhub_endpoint block as defined below.

Deprecated: Deprecated in favour of eventhub_endpoint_id

eventhubEndpointId string

Specifies the id where the Event Hub is located.

expirationTimeUtc string

Specifies the expiration time of the event subscription (Datetime Format RFC 3339).

hybridConnectionEndpoint EventSubscriptionHybridConnectionEndpoint

A hybrid_connection_endpoint block as defined below.

Deprecated: Deprecated in favour of hybrid_connection_endpoint_id

hybridConnectionEndpointId string

Specifies the id where the Hybrid Connection is located.

includedEventTypes string[]

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.

retryPolicy EventSubscriptionRetryPolicy

A retry_policy block as defined below.

serviceBusQueueEndpointId string

Specifies the id where the Service Bus Queue is located.

serviceBusTopicEndpointId string

Specifies the id where the Service Bus Topic is located.

storageBlobDeadLetterDestination EventSubscriptionStorageBlobDeadLetterDestination

A storage_blob_dead_letter_destination block as defined below.

storageQueueEndpoint EventSubscriptionStorageQueueEndpoint

A storage_queue_endpoint block as defined below.

subjectFilter EventSubscriptionSubjectFilter

A subject_filter block as defined below.

topicName string

(Optional) Specifies the name of the topic to associate with the event subscription.

webhookEndpoint EventSubscriptionWebhookEndpoint

A webhook_endpoint block 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 Dict[EventSubscriptionAdvancedFilter]

A advanced_filter block as defined below.

azure_function_endpoint Dict[EventSubscriptionAzureFunctionEndpoint]

An azure_function_endpoint block as defined below.

event_delivery_schema str

eventhub_endpoint Dict[EventSubscriptionEventhubEndpoint]

A eventhub_endpoint block as defined below.

Deprecated: Deprecated in favour of eventhub_endpoint_id

eventhub_endpoint_id str

Specifies the id where the Event Hub is located.

expiration_time_utc str

Specifies the expiration time of the event subscription (Datetime Format RFC 3339).

hybrid_connection_endpoint Dict[EventSubscriptionHybridConnectionEndpoint]

A hybrid_connection_endpoint block as defined below.

Deprecated: Deprecated in favour of hybrid_connection_endpoint_id

hybrid_connection_endpoint_id str

Specifies the id where the Hybrid Connection is located.

included_event_types List[str]

A list of applicable event types that need to be part of the event subscription.

labels List[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 Dict[EventSubscriptionRetryPolicy]

A retry_policy block as defined below.

service_bus_queue_endpoint_id str

Specifies the id where the Service Bus Queue is located.

service_bus_topic_endpoint_id str

Specifies the id where the Service Bus Topic is located.

storage_blob_dead_letter_destination Dict[EventSubscriptionStorageBlobDeadLetterDestination]

A storage_blob_dead_letter_destination block as defined below.

storage_queue_endpoint Dict[EventSubscriptionStorageQueueEndpoint]

A storage_queue_endpoint block as defined below.

subject_filter Dict[EventSubscriptionSubjectFilter]

A subject_filter block as defined below.

topic_name str

(Optional) Specifies the name of the topic to associate with the event subscription.

webhook_endpoint Dict[EventSubscriptionWebhookEndpoint]

A webhook_endpoint block 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 str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, advanced_filter=None, azure_function_endpoint=None, event_delivery_schema=None, eventhub_endpoint=None, eventhub_endpoint_id=None, expiration_time_utc=None, hybrid_connection_endpoint=None, hybrid_connection_endpoint_id=None, included_event_types=None, labels=None, name=None, retry_policy=None, scope=None, service_bus_queue_endpoint_id=None, service_bus_topic_endpoint_id=None, storage_blob_dead_letter_destination=None, storage_queue_endpoint=None, subject_filter=None, topic_name=None, webhook_endpoint=None, __props__=None);

func 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)

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.

The following state arguments are supported:

AdvancedFilter EventSubscriptionAdvancedFilterArgs

A advanced_filter block as defined below.

AzureFunctionEndpoint EventSubscriptionAzureFunctionEndpointArgs

An azure_function_endpoint block as defined below.

EventDeliverySchema string

EventhubEndpoint EventSubscriptionEventhubEndpointArgs

A eventhub_endpoint block as defined below.

Deprecated: Deprecated in favour of eventhub_endpoint_id

EventhubEndpointId string

Specifies the id where the Event Hub is located.

ExpirationTimeUtc string

Specifies the expiration time of the event subscription (Datetime Format RFC 3339).

HybridConnectionEndpoint EventSubscriptionHybridConnectionEndpointArgs

A hybrid_connection_endpoint block as defined below.

Deprecated: Deprecated in favour of hybrid_connection_endpoint_id

HybridConnectionEndpointId string

Specifies the id where the Hybrid Connection is located.

IncludedEventTypes List<string>

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.

RetryPolicy EventSubscriptionRetryPolicyArgs

A retry_policy block 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.

ServiceBusQueueEndpointId string

Specifies the id where the Service Bus Queue is located.

ServiceBusTopicEndpointId string

Specifies the id where the Service Bus Topic is located.

StorageBlobDeadLetterDestination EventSubscriptionStorageBlobDeadLetterDestinationArgs

A storage_blob_dead_letter_destination block as defined below.

StorageQueueEndpoint EventSubscriptionStorageQueueEndpointArgs

A storage_queue_endpoint block as defined below.

SubjectFilter EventSubscriptionSubjectFilterArgs

A subject_filter block as defined below.

TopicName string

(Optional) Specifies the name of the topic to associate with the event subscription.

WebhookEndpoint EventSubscriptionWebhookEndpointArgs

A webhook_endpoint block as defined below.

AdvancedFilter EventSubscriptionAdvancedFilter

A advanced_filter block as defined below.

AzureFunctionEndpoint EventSubscriptionAzureFunctionEndpoint

An azure_function_endpoint block as defined below.

EventDeliverySchema string

EventhubEndpoint EventSubscriptionEventhubEndpoint

A eventhub_endpoint block as defined below.

Deprecated: Deprecated in favour of eventhub_endpoint_id

EventhubEndpointId string

Specifies the id where the Event Hub is located.

ExpirationTimeUtc string

Specifies the expiration time of the event subscription (Datetime Format RFC 3339).

HybridConnectionEndpoint EventSubscriptionHybridConnectionEndpoint

A hybrid_connection_endpoint block as defined below.

Deprecated: Deprecated in favour of hybrid_connection_endpoint_id

HybridConnectionEndpointId string

Specifies the id where the Hybrid Connection is located.

IncludedEventTypes []string

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.

RetryPolicy EventSubscriptionRetryPolicy

A retry_policy block 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.

ServiceBusQueueEndpointId string

Specifies the id where the Service Bus Queue is located.

ServiceBusTopicEndpointId string

Specifies the id where the Service Bus Topic is located.

StorageBlobDeadLetterDestination EventSubscriptionStorageBlobDeadLetterDestination

A storage_blob_dead_letter_destination block as defined below.

StorageQueueEndpoint EventSubscriptionStorageQueueEndpoint

A storage_queue_endpoint block as defined below.

SubjectFilter EventSubscriptionSubjectFilter

A subject_filter block as defined below.

TopicName string

(Optional) Specifies the name of the topic to associate with the event subscription.

WebhookEndpoint EventSubscriptionWebhookEndpoint

A webhook_endpoint block as defined below.

advancedFilter EventSubscriptionAdvancedFilter

A advanced_filter block as defined below.

azureFunctionEndpoint EventSubscriptionAzureFunctionEndpoint

An azure_function_endpoint block as defined below.

eventDeliverySchema string

eventhubEndpoint EventSubscriptionEventhubEndpoint

A eventhub_endpoint block as defined below.

Deprecated: Deprecated in favour of eventhub_endpoint_id

eventhubEndpointId string

Specifies the id where the Event Hub is located.

expirationTimeUtc string

Specifies the expiration time of the event subscription (Datetime Format RFC 3339).

hybridConnectionEndpoint EventSubscriptionHybridConnectionEndpoint

A hybrid_connection_endpoint block as defined below.

Deprecated: Deprecated in favour of hybrid_connection_endpoint_id

hybridConnectionEndpointId string

Specifies the id where the Hybrid Connection is located.

includedEventTypes string[]

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.

retryPolicy EventSubscriptionRetryPolicy

A retry_policy block 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.

serviceBusQueueEndpointId string

Specifies the id where the Service Bus Queue is located.

serviceBusTopicEndpointId string

Specifies the id where the Service Bus Topic is located.

storageBlobDeadLetterDestination EventSubscriptionStorageBlobDeadLetterDestination

A storage_blob_dead_letter_destination block as defined below.

storageQueueEndpoint EventSubscriptionStorageQueueEndpoint

A storage_queue_endpoint block as defined below.

subjectFilter EventSubscriptionSubjectFilter

A subject_filter block as defined below.

topicName string

(Optional) Specifies the name of the topic to associate with the event subscription.

webhookEndpoint EventSubscriptionWebhookEndpoint

A webhook_endpoint block as defined below.

advanced_filter Dict[EventSubscriptionAdvancedFilter]

A advanced_filter block as defined below.

azure_function_endpoint Dict[EventSubscriptionAzureFunctionEndpoint]

An azure_function_endpoint block as defined below.

event_delivery_schema str

eventhub_endpoint Dict[EventSubscriptionEventhubEndpoint]

A eventhub_endpoint block as defined below.

Deprecated: Deprecated in favour of eventhub_endpoint_id

eventhub_endpoint_id str

Specifies the id where the Event Hub is located.

expiration_time_utc str

Specifies the expiration time of the event subscription (Datetime Format RFC 3339).

hybrid_connection_endpoint Dict[EventSubscriptionHybridConnectionEndpoint]

A hybrid_connection_endpoint block as defined below.

Deprecated: Deprecated in favour of hybrid_connection_endpoint_id

hybrid_connection_endpoint_id str

Specifies the id where the Hybrid Connection is located.

included_event_types List[str]

A list of applicable event types that need to be part of the event subscription.

labels List[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 Dict[EventSubscriptionRetryPolicy]

A retry_policy block 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_queue_endpoint_id str

Specifies the id where the Service Bus Queue is located.

service_bus_topic_endpoint_id str

Specifies the id where the Service Bus Topic is located.

storage_blob_dead_letter_destination Dict[EventSubscriptionStorageBlobDeadLetterDestination]

A storage_blob_dead_letter_destination block as defined below.

storage_queue_endpoint Dict[EventSubscriptionStorageQueueEndpoint]

A storage_queue_endpoint block as defined below.

subject_filter Dict[EventSubscriptionSubjectFilter]

A subject_filter block as defined below.

topic_name str

(Optional) Specifies the name of the topic to associate with the event subscription.

webhook_endpoint Dict[EventSubscriptionWebhookEndpoint]

A webhook_endpoint block as defined below.

Supporting Types

EventSubscriptionAdvancedFilter

BoolEquals List<EventSubscriptionAdvancedFilterBoolEqualArgs>: Compares a value of an event using a single boolean value.
NumberGreaterThanOrEquals List<EventSubscriptionAdvancedFilterNumberGreaterThanOrEqualArgs>: Compares a value of an event using a single floating point number.
NumberGreaterThans List<EventSubscriptionAdvancedFilterNumberGreaterThanArgs>: Compares a value of an event using a single floating point number.
NumberIns List<EventSubscriptionAdvancedFilterNumberInArgs>: Compares a value of an event using multiple floating point numbers.
NumberLessThanOrEquals List<EventSubscriptionAdvancedFilterNumberLessThanOrEqualArgs>: Compares a value of an event using a single floating point number.
NumberLessThans List<EventSubscriptionAdvancedFilterNumberLessThanArgs>: Compares a value of an event using a single floating point number.
NumberNotIns List<EventSubscriptionAdvancedFilterNumberNotInArgs>: Compares a value of an event using multiple floating point numbers.
StringBeginsWiths List<EventSubscriptionAdvancedFilterStringBeginsWithArgs>: Compares a value of an event using multiple string values.
StringContains List<EventSubscriptionAdvancedFilterStringContainArgs>: Compares a value of an event using multiple string values.
StringEndsWiths List<EventSubscriptionAdvancedFilterStringEndsWithArgs>: Compares a value of an event using multiple string values.
StringIns List<EventSubscriptionAdvancedFilterStringInArgs>: Compares a value of an event using multiple string values.
StringNotIns List<EventSubscriptionAdvancedFilterStringNotInArgs>: Compares a value of an event using multiple string values.

BoolEquals []EventSubscriptionAdvancedFilterBoolEqual: Compares a value of an event using a single boolean value.
NumberGreaterThanOrEquals []EventSubscriptionAdvancedFilterNumberGreaterThanOrEqual: Compares a value of an event using a single floating point number.
NumberGreaterThans []EventSubscriptionAdvancedFilterNumberGreaterThan: Compares a value of an event using a single floating point number.
NumberIns []EventSubscriptionAdvancedFilterNumberIn: Compares a value of an event using multiple floating point numbers.
NumberLessThanOrEquals []EventSubscriptionAdvancedFilterNumberLessThanOrEqual: Compares a value of an event using a single floating point number.
NumberLessThans []EventSubscriptionAdvancedFilterNumberLessThan: Compares a value of an event using a single floating point number.
NumberNotIns []EventSubscriptionAdvancedFilterNumberNotIn: Compares a value of an event using multiple floating point numbers.
StringBeginsWiths []EventSubscriptionAdvancedFilterStringBeginsWith: Compares a value of an event using multiple string values.
StringContains []EventSubscriptionAdvancedFilterStringContain: Compares a value of an event using multiple string values.
StringEndsWiths []EventSubscriptionAdvancedFilterStringEndsWith: Compares a value of an event using multiple string values.
StringIns []EventSubscriptionAdvancedFilterStringIn: Compares a value of an event using multiple string values.
StringNotIns []EventSubscriptionAdvancedFilterStringNotIn: Compares a value of an event using multiple string values.

boolEquals EventSubscriptionAdvancedFilterBoolEqual[]: Compares a value of an event using a single boolean value.
numberGreaterThanOrEquals EventSubscriptionAdvancedFilterNumberGreaterThanOrEqual[]: Compares a value of an event using a single floating point number.
numberGreaterThans EventSubscriptionAdvancedFilterNumberGreaterThan[]: Compares a value of an event using a single floating point number.
numberIns EventSubscriptionAdvancedFilterNumberIn[]: Compares a value of an event using multiple floating point numbers.
numberLessThanOrEquals EventSubscriptionAdvancedFilterNumberLessThanOrEqual[]: Compares a value of an event using a single floating point number.
numberLessThans EventSubscriptionAdvancedFilterNumberLessThan[]: Compares a value of an event using a single floating point number.
numberNotIns EventSubscriptionAdvancedFilterNumberNotIn[]: Compares a value of an event using multiple floating point numbers.
stringBeginsWiths EventSubscriptionAdvancedFilterStringBeginsWith[]: Compares a value of an event using multiple string values.
stringContains EventSubscriptionAdvancedFilterStringContain[]: Compares a value of an event using multiple string values.
stringEndsWiths EventSubscriptionAdvancedFilterStringEndsWith[]: Compares a value of an event using multiple string values.
stringIns EventSubscriptionAdvancedFilterStringIn[]: Compares a value of an event using multiple string values.
stringNotIns EventSubscriptionAdvancedFilterStringNotIn[]: Compares a value of an event using multiple string values.

boolEquals List[EventSubscriptionAdvancedFilterBoolEqual]: Compares a value of an event using a single boolean value.
numberGreaterThanOrEquals List[EventSubscriptionAdvancedFilterNumberGreaterThanOrEqual]: Compares a value of an event using a single floating point number.
numberGreaterThans List[EventSubscriptionAdvancedFilterNumberGreaterThan]: Compares a value of an event using a single floating point number.
numberIns List[EventSubscriptionAdvancedFilterNumberIn]: Compares a value of an event using multiple floating point numbers.
numberLessThanOrEquals List[EventSubscriptionAdvancedFilterNumberLessThanOrEqual]: Compares a value of an event using a single floating point number.
numberLessThans List[EventSubscriptionAdvancedFilterNumberLessThan]: Compares a value of an event using a single floating point number.
numberNotIns List[EventSubscriptionAdvancedFilterNumberNotIn]: Compares a value of an event using multiple floating point numbers.
stringBeginsWiths List[EventSubscriptionAdvancedFilterStringBeginsWith]: Compares a value of an event using multiple string values.
stringContains List[EventSubscriptionAdvancedFilterStringContain]: Compares a value of an event using multiple string values.
stringEndsWiths List[EventSubscriptionAdvancedFilterStringEndsWith]: Compares a value of an event using multiple string values.
stringIns List[EventSubscriptionAdvancedFilterStringIn]: Compares a value of an event using multiple string values.
stringNotIns List[EventSubscriptionAdvancedFilterStringNotIn]: Compares a value of an event using multiple string values.

EventSubscriptionAdvancedFilterBoolEqual

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.
Value bool: Specifies a single value to compare to when using a single value operator.

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.
Value bool: Specifies a single value to compare to when using a single value operator.

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.
value boolean: Specifies a single value to compare to when using a single value operator.

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.
value bool: Specifies a single value to compare to when using a single value operator.

EventSubscriptionAdvancedFilterNumberGreaterThan

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.
Value double: Specifies a single value to compare to when using a single value operator.

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.
Value float64: Specifies a single value to compare to when using a single value operator.

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.
value number: Specifies a single value to compare to when using a single value operator.

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.
value float: Specifies a single value to compare to when using a single value operator.

EventSubscriptionAdvancedFilterNumberGreaterThanOrEqual

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.
Value double: Specifies a single value to compare to when using a single value operator.

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.
Value float64: Specifies a single value to compare to when using a single value operator.

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.
value number: Specifies a single value to compare to when using a single value operator.

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.
value float: Specifies a single value to compare to when using a single value operator.

EventSubscriptionAdvancedFilterNumberIn

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.
Values List<double>: Specifies an array of values to compare to when using a multiple values operator.

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.
Values []float64: Specifies an array of values to compare to when using a multiple values operator.

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.
values number[]: Specifies an array of values to compare to when using a multiple values operator.

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.
values List[Number]: Specifies an array of values to compare to when using a multiple values operator.

EventSubscriptionAdvancedFilterNumberLessThan

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.
Value double: Specifies a single value to compare to when using a single value operator.

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.
Value float64: Specifies a single value to compare to when using a single value operator.

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.
value number: Specifies a single value to compare to when using a single value operator.

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.
value float: Specifies a single value to compare to when using a single value operator.

EventSubscriptionAdvancedFilterNumberLessThanOrEqual

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.
Value double: Specifies a single value to compare to when using a single value operator.

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.
Value float64: Specifies a single value to compare to when using a single value operator.

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.
value number: Specifies a single value to compare to when using a single value operator.

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.
value float: Specifies a single value to compare to when using a single value operator.

EventSubscriptionAdvancedFilterNumberNotIn

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.
Values List<double>: Specifies an array of values to compare to when using a multiple values operator.

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.
Values []float64: Specifies an array of values to compare to when using a multiple values operator.

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.
values number[]: Specifies an array of values to compare to when using a multiple values operator.

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.
values List[Number]: Specifies an array of values to compare to when using a multiple values operator.

EventSubscriptionAdvancedFilterStringBeginsWith

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.
Values List<string>: Specifies an array of values to compare to when using a multiple values operator.

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.
Values []string: Specifies an array of values to compare to when using a multiple values operator.

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.
values string[]: Specifies an array of values to compare to when using a multiple values operator.

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.
values List[str]: Specifies an array of values to compare to when using a multiple values operator.

EventSubscriptionAdvancedFilterStringContain

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.
Values List<string>: Specifies an array of values to compare to when using a multiple values operator.

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.
Values []string: Specifies an array of values to compare to when using a multiple values operator.

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.
values string[]: Specifies an array of values to compare to when using a multiple values operator.

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.
values List[str]: Specifies an array of values to compare to when using a multiple values operator.

EventSubscriptionAdvancedFilterStringEndsWith

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.
Values List<string>: Specifies an array of values to compare to when using a multiple values operator.

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.
Values []string: Specifies an array of values to compare to when using a multiple values operator.

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.
values string[]: Specifies an array of values to compare to when using a multiple values operator.

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.
values List[str]: Specifies an array of values to compare to when using a multiple values operator.

EventSubscriptionAdvancedFilterStringIn

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.
Values List<string>: Specifies an array of values to compare to when using a multiple values operator.

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.
Values []string: Specifies an array of values to compare to when using a multiple values operator.

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.
values string[]: Specifies an array of values to compare to when using a multiple values operator.

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.
values List[str]: Specifies an array of values to compare to when using a multiple values operator.

EventSubscriptionAdvancedFilterStringNotIn

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.
Values List<string>: Specifies an array of values to compare to when using a multiple values operator.

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.
Values []string: Specifies an array of values to compare to when using a multiple values operator.

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.
values string[]: Specifies an array of values to compare to when using a multiple values operator.

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.
values List[str]: Specifies an array of values to compare to when using a multiple values operator.

EventSubscriptionAzureFunctionEndpoint

FunctionId string: Specifies the ID of the Function where the Event Subscription will receive events.
MaxEventsPerBatch int: Maximum number of events per batch.
PreferredBatchSizeInKilobytes int: Preferred batch size in Kilobytes.

FunctionId string: Specifies the ID of the Function where the Event Subscription will receive events.
MaxEventsPerBatch int: Maximum number of events per batch.
PreferredBatchSizeInKilobytes int: Preferred batch size in Kilobytes.

functionId string: Specifies the ID of the Function where the Event Subscription will receive events.
maxEventsPerBatch number: Maximum number of events per batch.
preferredBatchSizeInKilobytes number: Preferred batch size in Kilobytes.

functionId str: Specifies the ID of the Function where the Event Subscription will receive events.
maxEventsPerBatch float: Maximum number of events per batch.
preferredBatchSizeInKilobytes float: Preferred batch size in Kilobytes.

EventSubscriptionEventhubEndpoint

EventhubId string: Specifies the id of the eventhub where the Event Subscription will receive events.

EventhubId string: Specifies the id of the eventhub where the Event Subscription will receive events.

eventhubId string: Specifies the id of the eventhub where the Event Subscription will receive events.

eventhub_id str: Specifies the id of the eventhub where the Event Subscription will receive events.

EventSubscriptionHybridConnectionEndpoint

HybridConnectionId string: Specifies the id of the hybrid connection where the Event Subscription will receive events.

HybridConnectionId string: Specifies the id of the hybrid connection where the Event Subscription will receive events.

hybridConnectionId string: Specifies the id of the hybrid connection where the Event Subscription will receive events.

hybridConnectionId str: Specifies the id of the hybrid connection where the Event Subscription will receive events.

EventSubscriptionRetryPolicy

EventTimeToLive int: Specifies the time to live (in minutes) for events.
MaxDeliveryAttempts int: Specifies the maximum number of delivery retry attempts for events.

EventTimeToLive int: Specifies the time to live (in minutes) for events.
MaxDeliveryAttempts int: Specifies the maximum number of delivery retry attempts for events.

eventTimeToLive number: Specifies the time to live (in minutes) for events.
maxDeliveryAttempts number: Specifies the maximum number of delivery retry attempts for events.

eventTimeToLive float: Specifies the time to live (in minutes) for events.
maxDeliveryAttempts float: Specifies the maximum number of delivery retry attempts for events.

EventSubscriptionStorageBlobDeadLetterDestination

StorageAccountId string: Specifies the id of the storage account id where the storage blob is located.
StorageBlobContainerName string: Specifies the name of the Storage blob container that is the destination of the deadletter events.

StorageAccountId string: Specifies the id of the storage account id where the storage blob is located.
StorageBlobContainerName string: Specifies the name of the Storage blob container that is the destination of the deadletter events.

storageAccountId string: Specifies the id of the storage account id where the storage blob is located.
storageBlobContainerName string: Specifies the name of the Storage blob container that is the destination of the deadletter events.

storageBlobContainerName str: Specifies the name of the Storage blob container that is the destination of the deadletter events.
storage_account_id str: Specifies the id of the storage account id where the storage blob is located.

EventSubscriptionStorageQueueEndpoint

QueueName string: Specifies the name of the storage queue where the Event Subscription will receive events.
StorageAccountId string: Specifies the id of the storage account id where the storage queue is located.

QueueName string: Specifies the name of the storage queue where the Event Subscription will receive events.
StorageAccountId string: Specifies the id of the storage account id where the storage queue is located.

queueName string: Specifies the name of the storage queue where the Event Subscription will receive events.
storageAccountId string: Specifies the id of the storage account id where the storage queue is located.

queue_name str: Specifies the name of the storage queue where the Event Subscription will receive events.
storage_account_id str: Specifies the id of the storage account id where the storage queue is located.

EventSubscriptionSubjectFilter

CaseSensitive bool: Specifies if subject_begins_with and subject_ends_with case sensitive. This value defaults to false.
SubjectBeginsWith string: A string to filter events for an event subscription based on a resource path prefix.
SubjectEndsWith string: A string to filter events for an event subscription based on a resource path suffix.

CaseSensitive bool: Specifies if subject_begins_with and subject_ends_with case sensitive. This value defaults to false.
SubjectBeginsWith string: A string to filter events for an event subscription based on a resource path prefix.
SubjectEndsWith string: A string to filter events for an event subscription based on a resource path suffix.

caseSensitive boolean: Specifies if subject_begins_with and subject_ends_with case sensitive. This value defaults to false.
subjectBeginsWith string: A string to filter events for an event subscription based on a resource path prefix.
subjectEndsWith string: A string to filter events for an event subscription based on a resource path suffix.

caseSensitive bool: Specifies if subject_begins_with and subject_ends_with case sensitive. This value defaults to false.
subjectBeginsWith str: A string to filter events for an event subscription based on a resource path prefix.
subjectEndsWith str: 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.
ActiveDirectoryAppIdOrUri string: The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests.
ActiveDirectoryTenantId string: The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests.
BaseUrl string: The base url of the webhook where the Event Subscription will receive events.
MaxEventsPerBatch int: Maximum number of events per batch.
PreferredBatchSizeInKilobytes int: Preferred batch size in Kilobytes.

Url string: Specifies the url of the webhook where the Event Subscription will receive events.
ActiveDirectoryAppIdOrUri string: The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests.
ActiveDirectoryTenantId string: The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests.
BaseUrl string: The base url of the webhook where the Event Subscription will receive events.
MaxEventsPerBatch int: Maximum number of events per batch.
PreferredBatchSizeInKilobytes int: Preferred batch size in Kilobytes.

url string: Specifies the url of the webhook where the Event Subscription will receive events.
activeDirectoryAppIdOrUri string: The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests.
activeDirectoryTenantId string: The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests.
baseUrl string: The base url of the webhook where the Event Subscription will receive events.
maxEventsPerBatch number: Maximum number of events per batch.
preferredBatchSizeInKilobytes number: Preferred batch size in Kilobytes.

url str: Specifies the url of the webhook where the Event Subscription will receive events.
activeDirectoryAppIdOrUri str: The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests.
activeDirectoryTenantId str: The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests.
baseUrl str: The base url of the webhook where the Event Subscription will receive events.
maxEventsPerBatch float: Maximum number of events per batch.
preferredBatchSizeInKilobytes float: Preferred batch size in Kilobytes.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

EventSubscription

Create a EventSubscription Resource

EventSubscription Resource Properties

Inputs

Outputs

Look up an Existing EventSubscription Resource

Supporting Types

EventSubscriptionAdvancedFilter

EventSubscriptionAdvancedFilterBoolEqual

EventSubscriptionAdvancedFilterNumberGreaterThan

EventSubscriptionAdvancedFilterNumberGreaterThanOrEqual

EventSubscriptionAdvancedFilterNumberIn

EventSubscriptionAdvancedFilterNumberLessThan

EventSubscriptionAdvancedFilterNumberLessThanOrEqual

EventSubscriptionAdvancedFilterNumberNotIn

EventSubscriptionAdvancedFilterStringBeginsWith

EventSubscriptionAdvancedFilterStringContain

EventSubscriptionAdvancedFilterStringEndsWith

EventSubscriptionAdvancedFilterStringIn

EventSubscriptionAdvancedFilterStringNotIn

EventSubscriptionAzureFunctionEndpoint

EventSubscriptionEventhubEndpoint

EventSubscriptionHybridConnectionEndpoint

EventSubscriptionRetryPolicy

EventSubscriptionStorageBlobDeadLetterDestination

EventSubscriptionStorageQueueEndpoint

EventSubscriptionSubjectFilter

EventSubscriptionWebhookEndpoint

Package Details

On This Page