Azure v6.22.0, Apr 1 25

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

azure.eventhub.EventGridTopic

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

pulumi/pulumi-azure

Example Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleTopic = new azure.eventgrid.Topic("example", {
    name: "my-eventgrid-topic",
    location: example.location,
    resourceGroupName: example.name,
    tags: {
        environment: "Production",
    },
});

import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_topic = azure.eventgrid.Topic("example",
    name="my-eventgrid-topic",
    location=example.location,
    resource_group_name=example.name,
    tags={
        "environment": "Production",
    })

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/eventgrid"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = eventgrid.NewTopic(ctx, "example", &eventgrid.TopicArgs{
			Name:              pulumi.String("my-eventgrid-topic"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			Tags: pulumi.StringMap{
				"environment": pulumi.String("Production"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleTopic = new Azure.EventGrid.Topic("example", new()
    {
        Name = "my-eventgrid-topic",
        Location = example.Location,
        ResourceGroupName = example.Name,
        Tags = 
        {
            { "environment", "Production" },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.eventgrid.Topic;
import com.pulumi.azure.eventgrid.TopicArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleTopic = new Topic("exampleTopic", TopicArgs.builder()
            .name("my-eventgrid-topic")
            .location(example.location())
            .resourceGroupName(example.name())
            .tags(Map.of("environment", "Production"))
            .build());

    }
}

resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleTopic:
    type: azure:eventgrid:Topic
    name: example
    properties:
      name: my-eventgrid-topic
      location: ${example.location}
      resourceGroupName: ${example.name}
      tags:
        environment: Production

Create EventGridTopic Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

new EventGridTopic(name: string, args: EventGridTopicArgs, opts?: CustomResourceOptions);

@overload
def EventGridTopic(resource_name: str,
                   args: EventGridTopicArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def EventGridTopic(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   identity: Optional[EventGridTopicIdentityArgs] = None,
                   inbound_ip_rules: Optional[Sequence[EventGridTopicInboundIpRuleArgs]] = None,
                   input_mapping_default_values: Optional[EventGridTopicInputMappingDefaultValuesArgs] = None,
                   input_mapping_fields: Optional[EventGridTopicInputMappingFieldsArgs] = None,
                   input_schema: Optional[str] = None,
                   local_auth_enabled: Optional[bool] = None,
                   location: Optional[str] = None,
                   name: Optional[str] = None,
                   public_network_access_enabled: Optional[bool] = None,
                   resource_group_name: Optional[str] = None,
                   tags: Optional[Mapping[str, str]] = None)

func NewEventGridTopic(ctx *Context, name string, args EventGridTopicArgs, opts ...ResourceOption) (*EventGridTopic, error)

public EventGridTopic(string name, EventGridTopicArgs args, CustomResourceOptions? opts = null)

public EventGridTopic(String name, EventGridTopicArgs args)
public EventGridTopic(String name, EventGridTopicArgs args, CustomResourceOptions options)

type: azure:eventhub:EventGridTopic
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args EventGridTopicArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args EventGridTopicArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args EventGridTopicArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args EventGridTopicArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args EventGridTopicArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

EventGridTopic Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The EventGridTopic resource accepts the following input properties:

ResourceGroupName string: The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.
Identity EventGridTopicIdentity: An identity block as defined below.
InboundIpRules List<EventGridTopicInboundIpRule>: One or more inbound_ip_rule blocks as defined below.
InputMappingDefaultValues EventGridTopicInputMappingDefaultValues: A input_mapping_default_values block as defined below. Changing this forces a new resource to be created.
InputMappingFields EventGridTopicInputMappingFields: A input_mapping_fields block as defined below. Changing this forces a new resource to be created.
InputSchema string: 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.
LocalAuthEnabled bool: Whether local authentication methods is enabled for the EventGrid Topic. Defaults to true.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the EventGrid Topic resource. Changing this forces a new resource to be created.
PublicNetworkAccessEnabled bool: Whether or not public network access is allowed for this server. Defaults to true.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

ResourceGroupName string: The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.
Identity EventGridTopicIdentityArgs: An identity block as defined below.
InboundIpRules []EventGridTopicInboundIpRuleArgs: One or more inbound_ip_rule blocks as defined below.
InputMappingDefaultValues EventGridTopicInputMappingDefaultValuesArgs: A input_mapping_default_values block as defined below. Changing this forces a new resource to be created.
InputMappingFields EventGridTopicInputMappingFieldsArgs: A input_mapping_fields block as defined below. Changing this forces a new resource to be created.
InputSchema string: 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.
LocalAuthEnabled bool: Whether local authentication methods is enabled for the EventGrid Topic. Defaults to true.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the EventGrid Topic resource. Changing this forces a new resource to be created.
PublicNetworkAccessEnabled bool: Whether or not public network access is allowed for this server. Defaults to true.
Tags map[string]string: A mapping of tags to assign to the resource.

resourceGroupName String: The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.
identity EventGridTopicIdentity: An identity block as defined below.
inboundIpRules List<EventGridTopicInboundIpRule>: One or more inbound_ip_rule blocks as defined below.
inputMappingDefaultValues EventGridTopicInputMappingDefaultValues: A input_mapping_default_values block as defined below. Changing this forces a new resource to be created.
inputMappingFields EventGridTopicInputMappingFields: A input_mapping_fields block as defined below. Changing this forces a new resource to be created.
inputSchema String: 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.
localAuthEnabled Boolean: Whether local authentication methods is enabled for the EventGrid Topic. Defaults to true.
location String: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name String: Specifies the name of the EventGrid Topic resource. Changing this forces a new resource to be created.
publicNetworkAccessEnabled Boolean: Whether or not public network access is allowed for this server. Defaults to true.
tags Map<String,String>: A mapping of tags to assign to the resource.

resourceGroupName string: The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.
identity EventGridTopicIdentity: An identity block as defined below.
inboundIpRules EventGridTopicInboundIpRule[]: One or more inbound_ip_rule blocks as defined below.
inputMappingDefaultValues EventGridTopicInputMappingDefaultValues: A input_mapping_default_values block as defined below. Changing this forces a new resource to be created.
inputMappingFields EventGridTopicInputMappingFields: A input_mapping_fields block as defined below. Changing this forces a new resource to be created.
inputSchema string: 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.
localAuthEnabled boolean: Whether local authentication methods is enabled for the EventGrid Topic. Defaults to true.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: Specifies the name of the EventGrid Topic resource. Changing this forces a new resource to be created.
publicNetworkAccessEnabled boolean: Whether or not public network access is allowed for this server. Defaults to true.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

resource_group_name str: The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.
identity EventGridTopicIdentityArgs: An identity block as defined below.
inbound_ip_rules Sequence[EventGridTopicInboundIpRuleArgs]: One or more inbound_ip_rule blocks as defined below.
input_mapping_default_values EventGridTopicInputMappingDefaultValuesArgs: A input_mapping_default_values block as defined below. Changing this forces a new resource to be created.
input_mapping_fields EventGridTopicInputMappingFieldsArgs: A input_mapping_fields block as defined below. Changing this forces a new resource to be created.
input_schema 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.
local_auth_enabled bool: Whether local authentication methods is enabled for the EventGrid Topic. Defaults to true.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: Specifies the name of the EventGrid Topic resource. Changing this forces a new resource to be created.
public_network_access_enabled bool: Whether or not public network access is allowed for this server. Defaults to true.
tags Mapping[str, str]: A mapping of tags to assign to the resource.

resourceGroupName String: The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.
identity Property Map: An identity block as defined below.
inboundIpRules List<Property Map>: One or more inbound_ip_rule blocks as defined below.
inputMappingDefaultValues Property Map: A input_mapping_default_values block as defined below. Changing this forces a new resource to be created.
inputMappingFields Property Map: A input_mapping_fields block as defined below. Changing this forces a new resource to be created.
inputSchema String: 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.
localAuthEnabled Boolean: Whether local authentication methods is enabled for the EventGrid Topic. Defaults to true.
location String: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name String: Specifies the name of the EventGrid Topic resource. Changing this forces a new resource to be created.
publicNetworkAccessEnabled Boolean: Whether or not public network access is allowed for this server. Defaults to true.
tags Map<String>: A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the EventGridTopic resource produces the following output properties:

Endpoint string: The Endpoint associated with the EventGrid Topic.
Id string: The provider-assigned unique ID for this managed resource.
PrimaryAccessKey string: The Primary Shared Access Key associated with the EventGrid Topic.
SecondaryAccessKey string: The Secondary Shared Access Key associated with the EventGrid Topic.

Endpoint string: The Endpoint associated with the EventGrid Topic.
Id string: The provider-assigned unique ID for this managed resource.
PrimaryAccessKey string: The Primary Shared Access Key associated with the EventGrid Topic.
SecondaryAccessKey string: The Secondary Shared Access Key associated with the EventGrid Topic.

endpoint String: The Endpoint associated with the EventGrid Topic.
id String: The provider-assigned unique ID for this managed resource.
primaryAccessKey String: The Primary Shared Access Key associated with the EventGrid Topic.
secondaryAccessKey String: The Secondary Shared Access Key associated with the EventGrid Topic.

endpoint string: The Endpoint associated with the EventGrid Topic.
id string: The provider-assigned unique ID for this managed resource.
primaryAccessKey string: The Primary Shared Access Key associated with the EventGrid Topic.
secondaryAccessKey string: The Secondary Shared Access Key associated with the EventGrid Topic.

endpoint str: The Endpoint associated with the EventGrid Topic.
id str: The provider-assigned unique ID for this managed resource.
primary_access_key str: The Primary Shared Access Key associated with the EventGrid Topic.
secondary_access_key str: The Secondary Shared Access Key associated with the EventGrid Topic.

endpoint String: The Endpoint associated with the EventGrid Topic.
id String: The provider-assigned unique ID for this managed resource.
primaryAccessKey String: The Primary Shared Access Key associated with the EventGrid Topic.
secondaryAccessKey String: The Secondary Shared Access Key associated with the EventGrid Topic.

Look up Existing EventGridTopic Resource

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

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: EventGridTopicState, opts?: CustomResourceOptions): EventGridTopic

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        endpoint: Optional[str] = None,
        identity: Optional[EventGridTopicIdentityArgs] = None,
        inbound_ip_rules: Optional[Sequence[EventGridTopicInboundIpRuleArgs]] = None,
        input_mapping_default_values: Optional[EventGridTopicInputMappingDefaultValuesArgs] = None,
        input_mapping_fields: Optional[EventGridTopicInputMappingFieldsArgs] = None,
        input_schema: Optional[str] = None,
        local_auth_enabled: Optional[bool] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        primary_access_key: Optional[str] = None,
        public_network_access_enabled: Optional[bool] = None,
        resource_group_name: Optional[str] = None,
        secondary_access_key: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> EventGridTopic

func GetEventGridTopic(ctx *Context, name string, id IDInput, state *EventGridTopicState, opts ...ResourceOption) (*EventGridTopic, error)

public static EventGridTopic Get(string name, Input<string> id, EventGridTopicState? state, CustomResourceOptions? opts = null)

public static EventGridTopic get(String name, Output<String> id, EventGridTopicState state, CustomResourceOptions options)

resources:  _:    type: azure:eventhub:EventGridTopic    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Endpoint string: The Endpoint associated with the EventGrid Topic.
Identity EventGridTopicIdentity: An identity block as defined below.
InboundIpRules List<EventGridTopicInboundIpRule>: One or more inbound_ip_rule blocks as defined below.
InputMappingDefaultValues EventGridTopicInputMappingDefaultValues: A input_mapping_default_values block as defined below. Changing this forces a new resource to be created.
InputMappingFields EventGridTopicInputMappingFields: A input_mapping_fields block as defined below. Changing this forces a new resource to be created.
InputSchema string: 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.
LocalAuthEnabled bool: Whether local authentication methods is enabled for the EventGrid Topic. Defaults to true.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the EventGrid Topic resource. Changing this forces a new resource to be created.
PrimaryAccessKey string: The Primary Shared Access Key associated with the EventGrid Topic.
PublicNetworkAccessEnabled bool: Whether or not public network access is allowed for this server. Defaults to true.
ResourceGroupName string: The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.
SecondaryAccessKey string: The Secondary Shared Access Key associated with the EventGrid Topic.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

Endpoint string: The Endpoint associated with the EventGrid Topic.
Identity EventGridTopicIdentityArgs: An identity block as defined below.
InboundIpRules []EventGridTopicInboundIpRuleArgs: One or more inbound_ip_rule blocks as defined below.
InputMappingDefaultValues EventGridTopicInputMappingDefaultValuesArgs: A input_mapping_default_values block as defined below. Changing this forces a new resource to be created.
InputMappingFields EventGridTopicInputMappingFieldsArgs: A input_mapping_fields block as defined below. Changing this forces a new resource to be created.
InputSchema string: 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.
LocalAuthEnabled bool: Whether local authentication methods is enabled for the EventGrid Topic. Defaults to true.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the EventGrid Topic resource. Changing this forces a new resource to be created.
PrimaryAccessKey string: The Primary Shared Access Key associated with the EventGrid Topic.
PublicNetworkAccessEnabled bool: Whether or not public network access is allowed for this server. Defaults to true.
ResourceGroupName string: The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.
SecondaryAccessKey string: The Secondary Shared Access Key associated with the EventGrid Topic.
Tags map[string]string: A mapping of tags to assign to the resource.

endpoint String: The Endpoint associated with the EventGrid Topic.
identity EventGridTopicIdentity: An identity block as defined below.
inboundIpRules List<EventGridTopicInboundIpRule>: One or more inbound_ip_rule blocks as defined below.
inputMappingDefaultValues EventGridTopicInputMappingDefaultValues: A input_mapping_default_values block as defined below. Changing this forces a new resource to be created.
inputMappingFields EventGridTopicInputMappingFields: A input_mapping_fields block as defined below. Changing this forces a new resource to be created.
inputSchema String: 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.
localAuthEnabled Boolean: Whether local authentication methods is enabled for the EventGrid Topic. Defaults to true.
location String: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name String: Specifies the name of the EventGrid Topic resource. Changing this forces a new resource to be created.
primaryAccessKey String: The Primary Shared Access Key associated with the EventGrid Topic.
publicNetworkAccessEnabled Boolean: Whether or not public network access is allowed for this server. Defaults to true.
resourceGroupName String: The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.
secondaryAccessKey String: The Secondary Shared Access Key associated with the EventGrid Topic.
tags Map<String,String>: A mapping of tags to assign to the resource.

endpoint string: The Endpoint associated with the EventGrid Topic.
identity EventGridTopicIdentity: An identity block as defined below.
inboundIpRules EventGridTopicInboundIpRule[]: One or more inbound_ip_rule blocks as defined below.
inputMappingDefaultValues EventGridTopicInputMappingDefaultValues: A input_mapping_default_values block as defined below. Changing this forces a new resource to be created.
inputMappingFields EventGridTopicInputMappingFields: A input_mapping_fields block as defined below. Changing this forces a new resource to be created.
inputSchema string: 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.
localAuthEnabled boolean: Whether local authentication methods is enabled for the EventGrid Topic. Defaults to true.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: Specifies the name of the EventGrid Topic resource. Changing this forces a new resource to be created.
primaryAccessKey string: The Primary Shared Access Key associated with the EventGrid Topic.
publicNetworkAccessEnabled boolean: Whether or not public network access is allowed for this server. Defaults to true.
resourceGroupName string: The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.
secondaryAccessKey string: The Secondary Shared Access Key associated with the EventGrid Topic.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

endpoint str: The Endpoint associated with the EventGrid Topic.
identity EventGridTopicIdentityArgs: An identity block as defined below.
inbound_ip_rules Sequence[EventGridTopicInboundIpRuleArgs]: One or more inbound_ip_rule blocks as defined below.
input_mapping_default_values EventGridTopicInputMappingDefaultValuesArgs: A input_mapping_default_values block as defined below. Changing this forces a new resource to be created.
input_mapping_fields EventGridTopicInputMappingFieldsArgs: A input_mapping_fields block as defined below. Changing this forces a new resource to be created.
input_schema 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.
local_auth_enabled bool: Whether local authentication methods is enabled for the EventGrid Topic. Defaults to true.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: Specifies the name of the EventGrid Topic resource. Changing this forces a new resource to be created.
primary_access_key str: The Primary Shared Access Key associated with the EventGrid Topic.
public_network_access_enabled bool: Whether or not public network access is allowed for this server. Defaults to true.
resource_group_name 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 str: The Secondary Shared Access Key associated with the EventGrid Topic.
tags Mapping[str, str]: A mapping of tags to assign to the resource.

endpoint String: The Endpoint associated with the EventGrid Topic.
identity Property Map: An identity block as defined below.
inboundIpRules List<Property Map>: One or more inbound_ip_rule blocks as defined below.
inputMappingDefaultValues Property Map: A input_mapping_default_values block as defined below. Changing this forces a new resource to be created.
inputMappingFields Property Map: A input_mapping_fields block as defined below. Changing this forces a new resource to be created.
inputSchema String: 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.
localAuthEnabled Boolean: Whether local authentication methods is enabled for the EventGrid Topic. Defaults to true.
location String: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name String: Specifies the name of the EventGrid Topic resource. Changing this forces a new resource to be created.
primaryAccessKey String: The Primary Shared Access Key associated with the EventGrid Topic.
publicNetworkAccessEnabled Boolean: Whether or not public network access is allowed for this server. Defaults to true.
resourceGroupName String: The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.
secondaryAccessKey String: The Secondary Shared Access Key associated with the EventGrid Topic.
tags Map<String>: A mapping of tags to assign to the resource.

Supporting Types

EventGridTopicIdentity
, EventGridTopicIdentityArgs

Type string: Specifies the type of Managed Service Identity that should be configured on this Event Grid Topic. Possible values are SystemAssigned, UserAssigned.
IdentityIds List<string>: Specifies a list of User Assigned Managed Identity IDs to be assigned to this Event Grid Topic.
NOTE: This is required when type is set to UserAssigned
NOTE: When type is set to SystemAssigned, The assigned principal_id and tenant_id can be retrieved after the Event Grid Topic has been created. More details are available below.
PrincipalId string: The Principal ID associated with this Managed Service Identity.
TenantId string: The Tenant ID associated with this Managed Service Identity.

Type string: Specifies the type of Managed Service Identity that should be configured on this Event Grid Topic. Possible values are SystemAssigned, UserAssigned.
IdentityIds []string: Specifies a list of User Assigned Managed Identity IDs to be assigned to this Event Grid Topic.
NOTE: This is required when type is set to UserAssigned
NOTE: When type is set to SystemAssigned, The assigned principal_id and tenant_id can be retrieved after the Event Grid Topic has been created. More details are available below.
PrincipalId string: The Principal ID associated with this Managed Service Identity.
TenantId string: The Tenant ID associated with this Managed Service Identity.

type String: Specifies the type of Managed Service Identity that should be configured on this Event Grid Topic. Possible values are SystemAssigned, UserAssigned.
identityIds List<String>: Specifies a list of User Assigned Managed Identity IDs to be assigned to this Event Grid Topic.
NOTE: This is required when type is set to UserAssigned
NOTE: When type is set to SystemAssigned, The assigned principal_id and tenant_id can be retrieved after the Event Grid Topic has been created. More details are available below.
principalId String: The Principal ID associated with this Managed Service Identity.
tenantId String: The Tenant ID associated with this Managed Service Identity.

type string: Specifies the type of Managed Service Identity that should be configured on this Event Grid Topic. Possible values are SystemAssigned, UserAssigned.
identityIds string[]: Specifies a list of User Assigned Managed Identity IDs to be assigned to this Event Grid Topic.
NOTE: This is required when type is set to UserAssigned
NOTE: When type is set to SystemAssigned, The assigned principal_id and tenant_id can be retrieved after the Event Grid Topic has been created. More details are available below.
principalId string: The Principal ID associated with this Managed Service Identity.
tenantId string: The Tenant ID associated with this Managed Service Identity.

type str: Specifies the type of Managed Service Identity that should be configured on this Event Grid Topic. Possible values are SystemAssigned, UserAssigned.
identity_ids Sequence[str]: Specifies a list of User Assigned Managed Identity IDs to be assigned to this Event Grid Topic.
NOTE: This is required when type is set to UserAssigned
NOTE: When type is set to SystemAssigned, The assigned principal_id and tenant_id can be retrieved after the Event Grid Topic has been created. More details are available below.
principal_id str: The Principal ID associated with this Managed Service Identity.
tenant_id str: The Tenant ID associated with this Managed Service Identity.

type String: Specifies the type of Managed Service Identity that should be configured on this Event Grid Topic. Possible values are SystemAssigned, UserAssigned.
identityIds List<String>: Specifies a list of User Assigned Managed Identity IDs to be assigned to this Event Grid Topic.
NOTE: This is required when type is set to UserAssigned
NOTE: When type is set to SystemAssigned, The assigned principal_id and tenant_id can be retrieved after the Event Grid Topic has been created. More details are available below.
principalId String: The Principal ID associated with this Managed Service Identity.
tenantId String: The Tenant ID associated with this Managed Service Identity.

EventGridTopicInboundIpRule
, EventGridTopicInboundIpRuleArgs

IpMask string: The IP mask (CIDR) to match on.
Action string: The action to take when the rule is matched. Possible values are Allow. Defaults to Allow.

IpMask string: The IP mask (CIDR) to match on.
Action string: The action to take when the rule is matched. Possible values are Allow. Defaults to Allow.

ipMask String: The IP mask (CIDR) to match on.
action String: The action to take when the rule is matched. Possible values are Allow. Defaults to Allow.

ipMask string: The IP mask (CIDR) to match on.
action string: The action to take when the rule is matched. Possible values are Allow. Defaults to Allow.

ip_mask str: The IP mask (CIDR) to match on.
action str: The action to take when the rule is matched. Possible values are Allow. Defaults to Allow.

ipMask String: The IP mask (CIDR) to match on.
action String: The action to take when the rule is matched. Possible values are Allow. Defaults to Allow.

EventGridTopicInputMappingDefaultValues
, EventGridTopicInputMappingDefaultValuesArgs

DataVersion string: Specifies the default data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
EventType string: Specifies the default event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
Subject string: Specifies the default subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

DataVersion string: Specifies the default data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
EventType string: Specifies the default event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
Subject string: Specifies the default subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

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

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

data_version str: Specifies the default data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
event_type 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.

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

EventGridTopicInputMappingFields
, EventGridTopicInputMappingFieldsArgs

DataVersion string: Specifies the data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
EventTime string: Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
EventType string: Specifies the event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
Id string: Specifies the id of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
Subject string: Specifies the subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
Topic string: Specifies the topic of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

DataVersion string: Specifies the data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
EventTime string: Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
EventType string: Specifies the event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
Id string: Specifies the id of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
Subject string: Specifies the subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
Topic string: Specifies the topic of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

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

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

data_version str: Specifies the data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
event_time str: Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
event_type 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.

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

Import

EventGrid Topic’s can be imported using the resource id, e.g.

$ pulumi import azure:eventhub/eventGridTopic:EventGridTopic topic1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.EventGrid/topics/topic1

To learn more about importing existing cloud resources, see Importing resources.

Package Details

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

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

pulumi/pulumi-azure

azure.eventhub.EventGridTopic

On this page

On this page

Example Usage

Create EventGridTopic Resource

Constructor syntax

Parameters

EventGridTopic Resource Properties

Inputs

Outputs

Look up Existing EventGridTopic Resource

Supporting Types

EventGridTopicIdentity
, EventGridTopicIdentityArgs

EventGridTopicInboundIpRule
, EventGridTopicInboundIpRuleArgs

EventGridTopicInputMappingDefaultValues
, EventGridTopicInputMappingDefaultValuesArgs

EventGridTopicInputMappingFields
, EventGridTopicInputMappingFieldsArgs

Import

Package Details

On this page

On this page

azure.eventhub.EventGridTopic

On this page

On this page

Example Usage

Create EventGridTopic Resource

Constructor syntax

Parameters

EventGridTopic Resource Properties

Inputs

Outputs

Look up Existing EventGridTopic Resource

Supporting Types

EventGridTopicIdentity, EventGridTopicIdentityArgs

EventGridTopicInboundIpRule, EventGridTopicInboundIpRuleArgs

EventGridTopicInputMappingDefaultValues, EventGridTopicInputMappingDefaultValuesArgs

EventGridTopicInputMappingFields, EventGridTopicInputMappingFieldsArgs

Import

Package Details

On this page

On this page

EventGridTopicIdentity
, EventGridTopicIdentityArgs

EventGridTopicInboundIpRule
, EventGridTopicInboundIpRuleArgs

EventGridTopicInputMappingDefaultValues
, EventGridTopicInputMappingDefaultValuesArgs

EventGridTopicInputMappingFields
, EventGridTopicInputMappingFieldsArgs