This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

eventgrid¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.eventgrid.AwaitableGetTopicResult(endpoint=None, id=None, location=None, name=None, primary_access_key=None, resource_group_name=None, secondary_access_key=None, tags=None)¶

class pulumi_azure.eventgrid.Domain(resource_name, opts=None, input_mapping_default_values=None, input_mapping_fields=None, input_schema=None, location=None, name=None, resource_group_name=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Manages an EventGrid Domain

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US 2")
example_domain = azure.eventgrid.Domain("exampleDomain",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    tags={
        "environment": "Production",
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
input_mapping_default_values (pulumi.Input[dict]) – A input_mapping_default_values block as defined below.
input_mapping_fields (pulumi.Input[dict]) – A input_mapping_fields block as defined below.
input_schema (pulumi.Input[str]) – Specifies the schema in which incoming events will be published to this domain. Allowed values are CloudEventSchemaV1_0, CustomEventSchema, or EventGridSchema. Defaults to eventgridschema. Changing this forces a new resource to be created.
location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The input_mapping_default_values object supports the following:

dataVersion (pulumi.Input[str]) - Specifies the default data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
eventType (pulumi.Input[str]) - Specifies the default event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
subject (pulumi.Input[str]) - Specifies the default subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

The input_mapping_fields object supports the following:

dataVersion (pulumi.Input[str]) - Specifies the data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
eventTime (pulumi.Input[str]) - Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
eventType (pulumi.Input[str]) - Specifies the event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
id (pulumi.Input[str]) - Specifies the id of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
subject (pulumi.Input[str]) - Specifies the subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
topic (pulumi.Input[str]) - Specifies the topic of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

endpoint: pulumi.Output[str] = None¶: The Endpoint associated with the EventGrid Domain.

input_mapping_default_values: pulumi.Output[dict] = None¶

A input_mapping_default_values block as defined below.

dataVersion (str) - Specifies the default data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
eventType (str) - Specifies the default event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
subject (str) - Specifies the default subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

input_mapping_fields: pulumi.Output[dict] = None¶

A input_mapping_fields block as defined below.

dataVersion (str) - Specifies the data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
eventTime (str) - Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
eventType (str) - Specifies the event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
id (str) - Specifies the id of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
subject (str) - Specifies the subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
topic (str) - Specifies the topic of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

input_schema: pulumi.Output[str] = None¶: Specifies the schema in which incoming events will be published to this domain. Allowed values are CloudEventSchemaV1_0, CustomEventSchema, or EventGridSchema. Defaults to eventgridschema. Changing this forces a new resource to be created.

location: pulumi.Output[str] = None¶: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.

primary_access_key: pulumi.Output[str] = None¶: The Primary Shared Access Key associated with the EventGrid Domain.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.

secondary_access_key: pulumi.Output[str] = None¶: The Secondary Shared Access Key associated with the EventGrid Domain.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, endpoint=None, input_mapping_default_values=None, input_mapping_fields=None, input_schema=None, location=None, name=None, primary_access_key=None, resource_group_name=None, secondary_access_key=None, tags=None)¶

Get an existing Domain resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
endpoint (pulumi.Input[str]) – The Endpoint associated with the EventGrid Domain.
input_mapping_default_values (pulumi.Input[dict]) – A input_mapping_default_values block as defined below.
input_mapping_fields (pulumi.Input[dict]) – A input_mapping_fields block as defined below.
input_schema (pulumi.Input[str]) – Specifies the schema in which incoming events will be published to this domain. Allowed values are CloudEventSchemaV1_0, CustomEventSchema, or EventGridSchema. Defaults to eventgridschema. Changing this forces a new resource to be created.
location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.
primary_access_key (pulumi.Input[str]) – The Primary Shared Access Key associated with the EventGrid Domain.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
secondary_access_key (pulumi.Input[str]) – The Secondary Shared Access Key associated with the EventGrid Domain.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The input_mapping_default_values object supports the following:

dataVersion (pulumi.Input[str]) - Specifies the default data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
eventType (pulumi.Input[str]) - Specifies the default event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
subject (pulumi.Input[str]) - Specifies the default subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

The input_mapping_fields object supports the following:

dataVersion (pulumi.Input[str]) - Specifies the data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
eventTime (pulumi.Input[str]) - Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
eventType (pulumi.Input[str]) - Specifies the event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
id (pulumi.Input[str]) - Specifies the id of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
subject (pulumi.Input[str]) - Specifies the subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
topic (pulumi.Input[str]) - Specifies the topic of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.eventgrid.DomainTopic(resource_name, opts=None, domain_name=None, name=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)¶

Manages an EventGrid Domain Topic

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US 2")
example_domain = azure.eventgrid.Domain("exampleDomain",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    tags={
        "environment": "Production",
    })
example_domain_topic = azure.eventgrid.DomainTopic("exampleDomainTopic",
    domain_name=example_domain.name,
    resource_group_name=example_resource_group.name)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
domain_name (pulumi.Input[str]) – Specifies the name of the EventGrid Domain. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the EventGrid Domain Topic resource. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.

domain_name: pulumi.Output[str] = None¶: Specifies the name of the EventGrid Domain. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the EventGrid Domain Topic resource. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, domain_name=None, name=None, resource_group_name=None)¶

Get an existing DomainTopic resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
domain_name (pulumi.Input[str]) – Specifies the name of the EventGrid Domain. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the EventGrid Domain Topic resource. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.eventgrid.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, __name__=None, __opts__=None)¶

Manages an EventGrid Event Subscription

import pulumi
import pulumi_azure as azure

default_resource_group = azure.core.ResourceGroup("defaultResourceGroup", location="West US 2")
default_account = azure.storage.Account("defaultAccount",
    resource_group_name=default_resource_group.name,
    location=default_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS",
    tags={
        "environment": "staging",
    })
default_queue = azure.storage.Queue("defaultQueue", storage_account_name=default_account.name)
default_event_subscription = azure.eventgrid.EventSubscription("defaultEventSubscription",
    scope=default_resource_group.id,
    storage_queue_endpoint={
        "storage_account_id": default_account.id,
        "queue_name": default_queue.name,
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
advanced_filter (pulumi.Input[dict]) – A advanced_filter block as defined below.
azure_function_endpoint (pulumi.Input[dict]) – An azure_function_endpoint block as defined below.
event_delivery_schema (pulumi.Input[str]) – 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.
eventhub_endpoint (pulumi.Input[dict]) – A eventhub_endpoint block as defined below.
eventhub_endpoint_id (pulumi.Input[str]) – Specifies the id where the Event Hub is located.
expiration_time_utc (pulumi.Input[str]) – Specifies the expiration time of the event subscription (Datetime Format RFC 3339).
hybrid_connection_endpoint (pulumi.Input[dict]) – A hybrid_connection_endpoint block as defined below.
hybrid_connection_endpoint_id (pulumi.Input[str]) – Specifies the id where the Hybrid Connection is located.
included_event_types (pulumi.Input[list]) – A list of applicable event types that need to be part of the event subscription.
labels (pulumi.Input[list]) – A list of labels to assign to the event subscription.
name (pulumi.Input[str]) – Specifies the name of the EventGrid Event Subscription resource. Changing this forces a new resource to be created.
retry_policy (pulumi.Input[dict]) – A retry_policy block as defined below.
scope (pulumi.Input[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 (pulumi.Input[str]) – Specifies the id where the Service Bus Queue is located.
service_bus_topic_endpoint_id (pulumi.Input[str]) – Specifies the id where the Service Bus Topic is located.
storage_blob_dead_letter_destination (pulumi.Input[dict]) – A storage_blob_dead_letter_destination block as defined below.
storage_queue_endpoint (pulumi.Input[dict]) – A storage_queue_endpoint block as defined below.
subject_filter (pulumi.Input[dict]) – A subject_filter block as defined below.
topic_name (pulumi.Input[str]) – (Optional) Specifies the name of the topic to associate with the event subscription.
webhook_endpoint (pulumi.Input[dict]) – A webhook_endpoint block as defined below.

The advanced_filter object supports the following:

boolEquals (pulumi.Input[list]) - Compares a value of an event using a single boolean value.
- key (pulumi.Input[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 (pulumi.Input[bool]) - Specifies a single value to compare to when using a single value operator.
numberGreaterThanOrEquals (pulumi.Input[list]) - Compares a value of an event using a single floating point number.
- key (pulumi.Input[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 (pulumi.Input[float]) - Specifies a single value to compare to when using a single value operator.
numberGreaterThans (pulumi.Input[list]) - Compares a value of an event using a single floating point number.
- key (pulumi.Input[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 (pulumi.Input[float]) - Specifies a single value to compare to when using a single value operator.
numberIns (pulumi.Input[list]) - Compares a value of an event using multiple floating point numbers.
- key (pulumi.Input[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 (pulumi.Input[list]) - Specifies an array of values to compare to when using a multiple values operator.
numberLessThanOrEquals (pulumi.Input[list]) - Compares a value of an event using a single floating point number.
- key (pulumi.Input[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 (pulumi.Input[float]) - Specifies a single value to compare to when using a single value operator.
numberLessThans (pulumi.Input[list]) - Compares a value of an event using a single floating point number.
- key (pulumi.Input[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 (pulumi.Input[float]) - Specifies a single value to compare to when using a single value operator.
numberNotIns (pulumi.Input[list]) - Compares a value of an event using multiple floating point numbers.
- key (pulumi.Input[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 (pulumi.Input[list]) - Specifies an array of values to compare to when using a multiple values operator.
stringBeginsWiths (pulumi.Input[list]) - Compares a value of an event using multiple string values.
- key (pulumi.Input[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 (pulumi.Input[list]) - Specifies an array of values to compare to when using a multiple values operator.
stringContains (pulumi.Input[list]) - Compares a value of an event using multiple string values.
- key (pulumi.Input[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 (pulumi.Input[list]) - Specifies an array of values to compare to when using a multiple values operator.
stringEndsWiths (pulumi.Input[list]) - Compares a value of an event using multiple string values.
- key (pulumi.Input[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 (pulumi.Input[list]) - Specifies an array of values to compare to when using a multiple values operator.
stringIns (pulumi.Input[list]) - Compares a value of an event using multiple string values.
- key (pulumi.Input[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 (pulumi.Input[list]) - Specifies an array of values to compare to when using a multiple values operator.
stringNotIns (pulumi.Input[list]) - Compares a value of an event using multiple string values.
- key (pulumi.Input[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 (pulumi.Input[list]) - Specifies an array of values to compare to when using a multiple values operator.

The azure_function_endpoint object supports the following:

functionId (pulumi.Input[str]) - Specifies the ID of the Function where the Event Subscription will receive events.
maxEventsPerBatch (pulumi.Input[float]) - Maximum number of events per batch.
preferredBatchSizeInKilobytes (pulumi.Input[float]) - Preferred batch size in Kilobytes.

The eventhub_endpoint object supports the following:

eventhub_id (pulumi.Input[str]) - Specifies the id of the eventhub where the Event Subscription will receive events.

The hybrid_connection_endpoint object supports the following:

hybridConnectionId (pulumi.Input[str]) - Specifies the id of the hybrid connection where the Event Subscription will receive events.

The retry_policy object supports the following:

eventTimeToLive (pulumi.Input[float]) - Specifies the time to live (in minutes) for events.
maxDeliveryAttempts (pulumi.Input[float]) - Specifies the maximum number of delivery retry attempts for events.

The storage_blob_dead_letter_destination object supports the following:

storage_account_id (pulumi.Input[str]) - Specifies the id of the storage account id where the storage blob is located.
storageBlobContainerName (pulumi.Input[str]) - Specifies the name of the Storage blob container that is the destination of the deadletter events.

The storage_queue_endpoint object supports the following:

queue_name (pulumi.Input[str]) - Specifies the name of the storage queue where the Event Subscription will receive events.
storage_account_id (pulumi.Input[str]) - Specifies the id of the storage account id where the storage queue is located.

The subject_filter object supports the following:

caseSensitive (pulumi.Input[bool]) - Specifies if subject_begins_with and subject_ends_with case sensitive. This value defaults to false.
subjectBeginsWith (pulumi.Input[str]) - A string to filter events for an event subscription based on a resource path prefix.
subjectEndsWith (pulumi.Input[str]) - A string to filter events for an event subscription based on a resource path suffix.

The webhook_endpoint object supports the following:

activeDirectoryAppIdOrUri (pulumi.Input[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 (pulumi.Input[str]) - The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests.
baseUrl (pulumi.Input[str]) - The base url of the webhook where the Event Subscription will receive events.
maxEventsPerBatch (pulumi.Input[float]) - Maximum number of events per batch.
preferredBatchSizeInKilobytes (pulumi.Input[float]) - Preferred batch size in Kilobytes.
url (pulumi.Input[str]) - Specifies the url of the webhook where the Event Subscription will receive events.

advanced_filter: pulumi.Output[dict] = None¶

A advanced_filter block as defined below.

boolEquals (list) - Compares a value of an event using a single boolean value.
- 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.
numberGreaterThanOrEquals (list) - Compares a value of an event using a single floating point number.
- 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.
numberGreaterThans (list) - Compares a value of an event using a single floating point number.
- 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.
numberIns (list) - Compares a value of an event using multiple floating point numbers.
- 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) - Specifies an array of values to compare to when using a multiple values operator.
numberLessThanOrEquals (list) - Compares a value of an event using a single floating point number.
- 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.
numberLessThans (list) - Compares a value of an event using a single floating point number.
- 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.
numberNotIns (list) - Compares a value of an event using multiple floating point numbers.
- 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) - Specifies an array of values to compare to when using a multiple values operator.
stringBeginsWiths (list) - Compares a value of an event using multiple string values.
- 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) - Specifies an array of values to compare to when using a multiple values operator.
stringContains (list) - Compares a value of an event using multiple string values.
- 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) - Specifies an array of values to compare to when using a multiple values operator.
stringEndsWiths (list) - Compares a value of an event using multiple string values.
- 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) - Specifies an array of values to compare to when using a multiple values operator.
stringIns (list) - Compares a value of an event using multiple string values.
- 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) - Specifies an array of values to compare to when using a multiple values operator.
stringNotIns (list) - Compares a value of an event using multiple string values.
- 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) - Specifies an array of values to compare to when using a multiple values operator.

azure_function_endpoint: pulumi.Output[dict] = None¶

An azure_function_endpoint block as defined below.

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.

event_delivery_schema: pulumi.Output[str] = None¶: 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.

eventhub_endpoint: pulumi.Output[dict] = None¶

A eventhub_endpoint block as defined below.

eventhub_id (str) - Specifies the id of the eventhub where the Event Subscription will receive events.

eventhub_endpoint_id: pulumi.Output[str] = None¶: Specifies the id where the Event Hub is located.

expiration_time_utc: pulumi.Output[str] = None¶: Specifies the expiration time of the event subscription (Datetime Format RFC 3339).

hybrid_connection_endpoint: pulumi.Output[dict] = None¶

A hybrid_connection_endpoint block as defined below.

hybridConnectionId (str) - Specifies the id of the hybrid connection where the Event Subscription will receive events.

hybrid_connection_endpoint_id: pulumi.Output[str] = None¶: Specifies the id where the Hybrid Connection is located.

included_event_types: pulumi.Output[list] = None¶: A list of applicable event types that need to be part of the event subscription.

labels: pulumi.Output[list] = None¶: A list of labels to assign to the event subscription.

name: pulumi.Output[str] = None¶: Specifies the name of the EventGrid Event Subscription resource. Changing this forces a new resource to be created.

retry_policy: pulumi.Output[dict] = None¶

A retry_policy block as defined below.

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

scope: pulumi.Output[str] = None¶: 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: pulumi.Output[str] = None¶: Specifies the id where the Service Bus Queue is located.

service_bus_topic_endpoint_id: pulumi.Output[str] = None¶: Specifies the id where the Service Bus Topic is located.

storage_blob_dead_letter_destination: pulumi.Output[dict] = None¶

A storage_blob_dead_letter_destination block as defined below.

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

storage_queue_endpoint: pulumi.Output[dict] = None¶

A storage_queue_endpoint block as defined below.

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.

subject_filter: pulumi.Output[dict] = None¶

A subject_filter block as defined below.

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.

topic_name: pulumi.Output[str] = None¶: (Optional) Specifies the name of the topic to associate with the event subscription.

webhook_endpoint: pulumi.Output[dict] = None¶

A webhook_endpoint block as defined below.

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.
url (str) - Specifies the url of the webhook where the Event Subscription will receive events.

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

Get an existing EventSubscription resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
advanced_filter (pulumi.Input[dict]) – A advanced_filter block as defined below.
azure_function_endpoint (pulumi.Input[dict]) – An azure_function_endpoint block as defined below.
event_delivery_schema (pulumi.Input[str]) – 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.
eventhub_endpoint (pulumi.Input[dict]) – A eventhub_endpoint block as defined below.
eventhub_endpoint_id (pulumi.Input[str]) – Specifies the id where the Event Hub is located.
expiration_time_utc (pulumi.Input[str]) – Specifies the expiration time of the event subscription (Datetime Format RFC 3339).
hybrid_connection_endpoint (pulumi.Input[dict]) – A hybrid_connection_endpoint block as defined below.
hybrid_connection_endpoint_id (pulumi.Input[str]) – Specifies the id where the Hybrid Connection is located.
included_event_types (pulumi.Input[list]) – A list of applicable event types that need to be part of the event subscription.
labels (pulumi.Input[list]) – A list of labels to assign to the event subscription.
name (pulumi.Input[str]) – Specifies the name of the EventGrid Event Subscription resource. Changing this forces a new resource to be created.
retry_policy (pulumi.Input[dict]) – A retry_policy block as defined below.
scope (pulumi.Input[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 (pulumi.Input[str]) – Specifies the id where the Service Bus Queue is located.
service_bus_topic_endpoint_id (pulumi.Input[str]) – Specifies the id where the Service Bus Topic is located.
storage_blob_dead_letter_destination (pulumi.Input[dict]) – A storage_blob_dead_letter_destination block as defined below.
storage_queue_endpoint (pulumi.Input[dict]) – A storage_queue_endpoint block as defined below.
subject_filter (pulumi.Input[dict]) – A subject_filter block as defined below.
topic_name (pulumi.Input[str]) – (Optional) Specifies the name of the topic to associate with the event subscription.
webhook_endpoint (pulumi.Input[dict]) – A webhook_endpoint block as defined below.

The advanced_filter object supports the following:

boolEquals (pulumi.Input[list]) - Compares a value of an event using a single boolean value.
- key (pulumi.Input[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 (pulumi.Input[bool]) - Specifies a single value to compare to when using a single value operator.
numberGreaterThanOrEquals (pulumi.Input[list]) - Compares a value of an event using a single floating point number.
- key (pulumi.Input[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 (pulumi.Input[float]) - Specifies a single value to compare to when using a single value operator.
numberGreaterThans (pulumi.Input[list]) - Compares a value of an event using a single floating point number.
- key (pulumi.Input[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 (pulumi.Input[float]) - Specifies a single value to compare to when using a single value operator.
numberIns (pulumi.Input[list]) - Compares a value of an event using multiple floating point numbers.
- key (pulumi.Input[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 (pulumi.Input[list]) - Specifies an array of values to compare to when using a multiple values operator.
numberLessThanOrEquals (pulumi.Input[list]) - Compares a value of an event using a single floating point number.
- key (pulumi.Input[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 (pulumi.Input[float]) - Specifies a single value to compare to when using a single value operator.
numberLessThans (pulumi.Input[list]) - Compares a value of an event using a single floating point number.
- key (pulumi.Input[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 (pulumi.Input[float]) - Specifies a single value to compare to when using a single value operator.
numberNotIns (pulumi.Input[list]) - Compares a value of an event using multiple floating point numbers.
- key (pulumi.Input[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 (pulumi.Input[list]) - Specifies an array of values to compare to when using a multiple values operator.
stringBeginsWiths (pulumi.Input[list]) - Compares a value of an event using multiple string values.
- key (pulumi.Input[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 (pulumi.Input[list]) - Specifies an array of values to compare to when using a multiple values operator.
stringContains (pulumi.Input[list]) - Compares a value of an event using multiple string values.
- key (pulumi.Input[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 (pulumi.Input[list]) - Specifies an array of values to compare to when using a multiple values operator.
stringEndsWiths (pulumi.Input[list]) - Compares a value of an event using multiple string values.
- key (pulumi.Input[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 (pulumi.Input[list]) - Specifies an array of values to compare to when using a multiple values operator.
stringIns (pulumi.Input[list]) - Compares a value of an event using multiple string values.
- key (pulumi.Input[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 (pulumi.Input[list]) - Specifies an array of values to compare to when using a multiple values operator.
stringNotIns (pulumi.Input[list]) - Compares a value of an event using multiple string values.
- key (pulumi.Input[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 (pulumi.Input[list]) - Specifies an array of values to compare to when using a multiple values operator.

The azure_function_endpoint object supports the following:

functionId (pulumi.Input[str]) - Specifies the ID of the Function where the Event Subscription will receive events.
maxEventsPerBatch (pulumi.Input[float]) - Maximum number of events per batch.
preferredBatchSizeInKilobytes (pulumi.Input[float]) - Preferred batch size in Kilobytes.

The eventhub_endpoint object supports the following:

eventhub_id (pulumi.Input[str]) - Specifies the id of the eventhub where the Event Subscription will receive events.

The hybrid_connection_endpoint object supports the following:

hybridConnectionId (pulumi.Input[str]) - Specifies the id of the hybrid connection where the Event Subscription will receive events.

The retry_policy object supports the following:

eventTimeToLive (pulumi.Input[float]) - Specifies the time to live (in minutes) for events.
maxDeliveryAttempts (pulumi.Input[float]) - Specifies the maximum number of delivery retry attempts for events.

The storage_blob_dead_letter_destination object supports the following:

storage_account_id (pulumi.Input[str]) - Specifies the id of the storage account id where the storage blob is located.
storageBlobContainerName (pulumi.Input[str]) - Specifies the name of the Storage blob container that is the destination of the deadletter events.

The storage_queue_endpoint object supports the following:

queue_name (pulumi.Input[str]) - Specifies the name of the storage queue where the Event Subscription will receive events.
storage_account_id (pulumi.Input[str]) - Specifies the id of the storage account id where the storage queue is located.

The subject_filter object supports the following:

caseSensitive (pulumi.Input[bool]) - Specifies if subject_begins_with and subject_ends_with case sensitive. This value defaults to false.
subjectBeginsWith (pulumi.Input[str]) - A string to filter events for an event subscription based on a resource path prefix.
subjectEndsWith (pulumi.Input[str]) - A string to filter events for an event subscription based on a resource path suffix.

The webhook_endpoint object supports the following:

activeDirectoryAppIdOrUri (pulumi.Input[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 (pulumi.Input[str]) - The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests.
baseUrl (pulumi.Input[str]) - The base url of the webhook where the Event Subscription will receive events.
maxEventsPerBatch (pulumi.Input[float]) - Maximum number of events per batch.
preferredBatchSizeInKilobytes (pulumi.Input[float]) - Preferred batch size in Kilobytes.
url (pulumi.Input[str]) - Specifies the url of the webhook where the Event Subscription will receive events.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.eventgrid.GetTopicResult(endpoint=None, id=None, location=None, name=None, primary_access_key=None, resource_group_name=None, secondary_access_key=None, tags=None)¶

A collection of values returned by getTopic.

endpoint = None¶: The Endpoint associated with the EventGrid Topic.

id = None¶: The provider-assigned unique ID for this managed resource.

primary_access_key = None¶: The Primary Shared Access Key associated with the EventGrid Topic.

secondary_access_key = None¶: The Secondary Shared Access Key associated with the EventGrid Topic.

class pulumi_azure.eventgrid.Topic(resource_name, opts=None, input_mapping_default_values=None, input_mapping_fields=None, input_schema=None, location=None, name=None, resource_group_name=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Manages an EventGrid Topic

Note: at this time EventGrid Topic’s are only available in a limited number of regions.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US 2")
example_topic = azure.eventgrid.Topic("exampleTopic",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    tags={
        "environment": "Production",
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
input_mapping_default_values (pulumi.Input[dict]) – A input_mapping_default_values block as defined below.
input_mapping_fields (pulumi.Input[dict]) – A input_mapping_fields block as defined below.
input_schema (pulumi.Input[str]) – Specifies the schema in which incoming events will be published to this domain. Allowed values are CloudEventSchemaV1_0, CustomEventSchema, or EventGridSchema. Defaults to EventGridSchema. Changing this forces a new resource to be created.
location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the EventGrid Topic resource. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The input_mapping_default_values object supports the following:

dataVersion (pulumi.Input[str]) - Specifies the default data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
eventType (pulumi.Input[str]) - Specifies the default event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
subject (pulumi.Input[str]) - Specifies the default subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

The input_mapping_fields object supports the following:

dataVersion (pulumi.Input[str]) - Specifies the data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
eventTime (pulumi.Input[str]) - Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
eventType (pulumi.Input[str]) - Specifies the event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
id (pulumi.Input[str]) - Specifies the id of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
subject (pulumi.Input[str]) - Specifies the subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
topic (pulumi.Input[str]) - Specifies the topic of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

endpoint: pulumi.Output[str] = None¶: The Endpoint associated with the EventGrid Topic.

input_mapping_default_values: pulumi.Output[dict] = None¶

A input_mapping_default_values block as defined below.

dataVersion (str) - Specifies the default data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
eventType (str) - Specifies the default event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
subject (str) - Specifies the default subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

input_mapping_fields: pulumi.Output[dict] = None¶

A input_mapping_fields block as defined below.

dataVersion (str) - Specifies the data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
eventTime (str) - Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
eventType (str) - Specifies the event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
id (str) - Specifies the id of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
subject (str) - Specifies the subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
topic (str) - Specifies the topic of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

input_schema: pulumi.Output[str] = None¶: Specifies the schema in which incoming events will be published to this domain. Allowed values are CloudEventSchemaV1_0, CustomEventSchema, or EventGridSchema. Defaults to EventGridSchema. Changing this forces a new resource to be created.

location: pulumi.Output[str] = None¶: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the EventGrid Topic resource. Changing this forces a new resource to be created.

primary_access_key: pulumi.Output[str] = None¶: The Primary Shared Access Key associated with the EventGrid Topic.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.

secondary_access_key: pulumi.Output[str] = None¶: The Secondary Shared Access Key associated with the EventGrid Topic.

tags: pulumi.Output[dict] = None¶

Get an existing Topic resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
endpoint (pulumi.Input[str]) – The Endpoint associated with the EventGrid Topic.
input_mapping_default_values (pulumi.Input[dict]) – A input_mapping_default_values block as defined below.
input_mapping_fields (pulumi.Input[dict]) – A input_mapping_fields block as defined below.
input_schema (pulumi.Input[str]) – Specifies the schema in which incoming events will be published to this domain. Allowed values are CloudEventSchemaV1_0, CustomEventSchema, or EventGridSchema. Defaults to EventGridSchema. Changing this forces a new resource to be created.
location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the EventGrid Topic resource. Changing this forces a new resource to be created.
primary_access_key (pulumi.Input[str]) – The Primary Shared Access Key associated with the EventGrid Topic.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.
secondary_access_key (pulumi.Input[str]) – The Secondary Shared Access Key associated with the EventGrid Topic.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The input_mapping_default_values object supports the following:

dataVersion (pulumi.Input[str]) - Specifies the default data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
eventType (pulumi.Input[str]) - Specifies the default event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
subject (pulumi.Input[str]) - Specifies the default subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

The input_mapping_fields object supports the following:

dataVersion (pulumi.Input[str]) - Specifies the data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
eventTime (pulumi.Input[str]) - Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
eventType (pulumi.Input[str]) - Specifies the event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
id (pulumi.Input[str]) - Specifies the id of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
subject (pulumi.Input[str]) - Specifies the subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
topic (pulumi.Input[str]) - Specifies the topic of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

pulumi_azure.eventgrid.get_topic(name=None, resource_group_name=None, tags=None, opts=None)¶

Use this data source to access information about an existing EventGrid Topic

import pulumi
import pulumi_azure as azure

example = azure.eventgrid.get_topic(name="my-eventgrid-topic",
    resource_group_name="example-resources")

Parameters

name (str) – The name of the EventGrid Topic resource.
resource_group_name (str) – The name of the resource group in which the EventGrid Topic exists.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

eventgrid¶

On This Page