1. Packages
  2. Azure Classic
  3. API Docs
  4. eventgrid
  5. DomainTopic

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

azure.eventgrid.DomainTopic

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

    Manages an EventGrid Domain Topic

    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 exampleDomain = new azure.eventgrid.Domain("example", {
        name: "my-eventgrid-domain",
        location: example.location,
        resourceGroupName: example.name,
        tags: {
            environment: "Production",
        },
    });
    const exampleDomainTopic = new azure.eventgrid.DomainTopic("example", {
        name: "my-eventgrid-domain-topic",
        domainName: exampleDomain.name,
        resourceGroupName: example.name,
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_domain = azure.eventgrid.Domain("example",
        name="my-eventgrid-domain",
        location=example.location,
        resource_group_name=example.name,
        tags={
            "environment": "Production",
        })
    example_domain_topic = azure.eventgrid.DomainTopic("example",
        name="my-eventgrid-domain-topic",
        domain_name=example_domain.name,
        resource_group_name=example.name)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/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
    		}
    		exampleDomain, err := eventgrid.NewDomain(ctx, "example", &eventgrid.DomainArgs{
    			Name:              pulumi.String("my-eventgrid-domain"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    			Tags: pulumi.StringMap{
    				"environment": pulumi.String("Production"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = eventgrid.NewDomainTopic(ctx, "example", &eventgrid.DomainTopicArgs{
    			Name:              pulumi.String("my-eventgrid-domain-topic"),
    			DomainName:        exampleDomain.Name,
    			ResourceGroupName: example.Name,
    		})
    		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 exampleDomain = new Azure.EventGrid.Domain("example", new()
        {
            Name = "my-eventgrid-domain",
            Location = example.Location,
            ResourceGroupName = example.Name,
            Tags = 
            {
                { "environment", "Production" },
            },
        });
    
        var exampleDomainTopic = new Azure.EventGrid.DomainTopic("example", new()
        {
            Name = "my-eventgrid-domain-topic",
            DomainName = exampleDomain.Name,
            ResourceGroupName = example.Name,
        });
    
    });
    
    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.Domain;
    import com.pulumi.azure.eventgrid.DomainArgs;
    import com.pulumi.azure.eventgrid.DomainTopic;
    import com.pulumi.azure.eventgrid.DomainTopicArgs;
    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 exampleDomain = new Domain("exampleDomain", DomainArgs.builder()
                .name("my-eventgrid-domain")
                .location(example.location())
                .resourceGroupName(example.name())
                .tags(Map.of("environment", "Production"))
                .build());
    
            var exampleDomainTopic = new DomainTopic("exampleDomainTopic", DomainTopicArgs.builder()
                .name("my-eventgrid-domain-topic")
                .domainName(exampleDomain.name())
                .resourceGroupName(example.name())
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleDomain:
        type: azure:eventgrid:Domain
        name: example
        properties:
          name: my-eventgrid-domain
          location: ${example.location}
          resourceGroupName: ${example.name}
          tags:
            environment: Production
      exampleDomainTopic:
        type: azure:eventgrid:DomainTopic
        name: example
        properties:
          name: my-eventgrid-domain-topic
          domainName: ${exampleDomain.name}
          resourceGroupName: ${example.name}
    

    Create DomainTopic Resource

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

    Constructor syntax

    new DomainTopic(name: string, args: DomainTopicArgs, opts?: CustomResourceOptions);
    @overload
    def DomainTopic(resource_name: str,
                    args: DomainTopicArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def DomainTopic(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    domain_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    name: Optional[str] = None)
    func NewDomainTopic(ctx *Context, name string, args DomainTopicArgs, opts ...ResourceOption) (*DomainTopic, error)
    public DomainTopic(string name, DomainTopicArgs args, CustomResourceOptions? opts = null)
    public DomainTopic(String name, DomainTopicArgs args)
    public DomainTopic(String name, DomainTopicArgs args, CustomResourceOptions options)
    
    type: azure:eventgrid:DomainTopic
    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 DomainTopicArgs
    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 DomainTopicArgs
    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 DomainTopicArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DomainTopicArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DomainTopicArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var domainTopicResource = new Azure.EventGrid.DomainTopic("domainTopicResource", new()
    {
        DomainName = "string",
        ResourceGroupName = "string",
        Name = "string",
    });
    
    example, err := eventgrid.NewDomainTopic(ctx, "domainTopicResource", &eventgrid.DomainTopicArgs{
    	DomainName:        pulumi.String("string"),
    	ResourceGroupName: pulumi.String("string"),
    	Name:              pulumi.String("string"),
    })
    
    var domainTopicResource = new DomainTopic("domainTopicResource", DomainTopicArgs.builder()
        .domainName("string")
        .resourceGroupName("string")
        .name("string")
        .build());
    
    domain_topic_resource = azure.eventgrid.DomainTopic("domainTopicResource",
        domain_name="string",
        resource_group_name="string",
        name="string")
    
    const domainTopicResource = new azure.eventgrid.DomainTopic("domainTopicResource", {
        domainName: "string",
        resourceGroupName: "string",
        name: "string",
    });
    
    type: azure:eventgrid:DomainTopic
    properties:
        domainName: string
        name: string
        resourceGroupName: string
    

    DomainTopic Resource Properties

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

    Inputs

    The DomainTopic resource accepts the following input properties:

    DomainName string
    Specifies the name of the EventGrid Domain. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the EventGrid Domain Topic resource. Changing this forces a new resource to be created.
    DomainName string
    Specifies the name of the EventGrid Domain. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the EventGrid Domain Topic resource. Changing this forces a new resource to be created.
    domainName String
    Specifies the name of the EventGrid Domain. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of the EventGrid Domain Topic resource. Changing this forces a new resource to be created.
    domainName string
    Specifies the name of the EventGrid Domain. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
    name string
    Specifies the name of the EventGrid Domain Topic resource. Changing this forces a new resource to be created.
    domain_name str
    Specifies the name of the EventGrid Domain. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
    name str
    Specifies the name of the EventGrid Domain Topic resource. Changing this forces a new resource to be created.
    domainName String
    Specifies the name of the EventGrid Domain. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of the EventGrid Domain Topic resource. Changing this forces a new resource to be created.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing DomainTopic Resource

    Get an existing DomainTopic 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?: DomainTopicState, opts?: CustomResourceOptions): DomainTopic
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            domain_name: Optional[str] = None,
            name: Optional[str] = None,
            resource_group_name: Optional[str] = None) -> DomainTopic
    func GetDomainTopic(ctx *Context, name string, id IDInput, state *DomainTopicState, opts ...ResourceOption) (*DomainTopic, error)
    public static DomainTopic Get(string name, Input<string> id, DomainTopicState? state, CustomResourceOptions? opts = null)
    public static DomainTopic get(String name, Output<String> id, DomainTopicState 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.
    The following state arguments are supported:
    DomainName string
    Specifies the name of the EventGrid Domain. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the EventGrid Domain Topic resource. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
    DomainName string
    Specifies the name of the EventGrid Domain. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the EventGrid Domain Topic resource. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
    domainName String
    Specifies the name of the EventGrid Domain. Changing this forces a new resource to be created.
    name String
    Specifies the name of the EventGrid Domain Topic resource. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
    domainName string
    Specifies the name of the EventGrid Domain. Changing this forces a new resource to be created.
    name string
    Specifies the name of the EventGrid Domain Topic resource. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
    domain_name str
    Specifies the name of the EventGrid Domain. Changing this forces a new resource to be created.
    name str
    Specifies the name of the EventGrid Domain Topic resource. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
    domainName String
    Specifies the name of the EventGrid Domain. Changing this forces a new resource to be created.
    name String
    Specifies the name of the EventGrid Domain Topic resource. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.

    Import

    EventGrid Domain Topics can be imported using the resource id, e.g.

    $ pulumi import azure:eventgrid/domainTopic:DomainTopic topic1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.EventGrid/domains/domain1/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.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi