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

We recommend using Azure Native.

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

azure.eventgrid.SystemTopic

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 Event Grid System 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 exampleAccount = new azure.storage.Account("example", {
        name: "examplestoracct",
        resourceGroupName: example.name,
        location: example.location,
        accountTier: "Standard",
        accountReplicationType: "LRS",
        tags: {
            environment: "staging",
        },
    });
    const exampleSystemTopic = new azure.eventgrid.SystemTopic("example", {
        name: "example-topic",
        resourceGroupName: example.name,
        location: example.location,
        sourceArmResourceId: exampleAccount.id,
        topicType: "Microsoft.Storage.StorageAccounts",
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_account = azure.storage.Account("example",
        name="examplestoracct",
        resource_group_name=example.name,
        location=example.location,
        account_tier="Standard",
        account_replication_type="LRS",
        tags={
            "environment": "staging",
        })
    example_system_topic = azure.eventgrid.SystemTopic("example",
        name="example-topic",
        resource_group_name=example.name,
        location=example.location,
        source_arm_resource_id=example_account.id,
        topic_type="Microsoft.Storage.StorageAccounts")
    
    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-azure/sdk/v5/go/azure/storage"
    	"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
    		}
    		exampleAccount, err := storage.NewAccount(ctx, "example", &storage.AccountArgs{
    			Name:                   pulumi.String("examplestoracct"),
    			ResourceGroupName:      example.Name,
    			Location:               example.Location,
    			AccountTier:            pulumi.String("Standard"),
    			AccountReplicationType: pulumi.String("LRS"),
    			Tags: pulumi.StringMap{
    				"environment": pulumi.String("staging"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = eventgrid.NewSystemTopic(ctx, "example", &eventgrid.SystemTopicArgs{
    			Name:                pulumi.String("example-topic"),
    			ResourceGroupName:   example.Name,
    			Location:            example.Location,
    			SourceArmResourceId: exampleAccount.ID(),
    			TopicType:           pulumi.String("Microsoft.Storage.StorageAccounts"),
    		})
    		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 exampleAccount = new Azure.Storage.Account("example", new()
        {
            Name = "examplestoracct",
            ResourceGroupName = example.Name,
            Location = example.Location,
            AccountTier = "Standard",
            AccountReplicationType = "LRS",
            Tags = 
            {
                { "environment", "staging" },
            },
        });
    
        var exampleSystemTopic = new Azure.EventGrid.SystemTopic("example", new()
        {
            Name = "example-topic",
            ResourceGroupName = example.Name,
            Location = example.Location,
            SourceArmResourceId = exampleAccount.Id,
            TopicType = "Microsoft.Storage.StorageAccounts",
        });
    
    });
    
    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.storage.Account;
    import com.pulumi.azure.storage.AccountArgs;
    import com.pulumi.azure.eventgrid.SystemTopic;
    import com.pulumi.azure.eventgrid.SystemTopicArgs;
    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 exampleAccount = new Account("exampleAccount", AccountArgs.builder()
                .name("examplestoracct")
                .resourceGroupName(example.name())
                .location(example.location())
                .accountTier("Standard")
                .accountReplicationType("LRS")
                .tags(Map.of("environment", "staging"))
                .build());
    
            var exampleSystemTopic = new SystemTopic("exampleSystemTopic", SystemTopicArgs.builder()
                .name("example-topic")
                .resourceGroupName(example.name())
                .location(example.location())
                .sourceArmResourceId(exampleAccount.id())
                .topicType("Microsoft.Storage.StorageAccounts")
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleAccount:
        type: azure:storage:Account
        name: example
        properties:
          name: examplestoracct
          resourceGroupName: ${example.name}
          location: ${example.location}
          accountTier: Standard
          accountReplicationType: LRS
          tags:
            environment: staging
      exampleSystemTopic:
        type: azure:eventgrid:SystemTopic
        name: example
        properties:
          name: example-topic
          resourceGroupName: ${example.name}
          location: ${example.location}
          sourceArmResourceId: ${exampleAccount.id}
          topicType: Microsoft.Storage.StorageAccounts
    

    Create SystemTopic Resource

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

    Constructor syntax

    new SystemTopic(name: string, args: SystemTopicArgs, opts?: CustomResourceOptions);
    @overload
    def SystemTopic(resource_name: str,
                    args: SystemTopicArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def SystemTopic(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    resource_group_name: Optional[str] = None,
                    source_arm_resource_id: Optional[str] = None,
                    topic_type: Optional[str] = None,
                    identity: Optional[SystemTopicIdentityArgs] = None,
                    location: Optional[str] = None,
                    name: Optional[str] = None,
                    tags: Optional[Mapping[str, str]] = None)
    func NewSystemTopic(ctx *Context, name string, args SystemTopicArgs, opts ...ResourceOption) (*SystemTopic, error)
    public SystemTopic(string name, SystemTopicArgs args, CustomResourceOptions? opts = null)
    public SystemTopic(String name, SystemTopicArgs args)
    public SystemTopic(String name, SystemTopicArgs args, CustomResourceOptions options)
    
    type: azure:eventgrid:SystemTopic
    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 SystemTopicArgs
    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 SystemTopicArgs
    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 SystemTopicArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SystemTopicArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SystemTopicArgs
    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 systemTopicResource = new Azure.EventGrid.SystemTopic("systemTopicResource", new()
    {
        ResourceGroupName = "string",
        SourceArmResourceId = "string",
        TopicType = "string",
        Identity = new Azure.EventGrid.Inputs.SystemTopicIdentityArgs
        {
            Type = "string",
            IdentityIds = new[]
            {
                "string",
            },
            PrincipalId = "string",
            TenantId = "string",
        },
        Location = "string",
        Name = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := eventgrid.NewSystemTopic(ctx, "systemTopicResource", &eventgrid.SystemTopicArgs{
    	ResourceGroupName:   pulumi.String("string"),
    	SourceArmResourceId: pulumi.String("string"),
    	TopicType:           pulumi.String("string"),
    	Identity: &eventgrid.SystemTopicIdentityArgs{
    		Type: pulumi.String("string"),
    		IdentityIds: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		PrincipalId: pulumi.String("string"),
    		TenantId:    pulumi.String("string"),
    	},
    	Location: pulumi.String("string"),
    	Name:     pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var systemTopicResource = new SystemTopic("systemTopicResource", SystemTopicArgs.builder()
        .resourceGroupName("string")
        .sourceArmResourceId("string")
        .topicType("string")
        .identity(SystemTopicIdentityArgs.builder()
            .type("string")
            .identityIds("string")
            .principalId("string")
            .tenantId("string")
            .build())
        .location("string")
        .name("string")
        .tags(Map.of("string", "string"))
        .build());
    
    system_topic_resource = azure.eventgrid.SystemTopic("systemTopicResource",
        resource_group_name="string",
        source_arm_resource_id="string",
        topic_type="string",
        identity=azure.eventgrid.SystemTopicIdentityArgs(
            type="string",
            identity_ids=["string"],
            principal_id="string",
            tenant_id="string",
        ),
        location="string",
        name="string",
        tags={
            "string": "string",
        })
    
    const systemTopicResource = new azure.eventgrid.SystemTopic("systemTopicResource", {
        resourceGroupName: "string",
        sourceArmResourceId: "string",
        topicType: "string",
        identity: {
            type: "string",
            identityIds: ["string"],
            principalId: "string",
            tenantId: "string",
        },
        location: "string",
        name: "string",
        tags: {
            string: "string",
        },
    });
    
    type: azure:eventgrid:SystemTopic
    properties:
        identity:
            identityIds:
                - string
            principalId: string
            tenantId: string
            type: string
        location: string
        name: string
        resourceGroupName: string
        sourceArmResourceId: string
        tags:
            string: string
        topicType: string
    

    SystemTopic 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 SystemTopic resource accepts the following input properties:

    ResourceGroupName string
    The name of the Resource Group where the Event Grid System Topic should exist. Changing this forces a new Event Grid System Topic to be created.
    SourceArmResourceId string
    The ID of the Event Grid System Topic ARM Source. Changing this forces a new Event Grid System Topic to be created.
    TopicType string

    The Topic Type of the Event Grid System Topic. The topic type is validated by Azure and there may be additional topic types beyond the following: Microsoft.AppConfiguration.ConfigurationStores, Microsoft.Communication.CommunicationServices, Microsoft.ContainerRegistry.Registries, Microsoft.Devices.IoTHubs, Microsoft.EventGrid.Domains, Microsoft.EventGrid.Topics, Microsoft.Eventhub.Namespaces, Microsoft.KeyVault.vaults, Microsoft.MachineLearningServices.Workspaces, Microsoft.Maps.Accounts, Microsoft.Media.MediaServices, Microsoft.Resources.ResourceGroups, Microsoft.Resources.Subscriptions, Microsoft.ServiceBus.Namespaces, Microsoft.SignalRService.SignalR, Microsoft.Storage.StorageAccounts, Microsoft.Web.ServerFarms and Microsoft.Web.Sites. Changing this forces a new Event Grid System Topic to be created.

    NOTE: Some topic_types (e.g. Microsoft.Resources.Subscriptions) requires location to be set to Global instead of a real location like West US.

    NOTE: You can use Azure CLI to get a full list of the available topic types: az eventgrid topic-type list --output json | grep -w id

    Identity SystemTopicIdentity
    An identity block as defined below.
    Location string
    The Azure Region where the Event Grid System Topic should exist. Changing this forces a new Event Grid System Topic to be created.
    Name string
    The name which should be used for this Event Grid System Topic. Changing this forces a new Event Grid System Topic to be created.
    Tags Dictionary<string, string>
    ResourceGroupName string
    The name of the Resource Group where the Event Grid System Topic should exist. Changing this forces a new Event Grid System Topic to be created.
    SourceArmResourceId string
    The ID of the Event Grid System Topic ARM Source. Changing this forces a new Event Grid System Topic to be created.
    TopicType string

    The Topic Type of the Event Grid System Topic. The topic type is validated by Azure and there may be additional topic types beyond the following: Microsoft.AppConfiguration.ConfigurationStores, Microsoft.Communication.CommunicationServices, Microsoft.ContainerRegistry.Registries, Microsoft.Devices.IoTHubs, Microsoft.EventGrid.Domains, Microsoft.EventGrid.Topics, Microsoft.Eventhub.Namespaces, Microsoft.KeyVault.vaults, Microsoft.MachineLearningServices.Workspaces, Microsoft.Maps.Accounts, Microsoft.Media.MediaServices, Microsoft.Resources.ResourceGroups, Microsoft.Resources.Subscriptions, Microsoft.ServiceBus.Namespaces, Microsoft.SignalRService.SignalR, Microsoft.Storage.StorageAccounts, Microsoft.Web.ServerFarms and Microsoft.Web.Sites. Changing this forces a new Event Grid System Topic to be created.

    NOTE: Some topic_types (e.g. Microsoft.Resources.Subscriptions) requires location to be set to Global instead of a real location like West US.

    NOTE: You can use Azure CLI to get a full list of the available topic types: az eventgrid topic-type list --output json | grep -w id

    Identity SystemTopicIdentityArgs
    An identity block as defined below.
    Location string
    The Azure Region where the Event Grid System Topic should exist. Changing this forces a new Event Grid System Topic to be created.
    Name string
    The name which should be used for this Event Grid System Topic. Changing this forces a new Event Grid System Topic to be created.
    Tags map[string]string
    resourceGroupName String
    The name of the Resource Group where the Event Grid System Topic should exist. Changing this forces a new Event Grid System Topic to be created.
    sourceArmResourceId String
    The ID of the Event Grid System Topic ARM Source. Changing this forces a new Event Grid System Topic to be created.
    topicType String

    The Topic Type of the Event Grid System Topic. The topic type is validated by Azure and there may be additional topic types beyond the following: Microsoft.AppConfiguration.ConfigurationStores, Microsoft.Communication.CommunicationServices, Microsoft.ContainerRegistry.Registries, Microsoft.Devices.IoTHubs, Microsoft.EventGrid.Domains, Microsoft.EventGrid.Topics, Microsoft.Eventhub.Namespaces, Microsoft.KeyVault.vaults, Microsoft.MachineLearningServices.Workspaces, Microsoft.Maps.Accounts, Microsoft.Media.MediaServices, Microsoft.Resources.ResourceGroups, Microsoft.Resources.Subscriptions, Microsoft.ServiceBus.Namespaces, Microsoft.SignalRService.SignalR, Microsoft.Storage.StorageAccounts, Microsoft.Web.ServerFarms and Microsoft.Web.Sites. Changing this forces a new Event Grid System Topic to be created.

    NOTE: Some topic_types (e.g. Microsoft.Resources.Subscriptions) requires location to be set to Global instead of a real location like West US.

    NOTE: You can use Azure CLI to get a full list of the available topic types: az eventgrid topic-type list --output json | grep -w id

    identity SystemTopicIdentity
    An identity block as defined below.
    location String
    The Azure Region where the Event Grid System Topic should exist. Changing this forces a new Event Grid System Topic to be created.
    name String
    The name which should be used for this Event Grid System Topic. Changing this forces a new Event Grid System Topic to be created.
    tags Map<String,String>
    resourceGroupName string
    The name of the Resource Group where the Event Grid System Topic should exist. Changing this forces a new Event Grid System Topic to be created.
    sourceArmResourceId string
    The ID of the Event Grid System Topic ARM Source. Changing this forces a new Event Grid System Topic to be created.
    topicType string

    The Topic Type of the Event Grid System Topic. The topic type is validated by Azure and there may be additional topic types beyond the following: Microsoft.AppConfiguration.ConfigurationStores, Microsoft.Communication.CommunicationServices, Microsoft.ContainerRegistry.Registries, Microsoft.Devices.IoTHubs, Microsoft.EventGrid.Domains, Microsoft.EventGrid.Topics, Microsoft.Eventhub.Namespaces, Microsoft.KeyVault.vaults, Microsoft.MachineLearningServices.Workspaces, Microsoft.Maps.Accounts, Microsoft.Media.MediaServices, Microsoft.Resources.ResourceGroups, Microsoft.Resources.Subscriptions, Microsoft.ServiceBus.Namespaces, Microsoft.SignalRService.SignalR, Microsoft.Storage.StorageAccounts, Microsoft.Web.ServerFarms and Microsoft.Web.Sites. Changing this forces a new Event Grid System Topic to be created.

    NOTE: Some topic_types (e.g. Microsoft.Resources.Subscriptions) requires location to be set to Global instead of a real location like West US.

    NOTE: You can use Azure CLI to get a full list of the available topic types: az eventgrid topic-type list --output json | grep -w id

    identity SystemTopicIdentity
    An identity block as defined below.
    location string
    The Azure Region where the Event Grid System Topic should exist. Changing this forces a new Event Grid System Topic to be created.
    name string
    The name which should be used for this Event Grid System Topic. Changing this forces a new Event Grid System Topic to be created.
    tags {[key: string]: string}
    resource_group_name str
    The name of the Resource Group where the Event Grid System Topic should exist. Changing this forces a new Event Grid System Topic to be created.
    source_arm_resource_id str
    The ID of the Event Grid System Topic ARM Source. Changing this forces a new Event Grid System Topic to be created.
    topic_type str

    The Topic Type of the Event Grid System Topic. The topic type is validated by Azure and there may be additional topic types beyond the following: Microsoft.AppConfiguration.ConfigurationStores, Microsoft.Communication.CommunicationServices, Microsoft.ContainerRegistry.Registries, Microsoft.Devices.IoTHubs, Microsoft.EventGrid.Domains, Microsoft.EventGrid.Topics, Microsoft.Eventhub.Namespaces, Microsoft.KeyVault.vaults, Microsoft.MachineLearningServices.Workspaces, Microsoft.Maps.Accounts, Microsoft.Media.MediaServices, Microsoft.Resources.ResourceGroups, Microsoft.Resources.Subscriptions, Microsoft.ServiceBus.Namespaces, Microsoft.SignalRService.SignalR, Microsoft.Storage.StorageAccounts, Microsoft.Web.ServerFarms and Microsoft.Web.Sites. Changing this forces a new Event Grid System Topic to be created.

    NOTE: Some topic_types (e.g. Microsoft.Resources.Subscriptions) requires location to be set to Global instead of a real location like West US.

    NOTE: You can use Azure CLI to get a full list of the available topic types: az eventgrid topic-type list --output json | grep -w id

    identity SystemTopicIdentityArgs
    An identity block as defined below.
    location str
    The Azure Region where the Event Grid System Topic should exist. Changing this forces a new Event Grid System Topic to be created.
    name str
    The name which should be used for this Event Grid System Topic. Changing this forces a new Event Grid System Topic to be created.
    tags Mapping[str, str]
    resourceGroupName String
    The name of the Resource Group where the Event Grid System Topic should exist. Changing this forces a new Event Grid System Topic to be created.
    sourceArmResourceId String
    The ID of the Event Grid System Topic ARM Source. Changing this forces a new Event Grid System Topic to be created.
    topicType String

    The Topic Type of the Event Grid System Topic. The topic type is validated by Azure and there may be additional topic types beyond the following: Microsoft.AppConfiguration.ConfigurationStores, Microsoft.Communication.CommunicationServices, Microsoft.ContainerRegistry.Registries, Microsoft.Devices.IoTHubs, Microsoft.EventGrid.Domains, Microsoft.EventGrid.Topics, Microsoft.Eventhub.Namespaces, Microsoft.KeyVault.vaults, Microsoft.MachineLearningServices.Workspaces, Microsoft.Maps.Accounts, Microsoft.Media.MediaServices, Microsoft.Resources.ResourceGroups, Microsoft.Resources.Subscriptions, Microsoft.ServiceBus.Namespaces, Microsoft.SignalRService.SignalR, Microsoft.Storage.StorageAccounts, Microsoft.Web.ServerFarms and Microsoft.Web.Sites. Changing this forces a new Event Grid System Topic to be created.

    NOTE: Some topic_types (e.g. Microsoft.Resources.Subscriptions) requires location to be set to Global instead of a real location like West US.

    NOTE: You can use Azure CLI to get a full list of the available topic types: az eventgrid topic-type list --output json | grep -w id

    identity Property Map
    An identity block as defined below.
    location String
    The Azure Region where the Event Grid System Topic should exist. Changing this forces a new Event Grid System Topic to be created.
    name String
    The name which should be used for this Event Grid System Topic. Changing this forces a new Event Grid System Topic to be created.
    tags Map<String>

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    MetricArmResourceId string
    The Metric ARM Resource ID of the Event Grid System Topic.
    Id string
    The provider-assigned unique ID for this managed resource.
    MetricArmResourceId string
    The Metric ARM Resource ID of the Event Grid System Topic.
    id String
    The provider-assigned unique ID for this managed resource.
    metricArmResourceId String
    The Metric ARM Resource ID of the Event Grid System Topic.
    id string
    The provider-assigned unique ID for this managed resource.
    metricArmResourceId string
    The Metric ARM Resource ID of the Event Grid System Topic.
    id str
    The provider-assigned unique ID for this managed resource.
    metric_arm_resource_id str
    The Metric ARM Resource ID of the Event Grid System Topic.
    id String
    The provider-assigned unique ID for this managed resource.
    metricArmResourceId String
    The Metric ARM Resource ID of the Event Grid System Topic.

    Look up Existing SystemTopic Resource

    Get an existing SystemTopic 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?: SystemTopicState, opts?: CustomResourceOptions): SystemTopic
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            identity: Optional[SystemTopicIdentityArgs] = None,
            location: Optional[str] = None,
            metric_arm_resource_id: Optional[str] = None,
            name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            source_arm_resource_id: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            topic_type: Optional[str] = None) -> SystemTopic
    func GetSystemTopic(ctx *Context, name string, id IDInput, state *SystemTopicState, opts ...ResourceOption) (*SystemTopic, error)
    public static SystemTopic Get(string name, Input<string> id, SystemTopicState? state, CustomResourceOptions? opts = null)
    public static SystemTopic get(String name, Output<String> id, SystemTopicState 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:
    Identity SystemTopicIdentity
    An identity block as defined below.
    Location string
    The Azure Region where the Event Grid System Topic should exist. Changing this forces a new Event Grid System Topic to be created.
    MetricArmResourceId string
    The Metric ARM Resource ID of the Event Grid System Topic.
    Name string
    The name which should be used for this Event Grid System Topic. Changing this forces a new Event Grid System Topic to be created.
    ResourceGroupName string
    The name of the Resource Group where the Event Grid System Topic should exist. Changing this forces a new Event Grid System Topic to be created.
    SourceArmResourceId string
    The ID of the Event Grid System Topic ARM Source. Changing this forces a new Event Grid System Topic to be created.
    Tags Dictionary<string, string>
    TopicType string

    The Topic Type of the Event Grid System Topic. The topic type is validated by Azure and there may be additional topic types beyond the following: Microsoft.AppConfiguration.ConfigurationStores, Microsoft.Communication.CommunicationServices, Microsoft.ContainerRegistry.Registries, Microsoft.Devices.IoTHubs, Microsoft.EventGrid.Domains, Microsoft.EventGrid.Topics, Microsoft.Eventhub.Namespaces, Microsoft.KeyVault.vaults, Microsoft.MachineLearningServices.Workspaces, Microsoft.Maps.Accounts, Microsoft.Media.MediaServices, Microsoft.Resources.ResourceGroups, Microsoft.Resources.Subscriptions, Microsoft.ServiceBus.Namespaces, Microsoft.SignalRService.SignalR, Microsoft.Storage.StorageAccounts, Microsoft.Web.ServerFarms and Microsoft.Web.Sites. Changing this forces a new Event Grid System Topic to be created.

    NOTE: Some topic_types (e.g. Microsoft.Resources.Subscriptions) requires location to be set to Global instead of a real location like West US.

    NOTE: You can use Azure CLI to get a full list of the available topic types: az eventgrid topic-type list --output json | grep -w id

    Identity SystemTopicIdentityArgs
    An identity block as defined below.
    Location string
    The Azure Region where the Event Grid System Topic should exist. Changing this forces a new Event Grid System Topic to be created.
    MetricArmResourceId string
    The Metric ARM Resource ID of the Event Grid System Topic.
    Name string
    The name which should be used for this Event Grid System Topic. Changing this forces a new Event Grid System Topic to be created.
    ResourceGroupName string
    The name of the Resource Group where the Event Grid System Topic should exist. Changing this forces a new Event Grid System Topic to be created.
    SourceArmResourceId string
    The ID of the Event Grid System Topic ARM Source. Changing this forces a new Event Grid System Topic to be created.
    Tags map[string]string
    TopicType string

    The Topic Type of the Event Grid System Topic. The topic type is validated by Azure and there may be additional topic types beyond the following: Microsoft.AppConfiguration.ConfigurationStores, Microsoft.Communication.CommunicationServices, Microsoft.ContainerRegistry.Registries, Microsoft.Devices.IoTHubs, Microsoft.EventGrid.Domains, Microsoft.EventGrid.Topics, Microsoft.Eventhub.Namespaces, Microsoft.KeyVault.vaults, Microsoft.MachineLearningServices.Workspaces, Microsoft.Maps.Accounts, Microsoft.Media.MediaServices, Microsoft.Resources.ResourceGroups, Microsoft.Resources.Subscriptions, Microsoft.ServiceBus.Namespaces, Microsoft.SignalRService.SignalR, Microsoft.Storage.StorageAccounts, Microsoft.Web.ServerFarms and Microsoft.Web.Sites. Changing this forces a new Event Grid System Topic to be created.

    NOTE: Some topic_types (e.g. Microsoft.Resources.Subscriptions) requires location to be set to Global instead of a real location like West US.

    NOTE: You can use Azure CLI to get a full list of the available topic types: az eventgrid topic-type list --output json | grep -w id

    identity SystemTopicIdentity
    An identity block as defined below.
    location String
    The Azure Region where the Event Grid System Topic should exist. Changing this forces a new Event Grid System Topic to be created.
    metricArmResourceId String
    The Metric ARM Resource ID of the Event Grid System Topic.
    name String
    The name which should be used for this Event Grid System Topic. Changing this forces a new Event Grid System Topic to be created.
    resourceGroupName String
    The name of the Resource Group where the Event Grid System Topic should exist. Changing this forces a new Event Grid System Topic to be created.
    sourceArmResourceId String
    The ID of the Event Grid System Topic ARM Source. Changing this forces a new Event Grid System Topic to be created.
    tags Map<String,String>
    topicType String

    The Topic Type of the Event Grid System Topic. The topic type is validated by Azure and there may be additional topic types beyond the following: Microsoft.AppConfiguration.ConfigurationStores, Microsoft.Communication.CommunicationServices, Microsoft.ContainerRegistry.Registries, Microsoft.Devices.IoTHubs, Microsoft.EventGrid.Domains, Microsoft.EventGrid.Topics, Microsoft.Eventhub.Namespaces, Microsoft.KeyVault.vaults, Microsoft.MachineLearningServices.Workspaces, Microsoft.Maps.Accounts, Microsoft.Media.MediaServices, Microsoft.Resources.ResourceGroups, Microsoft.Resources.Subscriptions, Microsoft.ServiceBus.Namespaces, Microsoft.SignalRService.SignalR, Microsoft.Storage.StorageAccounts, Microsoft.Web.ServerFarms and Microsoft.Web.Sites. Changing this forces a new Event Grid System Topic to be created.

    NOTE: Some topic_types (e.g. Microsoft.Resources.Subscriptions) requires location to be set to Global instead of a real location like West US.

    NOTE: You can use Azure CLI to get a full list of the available topic types: az eventgrid topic-type list --output json | grep -w id

    identity SystemTopicIdentity
    An identity block as defined below.
    location string
    The Azure Region where the Event Grid System Topic should exist. Changing this forces a new Event Grid System Topic to be created.
    metricArmResourceId string
    The Metric ARM Resource ID of the Event Grid System Topic.
    name string
    The name which should be used for this Event Grid System Topic. Changing this forces a new Event Grid System Topic to be created.
    resourceGroupName string
    The name of the Resource Group where the Event Grid System Topic should exist. Changing this forces a new Event Grid System Topic to be created.
    sourceArmResourceId string
    The ID of the Event Grid System Topic ARM Source. Changing this forces a new Event Grid System Topic to be created.
    tags {[key: string]: string}
    topicType string

    The Topic Type of the Event Grid System Topic. The topic type is validated by Azure and there may be additional topic types beyond the following: Microsoft.AppConfiguration.ConfigurationStores, Microsoft.Communication.CommunicationServices, Microsoft.ContainerRegistry.Registries, Microsoft.Devices.IoTHubs, Microsoft.EventGrid.Domains, Microsoft.EventGrid.Topics, Microsoft.Eventhub.Namespaces, Microsoft.KeyVault.vaults, Microsoft.MachineLearningServices.Workspaces, Microsoft.Maps.Accounts, Microsoft.Media.MediaServices, Microsoft.Resources.ResourceGroups, Microsoft.Resources.Subscriptions, Microsoft.ServiceBus.Namespaces, Microsoft.SignalRService.SignalR, Microsoft.Storage.StorageAccounts, Microsoft.Web.ServerFarms and Microsoft.Web.Sites. Changing this forces a new Event Grid System Topic to be created.

    NOTE: Some topic_types (e.g. Microsoft.Resources.Subscriptions) requires location to be set to Global instead of a real location like West US.

    NOTE: You can use Azure CLI to get a full list of the available topic types: az eventgrid topic-type list --output json | grep -w id

    identity SystemTopicIdentityArgs
    An identity block as defined below.
    location str
    The Azure Region where the Event Grid System Topic should exist. Changing this forces a new Event Grid System Topic to be created.
    metric_arm_resource_id str
    The Metric ARM Resource ID of the Event Grid System Topic.
    name str
    The name which should be used for this Event Grid System Topic. Changing this forces a new Event Grid System Topic to be created.
    resource_group_name str
    The name of the Resource Group where the Event Grid System Topic should exist. Changing this forces a new Event Grid System Topic to be created.
    source_arm_resource_id str
    The ID of the Event Grid System Topic ARM Source. Changing this forces a new Event Grid System Topic to be created.
    tags Mapping[str, str]
    topic_type str

    The Topic Type of the Event Grid System Topic. The topic type is validated by Azure and there may be additional topic types beyond the following: Microsoft.AppConfiguration.ConfigurationStores, Microsoft.Communication.CommunicationServices, Microsoft.ContainerRegistry.Registries, Microsoft.Devices.IoTHubs, Microsoft.EventGrid.Domains, Microsoft.EventGrid.Topics, Microsoft.Eventhub.Namespaces, Microsoft.KeyVault.vaults, Microsoft.MachineLearningServices.Workspaces, Microsoft.Maps.Accounts, Microsoft.Media.MediaServices, Microsoft.Resources.ResourceGroups, Microsoft.Resources.Subscriptions, Microsoft.ServiceBus.Namespaces, Microsoft.SignalRService.SignalR, Microsoft.Storage.StorageAccounts, Microsoft.Web.ServerFarms and Microsoft.Web.Sites. Changing this forces a new Event Grid System Topic to be created.

    NOTE: Some topic_types (e.g. Microsoft.Resources.Subscriptions) requires location to be set to Global instead of a real location like West US.

    NOTE: You can use Azure CLI to get a full list of the available topic types: az eventgrid topic-type list --output json | grep -w id

    identity Property Map
    An identity block as defined below.
    location String
    The Azure Region where the Event Grid System Topic should exist. Changing this forces a new Event Grid System Topic to be created.
    metricArmResourceId String
    The Metric ARM Resource ID of the Event Grid System Topic.
    name String
    The name which should be used for this Event Grid System Topic. Changing this forces a new Event Grid System Topic to be created.
    resourceGroupName String
    The name of the Resource Group where the Event Grid System Topic should exist. Changing this forces a new Event Grid System Topic to be created.
    sourceArmResourceId String
    The ID of the Event Grid System Topic ARM Source. Changing this forces a new Event Grid System Topic to be created.
    tags Map<String>
    topicType String

    The Topic Type of the Event Grid System Topic. The topic type is validated by Azure and there may be additional topic types beyond the following: Microsoft.AppConfiguration.ConfigurationStores, Microsoft.Communication.CommunicationServices, Microsoft.ContainerRegistry.Registries, Microsoft.Devices.IoTHubs, Microsoft.EventGrid.Domains, Microsoft.EventGrid.Topics, Microsoft.Eventhub.Namespaces, Microsoft.KeyVault.vaults, Microsoft.MachineLearningServices.Workspaces, Microsoft.Maps.Accounts, Microsoft.Media.MediaServices, Microsoft.Resources.ResourceGroups, Microsoft.Resources.Subscriptions, Microsoft.ServiceBus.Namespaces, Microsoft.SignalRService.SignalR, Microsoft.Storage.StorageAccounts, Microsoft.Web.ServerFarms and Microsoft.Web.Sites. Changing this forces a new Event Grid System Topic to be created.

    NOTE: Some topic_types (e.g. Microsoft.Resources.Subscriptions) requires location to be set to Global instead of a real location like West US.

    NOTE: You can use Azure CLI to get a full list of the available topic types: az eventgrid topic-type list --output json | grep -w id

    Supporting Types

    SystemTopicIdentity, SystemTopicIdentityArgs

    Type string
    Specifies the type of Managed Service Identity that should be configured on this Event Grid System 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 System 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 System 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 System Topic. Possible values are SystemAssigned, UserAssigned.
    IdentityIds []string

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Event Grid System 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 System 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 System 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 System 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 System 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 System Topic. Possible values are SystemAssigned, UserAssigned.
    identityIds string[]

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Event Grid System 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 System 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 System 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 System 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 System 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 System 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 System 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 System 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.

    Import

    Event Grid System Topic can be imported using the resource id, e.g.

    $ pulumi import azure:eventgrid/systemTopic:SystemTopic example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.EventGrid/systemTopics/systemTopic1
    

    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