Class EventGridTopic
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" },
},
});
}
}
Inherited Members
Namespace: Pulumi.Azure.EventHub
Assembly: Pulumi.Azure.dll
Syntax
[Obsolete("azure.eventhub.EventGridTopic has been deprecated in favor of azure.eventgrid.Topic")]
public class EventGridTopic : CustomResource
Constructors
View SourceEventGridTopic(String, EventGridTopicArgs, CustomResourceOptions)
Create a EventGridTopic resource with the given unique name, arguments, and options.
Declaration
public EventGridTopic(string name, EventGridTopicArgs args, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resource |
| EventGridTopicArgs | args | The arguments used to populate this resource's properties |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Properties
View SourceEndpoint
The Endpoint associated with the EventGrid Topic.
Declaration
public Output<string> Endpoint { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
InputMappingDefaultValues
A input_mapping_default_values block as defined below.
Declaration
public Output<EventGridTopicInputMappingDefaultValues> InputMappingDefaultValues { get; }
Property Value
| Type | Description |
|---|---|
| Output<EventGridTopicInputMappingDefaultValues> |
InputMappingFields
A input_mapping_fields block as defined below.
Declaration
public Output<EventGridTopicInputMappingFields> InputMappingFields { get; }
Property Value
| Type | Description |
|---|---|
| Output<EventGridTopicInputMappingFields> |
InputSchema
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.
Declaration
public Output<string> InputSchema { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Location
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Declaration
public Output<string> Location { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Name
Specifies the name of the EventGrid Topic resource. Changing this forces a new resource to be created.
Declaration
public Output<string> Name { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
PrimaryAccessKey
The Primary Shared Access Key associated with the EventGrid Topic.
Declaration
public Output<string> PrimaryAccessKey { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
ResourceGroupName
The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.
Declaration
public Output<string> ResourceGroupName { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
SecondaryAccessKey
The Secondary Shared Access Key associated with the EventGrid Topic.
Declaration
public Output<string> SecondaryAccessKey { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Tags
A mapping of tags to assign to the resource.
Declaration
public Output<ImmutableDictionary<string, string>> Tags { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>> |
Methods
View SourceGet(String, Input<String>, EventGridTopicState, CustomResourceOptions)
Get an existing EventGridTopic resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
Declaration
public static EventGridTopic Get(string name, Input<string> id, EventGridTopicState state = null, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resulting resource. |
| Input<System.String> | id | The unique provider ID of the resource to lookup. |
| EventGridTopicState | state | Any extra arguments used during the lookup. |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Returns
| Type | Description |
|---|---|
| EventGridTopic |