We recommend using Azure Native.
azure.eventhub.EventGridTopic
Explore with Pulumi AI
Manages an EventGrid Topic
Note: at this time EventGrid Topic’s are only available in a limited number of regions.
Example Usage
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.
Constructor syntax
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:
- Resource
Group stringName - The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.
- Identity
Event
Grid Topic Identity - An
identity
block as defined below. - Inbound
Ip List<EventRules Grid Topic Inbound Ip Rule> - One or more
inbound_ip_rule
blocks as defined below. - Input
Mapping EventDefault Values Grid Topic Input Mapping Default Values - A
input_mapping_default_values
block as defined below. Changing this forces a new resource to be created. - Input
Mapping EventFields Grid Topic Input Mapping Fields - A
input_mapping_fields
block as defined below. Changing this forces a new resource to be created. - Input
Schema string - Specifies the schema in which incoming events will be published to this domain. Allowed values are
CloudEventSchemaV1_0
,CustomEventSchema
, orEventGridSchema
. Defaults toEventGridSchema
. Changing this forces a new resource to be created. - Local
Auth boolEnabled - 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.
- Public
Network boolAccess Enabled - Whether or not public network access is allowed for this server. Defaults to
true
. - Dictionary<string, string>
- A mapping of tags to assign to the resource.
- Resource
Group stringName - The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.
- Identity
Event
Grid Topic Identity Args - An
identity
block as defined below. - Inbound
Ip []EventRules Grid Topic Inbound Ip Rule Args - One or more
inbound_ip_rule
blocks as defined below. - Input
Mapping EventDefault Values Grid Topic Input Mapping Default Values Args - A
input_mapping_default_values
block as defined below. Changing this forces a new resource to be created. - Input
Mapping EventFields Grid Topic Input Mapping Fields Args - A
input_mapping_fields
block as defined below. Changing this forces a new resource to be created. - Input
Schema string - Specifies the schema in which incoming events will be published to this domain. Allowed values are
CloudEventSchemaV1_0
,CustomEventSchema
, orEventGridSchema
. Defaults toEventGridSchema
. Changing this forces a new resource to be created. - Local
Auth boolEnabled - 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.
- Public
Network boolAccess Enabled - Whether or not public network access is allowed for this server. Defaults to
true
. - map[string]string
- A mapping of tags to assign to the resource.
- resource
Group StringName - The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.
- identity
Event
Grid Topic Identity - An
identity
block as defined below. - inbound
Ip List<EventRules Grid Topic Inbound Ip Rule> - One or more
inbound_ip_rule
blocks as defined below. - input
Mapping EventDefault Values Grid Topic Input Mapping Default Values - A
input_mapping_default_values
block as defined below. Changing this forces a new resource to be created. - input
Mapping EventFields Grid Topic Input Mapping Fields - A
input_mapping_fields
block as defined below. Changing this forces a new resource to be created. - input
Schema String - Specifies the schema in which incoming events will be published to this domain. Allowed values are
CloudEventSchemaV1_0
,CustomEventSchema
, orEventGridSchema
. Defaults toEventGridSchema
. Changing this forces a new resource to be created. - local
Auth BooleanEnabled - 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.
- public
Network BooleanAccess Enabled - Whether or not public network access is allowed for this server. Defaults to
true
. - Map<String,String>
- A mapping of tags to assign to the resource.
- resource
Group stringName - The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.
- identity
Event
Grid Topic Identity - An
identity
block as defined below. - inbound
Ip EventRules Grid Topic Inbound Ip Rule[] - One or more
inbound_ip_rule
blocks as defined below. - input
Mapping EventDefault Values Grid Topic Input Mapping Default Values - A
input_mapping_default_values
block as defined below. Changing this forces a new resource to be created. - input
Mapping EventFields Grid Topic Input Mapping Fields - A
input_mapping_fields
block as defined below. Changing this forces a new resource to be created. - input
Schema string - Specifies the schema in which incoming events will be published to this domain. Allowed values are
CloudEventSchemaV1_0
,CustomEventSchema
, orEventGridSchema
. Defaults toEventGridSchema
. Changing this forces a new resource to be created. - local
Auth booleanEnabled - 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.
- public
Network booleanAccess Enabled - Whether or not public network access is allowed for this server. Defaults to
true
. - {[key: string]: string}
- A mapping of tags to assign to the resource.
- resource_
group_ strname - The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.
- identity
Event
Grid Topic Identity Args - An
identity
block as defined below. - inbound_
ip_ Sequence[Eventrules Grid Topic Inbound Ip Rule Args] - One or more
inbound_ip_rule
blocks as defined below. - input_
mapping_ Eventdefault_ values Grid Topic Input Mapping Default Values Args - A
input_mapping_default_values
block as defined below. Changing this forces a new resource to be created. - input_
mapping_ Eventfields Grid Topic Input Mapping Fields Args - 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
, orEventGridSchema
. Defaults toEventGridSchema
. Changing this forces a new resource to be created. - local_
auth_ boolenabled - 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_ boolaccess_ enabled - Whether or not public network access is allowed for this server. Defaults to
true
. - Mapping[str, str]
- A mapping of tags to assign to the resource.
- resource
Group StringName - 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. - inbound
Ip List<Property Map>Rules - One or more
inbound_ip_rule
blocks as defined below. - input
Mapping Property MapDefault Values - A
input_mapping_default_values
block as defined below. Changing this forces a new resource to be created. - input
Mapping Property MapFields - A
input_mapping_fields
block as defined below. Changing this forces a new resource to be created. - input
Schema String - Specifies the schema in which incoming events will be published to this domain. Allowed values are
CloudEventSchemaV1_0
,CustomEventSchema
, orEventGridSchema
. Defaults toEventGridSchema
. Changing this forces a new resource to be created. - local
Auth BooleanEnabled - 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.
- public
Network BooleanAccess Enabled - Whether or not public network access is allowed for this server. Defaults to
true
. - 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.
- Primary
Access stringKey - The Primary Shared Access Key associated with the EventGrid Topic.
- Secondary
Access stringKey - 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.
- Primary
Access stringKey - The Primary Shared Access Key associated with the EventGrid Topic.
- Secondary
Access stringKey - 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.
- primary
Access StringKey - The Primary Shared Access Key associated with the EventGrid Topic.
- secondary
Access StringKey - 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.
- primary
Access stringKey - The Primary Shared Access Key associated with the EventGrid Topic.
- secondary
Access stringKey - 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_ strkey - The Primary Shared Access Key associated with the EventGrid Topic.
- secondary_
access_ strkey - 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.
- primary
Access StringKey - The Primary Shared Access Key associated with the EventGrid Topic.
- secondary
Access StringKey - 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.
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)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Endpoint string
- The Endpoint associated with the EventGrid Topic.
- Identity
Event
Grid Topic Identity - An
identity
block as defined below. - Inbound
Ip List<EventRules Grid Topic Inbound Ip Rule> - One or more
inbound_ip_rule
blocks as defined below. - Input
Mapping EventDefault Values Grid Topic Input Mapping Default Values - A
input_mapping_default_values
block as defined below. Changing this forces a new resource to be created. - Input
Mapping EventFields Grid Topic Input Mapping Fields - A
input_mapping_fields
block as defined below. Changing this forces a new resource to be created. - Input
Schema string - Specifies the schema in which incoming events will be published to this domain. Allowed values are
CloudEventSchemaV1_0
,CustomEventSchema
, orEventGridSchema
. Defaults toEventGridSchema
. Changing this forces a new resource to be created. - Local
Auth boolEnabled - 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.
- Primary
Access stringKey - The Primary Shared Access Key associated with the EventGrid Topic.
- Public
Network boolAccess Enabled - Whether or not public network access is allowed for this server. Defaults to
true
. - Resource
Group stringName - The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.
- Secondary
Access stringKey - The Secondary Shared Access Key associated with the EventGrid Topic.
- Dictionary<string, string>
- A mapping of tags to assign to the resource.
- Endpoint string
- The Endpoint associated with the EventGrid Topic.
- Identity
Event
Grid Topic Identity Args - An
identity
block as defined below. - Inbound
Ip []EventRules Grid Topic Inbound Ip Rule Args - One or more
inbound_ip_rule
blocks as defined below. - Input
Mapping EventDefault Values Grid Topic Input Mapping Default Values Args - A
input_mapping_default_values
block as defined below. Changing this forces a new resource to be created. - Input
Mapping EventFields Grid Topic Input Mapping Fields Args - A
input_mapping_fields
block as defined below. Changing this forces a new resource to be created. - Input
Schema string - Specifies the schema in which incoming events will be published to this domain. Allowed values are
CloudEventSchemaV1_0
,CustomEventSchema
, orEventGridSchema
. Defaults toEventGridSchema
. Changing this forces a new resource to be created. - Local
Auth boolEnabled - 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.
- Primary
Access stringKey - The Primary Shared Access Key associated with the EventGrid Topic.
- Public
Network boolAccess Enabled - Whether or not public network access is allowed for this server. Defaults to
true
. - Resource
Group stringName - The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.
- Secondary
Access stringKey - The Secondary Shared Access Key associated with the EventGrid Topic.
- map[string]string
- A mapping of tags to assign to the resource.
- endpoint String
- The Endpoint associated with the EventGrid Topic.
- identity
Event
Grid Topic Identity - An
identity
block as defined below. - inbound
Ip List<EventRules Grid Topic Inbound Ip Rule> - One or more
inbound_ip_rule
blocks as defined below. - input
Mapping EventDefault Values Grid Topic Input Mapping Default Values - A
input_mapping_default_values
block as defined below. Changing this forces a new resource to be created. - input
Mapping EventFields Grid Topic Input Mapping Fields - A
input_mapping_fields
block as defined below. Changing this forces a new resource to be created. - input
Schema String - Specifies the schema in which incoming events will be published to this domain. Allowed values are
CloudEventSchemaV1_0
,CustomEventSchema
, orEventGridSchema
. Defaults toEventGridSchema
. Changing this forces a new resource to be created. - local
Auth BooleanEnabled - 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.
- primary
Access StringKey - The Primary Shared Access Key associated with the EventGrid Topic.
- public
Network BooleanAccess Enabled - Whether or not public network access is allowed for this server. Defaults to
true
. - resource
Group StringName - The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.
- secondary
Access StringKey - The Secondary Shared Access Key associated with the EventGrid Topic.
- Map<String,String>
- A mapping of tags to assign to the resource.
- endpoint string
- The Endpoint associated with the EventGrid Topic.
- identity
Event
Grid Topic Identity - An
identity
block as defined below. - inbound
Ip EventRules Grid Topic Inbound Ip Rule[] - One or more
inbound_ip_rule
blocks as defined below. - input
Mapping EventDefault Values Grid Topic Input Mapping Default Values - A
input_mapping_default_values
block as defined below. Changing this forces a new resource to be created. - input
Mapping EventFields Grid Topic Input Mapping Fields - A
input_mapping_fields
block as defined below. Changing this forces a new resource to be created. - input
Schema string - Specifies the schema in which incoming events will be published to this domain. Allowed values are
CloudEventSchemaV1_0
,CustomEventSchema
, orEventGridSchema
. Defaults toEventGridSchema
. Changing this forces a new resource to be created. - local
Auth booleanEnabled - 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.
- primary
Access stringKey - The Primary Shared Access Key associated with the EventGrid Topic.
- public
Network booleanAccess Enabled - Whether or not public network access is allowed for this server. Defaults to
true
. - resource
Group stringName - The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.
- secondary
Access stringKey - The Secondary Shared Access Key associated with the EventGrid Topic.
- {[key: string]: string}
- A mapping of tags to assign to the resource.
- endpoint str
- The Endpoint associated with the EventGrid Topic.
- identity
Event
Grid Topic Identity Args - An
identity
block as defined below. - inbound_
ip_ Sequence[Eventrules Grid Topic Inbound Ip Rule Args] - One or more
inbound_ip_rule
blocks as defined below. - input_
mapping_ Eventdefault_ values Grid Topic Input Mapping Default Values Args - A
input_mapping_default_values
block as defined below. Changing this forces a new resource to be created. - input_
mapping_ Eventfields Grid Topic Input Mapping Fields Args - 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
, orEventGridSchema
. Defaults toEventGridSchema
. Changing this forces a new resource to be created. - local_
auth_ boolenabled - 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_ strkey - The Primary Shared Access Key associated with the EventGrid Topic.
- public_
network_ boolaccess_ enabled - Whether or not public network access is allowed for this server. Defaults to
true
. - resource_
group_ strname - The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.
- secondary_
access_ strkey - The Secondary Shared Access Key associated with the EventGrid Topic.
- 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. - inbound
Ip List<Property Map>Rules - One or more
inbound_ip_rule
blocks as defined below. - input
Mapping Property MapDefault Values - A
input_mapping_default_values
block as defined below. Changing this forces a new resource to be created. - input
Mapping Property MapFields - A
input_mapping_fields
block as defined below. Changing this forces a new resource to be created. - input
Schema String - Specifies the schema in which incoming events will be published to this domain. Allowed values are
CloudEventSchemaV1_0
,CustomEventSchema
, orEventGridSchema
. Defaults toEventGridSchema
. Changing this forces a new resource to be created. - local
Auth BooleanEnabled - 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.
- primary
Access StringKey - The Primary Shared Access Key associated with the EventGrid Topic.
- public
Network BooleanAccess Enabled - Whether or not public network access is allowed for this server. Defaults to
true
. - resource
Group StringName - The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.
- secondary
Access StringKey - The Secondary Shared Access Key associated with the EventGrid Topic.
- 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
. - Identity
Ids 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 toUserAssigned
NOTE: When
type
is set toSystemAssigned
, The assignedprincipal_id
andtenant_id
can be retrieved after the Event Grid Topic has been created. More details are available below.- Principal
Id string - The Principal ID associated with this Managed Service Identity.
- Tenant
Id 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
. - Identity
Ids []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 toUserAssigned
NOTE: When
type
is set toSystemAssigned
, The assignedprincipal_id
andtenant_id
can be retrieved after the Event Grid Topic has been created. More details are available below.- Principal
Id string - The Principal ID associated with this Managed Service Identity.
- Tenant
Id 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
. - identity
Ids 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 toUserAssigned
NOTE: When
type
is set toSystemAssigned
, The assignedprincipal_id
andtenant_id
can be retrieved after the Event Grid Topic has been created. More details are available below.- principal
Id String - The Principal ID associated with this Managed Service Identity.
- tenant
Id 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
. - identity
Ids 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 toUserAssigned
NOTE: When
type
is set toSystemAssigned
, The assignedprincipal_id
andtenant_id
can be retrieved after the Event Grid Topic has been created. More details are available below.- principal
Id string - The Principal ID associated with this Managed Service Identity.
- tenant
Id 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 toUserAssigned
NOTE: When
type
is set toSystemAssigned
, The assignedprincipal_id
andtenant_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
. - identity
Ids 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 toUserAssigned
NOTE: When
type
is set toSystemAssigned
, The assignedprincipal_id
andtenant_id
can be retrieved after the Event Grid Topic has been created. More details are available below.- principal
Id String - The Principal ID associated with this Managed Service Identity.
- tenant
Id String - The Tenant ID associated with this Managed Service Identity.
EventGridTopicInboundIpRule, EventGridTopicInboundIpRuleArgs
EventGridTopicInputMappingDefaultValues, EventGridTopicInputMappingDefaultValuesArgs
- Data
Version string - 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 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 string - 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 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 String - 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 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 string - 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 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.
- data
Version String - 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 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
- Data
Version string - Specifies the data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- Event
Time string - Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- Event
Type 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 string - Specifies the data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- Event
Time string - Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- Event
Type 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 String - Specifies the data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- event
Time String - Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- event
Type 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 string - Specifies the data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- event
Time string - Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- event
Type 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.
- data
Version String - Specifies the data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- event
Time String - Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- event
Type 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.