Topic

Manages an EventGrid Topic

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

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West US 2",
        });
        var exampleTopic = new Azure.EventGrid.Topic("exampleTopic", new Azure.EventGrid.TopicArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            Tags = 
            {
                { "environment", "Production" },
            },
        });
    }

}

package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
            Location: pulumi.String("West US 2"),
        })
        if err != nil {
            return err
        }
        _, err = eventgrid.NewTopic(ctx, "exampleTopic", &eventgrid.TopicArgs{
            Location:          exampleResourceGroup.Location,
            ResourceGroupName: exampleResourceGroup.Name,
            Tags: pulumi.Map{
                "environment": pulumi.String("Production"),
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}

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",
    })

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US 2"});
const exampleTopic = new azure.eventgrid.Topic("exampleTopic", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    tags: {
        environment: "Production",
    },
});

Create a Topic Resource

new Topic(name: string, args: TopicArgs, opts?: CustomResourceOptions);

def 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);

func NewTopic(ctx *Context, name string, args TopicArgs, opts ...ResourceOption) (*Topic, error)

public Topic(string name, TopicArgs args, CustomResourceOptions? opts = null)

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

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

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

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

Topic Resource Properties

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

Inputs

The Topic 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.
InputMappingDefaultValues TopicInputMappingDefaultValuesArgs: A input_mapping_default_values block as defined below.
InputMappingFields TopicInputMappingFieldsArgs: A input_mapping_fields block as defined below.
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.
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.
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.
InputMappingDefaultValues TopicInputMappingDefaultValues: A input_mapping_default_values block as defined below.
InputMappingFields TopicInputMappingFields: A input_mapping_fields block as defined below.
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.
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.
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.
inputMappingDefaultValues TopicInputMappingDefaultValues: A input_mapping_default_values block as defined below.
inputMappingFields TopicInputMappingFields: A input_mapping_fields block as defined below.
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.
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.
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.
input_mapping_default_values Dict[TopicInputMappingDefaultValues]: A input_mapping_default_values block as defined below.
input_mapping_fields Dict[TopicInputMappingFields]: A input_mapping_fields block as defined below.
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.
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.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the Topic 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 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.

Look up an Existing Topic Resource

Get an existing Topic 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?: TopicState, opts?: CustomResourceOptions): Topic

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, __props__=None);

func GetTopic(ctx *Context, name string, id IDInput, state *TopicState, opts ...ResourceOption) (*Topic, error)

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

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

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

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

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

The following state arguments are supported:

Endpoint string: The Endpoint associated with the EventGrid Topic.
InputMappingDefaultValues TopicInputMappingDefaultValuesArgs: A input_mapping_default_values block as defined below.
InputMappingFields TopicInputMappingFieldsArgs: A input_mapping_fields block as defined below.
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.
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.
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.
InputMappingDefaultValues TopicInputMappingDefaultValues: A input_mapping_default_values block as defined below.
InputMappingFields TopicInputMappingFields: A input_mapping_fields block as defined below.
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.
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.
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.
inputMappingDefaultValues TopicInputMappingDefaultValues: A input_mapping_default_values block as defined below.
inputMappingFields TopicInputMappingFields: A input_mapping_fields block as defined below.
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.
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.
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.
input_mapping_default_values Dict[TopicInputMappingDefaultValues]: A input_mapping_default_values block as defined below.
input_mapping_fields Dict[TopicInputMappingFields]: A input_mapping_fields block as defined below.
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.
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.
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 Dict[str, str]: A mapping of tags to assign to the resource.

Supporting Types

TopicInputMappingDefaultValues

See the input and output API doc for this type.

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 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.

TopicInputMappingFields

See the input and output API doc for this type.

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 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.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Topic

Example Usage

Create a Topic Resource

Topic Resource Properties

Inputs

A mapping of tags to assign to the resource.

A mapping of tags to assign to the resource.

A mapping of tags to assign to the resource.

A mapping of tags to assign to the resource.

Outputs

Look up an Existing Topic Resource

A mapping of tags to assign to the resource.

A mapping of tags to assign to the resource.

A mapping of tags to assign to the resource.

A mapping of tags to assign to the resource.

Supporting Types

TopicInputMappingDefaultValues

TopicInputMappingFields

Package Details

On This Page