Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. eventhub
  5. Domain

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.eventhub.Domain

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure
Deprecated: azure.eventhub.Domain has been deprecated in favor of azure.eventgrid.Domain

Manages an EventGrid Domain

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",
    },
});
Copy
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",
    })
Copy
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.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
		}
		return nil
	})
}
Copy
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" },
        },
    });

});
Copy
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 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());

    }
}
Copy
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
Copy

Create Domain Resource

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

Constructor syntax

new Domain(name: string, args: DomainArgs, opts?: CustomResourceOptions);
@overload
def Domain(resource_name: str,
           args: DomainArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Domain(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           auto_create_topic_with_first_subscription: Optional[bool] = None,
           auto_delete_topic_with_last_subscription: Optional[bool] = None,
           identity: Optional[DomainIdentityArgs] = None,
           inbound_ip_rules: Optional[Sequence[DomainInboundIpRuleArgs]] = None,
           input_mapping_default_values: Optional[DomainInputMappingDefaultValuesArgs] = None,
           input_mapping_fields: Optional[DomainInputMappingFieldsArgs] = 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 NewDomain(ctx *Context, name string, args DomainArgs, opts ...ResourceOption) (*Domain, error)
public Domain(string name, DomainArgs args, CustomResourceOptions? opts = null)
public Domain(String name, DomainArgs args)
public Domain(String name, DomainArgs args, CustomResourceOptions options)

type: azure:eventhub:Domain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DomainArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DomainArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DomainArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DomainArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DomainArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
AutoCreateTopicWithFirstSubscription bool
Whether to create the domain topic when the first event subscription at the scope of the domain topic is created. Defaults to true.
AutoDeleteTopicWithLastSubscription bool
Whether to delete the domain topic when the last event subscription at the scope of the domain topic is deleted. Defaults to true.
Identity DomainIdentity
An identity block as defined below.
InboundIpRules List<DomainInboundIpRule>
One or more inbound_ip_rule blocks as defined below.
InputMappingDefaultValues Changes to this property will trigger replacement. DomainInputMappingDefaultValues
A input_mapping_default_values block as defined below. Changing this forces a new resource to be created.
InputMappingFields Changes to this property will trigger replacement. DomainInputMappingFields
A input_mapping_fields block as defined below. Changing this forces a new resource to be created.
InputSchema Changes to this property will trigger replacement. 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.
LocalAuthEnabled bool
Whether local authentication methods is enabled for the EventGrid Domain. Defaults to true.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.
PublicNetworkAccessEnabled bool
Whether or not public network access is allowed for this server. Defaults to true.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
AutoCreateTopicWithFirstSubscription bool
Whether to create the domain topic when the first event subscription at the scope of the domain topic is created. Defaults to true.
AutoDeleteTopicWithLastSubscription bool
Whether to delete the domain topic when the last event subscription at the scope of the domain topic is deleted. Defaults to true.
Identity DomainIdentityArgs
An identity block as defined below.
InboundIpRules []DomainInboundIpRuleArgs
One or more inbound_ip_rule blocks as defined below.
InputMappingDefaultValues Changes to this property will trigger replacement. DomainInputMappingDefaultValuesArgs
A input_mapping_default_values block as defined below. Changing this forces a new resource to be created.
InputMappingFields Changes to this property will trigger replacement. DomainInputMappingFieldsArgs
A input_mapping_fields block as defined below. Changing this forces a new resource to be created.
InputSchema Changes to this property will trigger replacement. 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.
LocalAuthEnabled bool
Whether local authentication methods is enabled for the EventGrid Domain. Defaults to true.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.
PublicNetworkAccessEnabled bool
Whether or not public network access is allowed for this server. Defaults to true.
Tags map[string]string
A mapping of tags to assign to the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
autoCreateTopicWithFirstSubscription Boolean
Whether to create the domain topic when the first event subscription at the scope of the domain topic is created. Defaults to true.
autoDeleteTopicWithLastSubscription Boolean
Whether to delete the domain topic when the last event subscription at the scope of the domain topic is deleted. Defaults to true.
identity DomainIdentity
An identity block as defined below.
inboundIpRules List<DomainInboundIpRule>
One or more inbound_ip_rule blocks as defined below.
inputMappingDefaultValues Changes to this property will trigger replacement. DomainInputMappingDefaultValues
A input_mapping_default_values block as defined below. Changing this forces a new resource to be created.
inputMappingFields Changes to this property will trigger replacement. DomainInputMappingFields
A input_mapping_fields block as defined below. Changing this forces a new resource to be created.
inputSchema Changes to this property will trigger replacement. 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.
localAuthEnabled Boolean
Whether local authentication methods is enabled for the EventGrid Domain. Defaults to true.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.
publicNetworkAccessEnabled Boolean
Whether or not public network access is allowed for this server. Defaults to true.
tags Map<String,String>
A mapping of tags to assign to the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
autoCreateTopicWithFirstSubscription boolean
Whether to create the domain topic when the first event subscription at the scope of the domain topic is created. Defaults to true.
autoDeleteTopicWithLastSubscription boolean
Whether to delete the domain topic when the last event subscription at the scope of the domain topic is deleted. Defaults to true.
identity DomainIdentity
An identity block as defined below.
inboundIpRules DomainInboundIpRule[]
One or more inbound_ip_rule blocks as defined below.
inputMappingDefaultValues Changes to this property will trigger replacement. DomainInputMappingDefaultValues
A input_mapping_default_values block as defined below. Changing this forces a new resource to be created.
inputMappingFields Changes to this property will trigger replacement. DomainInputMappingFields
A input_mapping_fields block as defined below. Changing this forces a new resource to be created.
inputSchema Changes to this property will trigger replacement. 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.
localAuthEnabled boolean
Whether local authentication methods is enabled for the EventGrid Domain. Defaults to true.
location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.
publicNetworkAccessEnabled boolean
Whether or not public network access is allowed for this server. Defaults to true.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
auto_create_topic_with_first_subscription bool
Whether to create the domain topic when the first event subscription at the scope of the domain topic is created. Defaults to true.
auto_delete_topic_with_last_subscription bool
Whether to delete the domain topic when the last event subscription at the scope of the domain topic is deleted. Defaults to true.
identity DomainIdentityArgs
An identity block as defined below.
inbound_ip_rules Sequence[DomainInboundIpRuleArgs]
One or more inbound_ip_rule blocks as defined below.
input_mapping_default_values Changes to this property will trigger replacement. DomainInputMappingDefaultValuesArgs
A input_mapping_default_values block as defined below. Changing this forces a new resource to be created.
input_mapping_fields Changes to this property will trigger replacement. DomainInputMappingFieldsArgs
A input_mapping_fields block as defined below. Changing this forces a new resource to be created.
input_schema Changes to this property will trigger replacement. 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.
local_auth_enabled bool
Whether local authentication methods is enabled for the EventGrid Domain. Defaults to true.
location Changes to this property will trigger replacement. str
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.
public_network_access_enabled bool
Whether or not public network access is allowed for this server. Defaults to true.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
autoCreateTopicWithFirstSubscription Boolean
Whether to create the domain topic when the first event subscription at the scope of the domain topic is created. Defaults to true.
autoDeleteTopicWithLastSubscription Boolean
Whether to delete the domain topic when the last event subscription at the scope of the domain topic is deleted. Defaults to true.
identity Property Map
An identity block as defined below.
inboundIpRules List<Property Map>
One or more inbound_ip_rule blocks as defined below.
inputMappingDefaultValues Changes to this property will trigger replacement. Property Map
A input_mapping_default_values block as defined below. Changing this forces a new resource to be created.
inputMappingFields Changes to this property will trigger replacement. Property Map
A input_mapping_fields block as defined below. Changing this forces a new resource to be created.
inputSchema Changes to this property will trigger replacement. 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.
localAuthEnabled Boolean
Whether local authentication methods is enabled for the EventGrid Domain. Defaults to true.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.
publicNetworkAccessEnabled Boolean
Whether or not public network access is allowed for this server. Defaults to true.
tags Map<String>
A mapping of tags to assign to the resource.

Outputs

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

Endpoint string
The Endpoint associated with the EventGrid Domain.
Id string
The provider-assigned unique ID for this managed resource.
PrimaryAccessKey string
The Primary Shared Access Key associated with the EventGrid Domain.
SecondaryAccessKey string
The Secondary Shared Access Key associated with the EventGrid Domain.
Endpoint string
The Endpoint associated with the EventGrid Domain.
Id string
The provider-assigned unique ID for this managed resource.
PrimaryAccessKey string
The Primary Shared Access Key associated with the EventGrid Domain.
SecondaryAccessKey string
The Secondary Shared Access Key associated with the EventGrid Domain.
endpoint String
The Endpoint associated with the EventGrid Domain.
id String
The provider-assigned unique ID for this managed resource.
primaryAccessKey String
The Primary Shared Access Key associated with the EventGrid Domain.
secondaryAccessKey String
The Secondary Shared Access Key associated with the EventGrid Domain.
endpoint string
The Endpoint associated with the EventGrid Domain.
id string
The provider-assigned unique ID for this managed resource.
primaryAccessKey string
The Primary Shared Access Key associated with the EventGrid Domain.
secondaryAccessKey string
The Secondary Shared Access Key associated with the EventGrid Domain.
endpoint str
The Endpoint associated with the EventGrid Domain.
id str
The provider-assigned unique ID for this managed resource.
primary_access_key str
The Primary Shared Access Key associated with the EventGrid Domain.
secondary_access_key str
The Secondary Shared Access Key associated with the EventGrid Domain.
endpoint String
The Endpoint associated with the EventGrid Domain.
id String
The provider-assigned unique ID for this managed resource.
primaryAccessKey String
The Primary Shared Access Key associated with the EventGrid Domain.
secondaryAccessKey String
The Secondary Shared Access Key associated with the EventGrid Domain.

Look up Existing Domain Resource

Get an existing Domain 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?: DomainState, opts?: CustomResourceOptions): Domain
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_create_topic_with_first_subscription: Optional[bool] = None,
        auto_delete_topic_with_last_subscription: Optional[bool] = None,
        endpoint: Optional[str] = None,
        identity: Optional[DomainIdentityArgs] = None,
        inbound_ip_rules: Optional[Sequence[DomainInboundIpRuleArgs]] = None,
        input_mapping_default_values: Optional[DomainInputMappingDefaultValuesArgs] = None,
        input_mapping_fields: Optional[DomainInputMappingFieldsArgs] = 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) -> Domain
func GetDomain(ctx *Context, name string, id IDInput, state *DomainState, opts ...ResourceOption) (*Domain, error)
public static Domain Get(string name, Input<string> id, DomainState? state, CustomResourceOptions? opts = null)
public static Domain get(String name, Output<String> id, DomainState state, CustomResourceOptions options)
resources:  _:    type: azure:eventhub:Domain    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AutoCreateTopicWithFirstSubscription bool
Whether to create the domain topic when the first event subscription at the scope of the domain topic is created. Defaults to true.
AutoDeleteTopicWithLastSubscription bool
Whether to delete the domain topic when the last event subscription at the scope of the domain topic is deleted. Defaults to true.
Endpoint string
The Endpoint associated with the EventGrid Domain.
Identity DomainIdentity
An identity block as defined below.
InboundIpRules List<DomainInboundIpRule>
One or more inbound_ip_rule blocks as defined below.
InputMappingDefaultValues Changes to this property will trigger replacement. DomainInputMappingDefaultValues
A input_mapping_default_values block as defined below. Changing this forces a new resource to be created.
InputMappingFields Changes to this property will trigger replacement. DomainInputMappingFields
A input_mapping_fields block as defined below. Changing this forces a new resource to be created.
InputSchema Changes to this property will trigger replacement. 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.
LocalAuthEnabled bool
Whether local authentication methods is enabled for the EventGrid Domain. Defaults to true.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.
PrimaryAccessKey string
The Primary Shared Access Key associated with the EventGrid Domain.
PublicNetworkAccessEnabled bool
Whether or not public network access is allowed for this server. Defaults to true.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
SecondaryAccessKey string
The Secondary Shared Access Key associated with the EventGrid Domain.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
AutoCreateTopicWithFirstSubscription bool
Whether to create the domain topic when the first event subscription at the scope of the domain topic is created. Defaults to true.
AutoDeleteTopicWithLastSubscription bool
Whether to delete the domain topic when the last event subscription at the scope of the domain topic is deleted. Defaults to true.
Endpoint string
The Endpoint associated with the EventGrid Domain.
Identity DomainIdentityArgs
An identity block as defined below.
InboundIpRules []DomainInboundIpRuleArgs
One or more inbound_ip_rule blocks as defined below.
InputMappingDefaultValues Changes to this property will trigger replacement. DomainInputMappingDefaultValuesArgs
A input_mapping_default_values block as defined below. Changing this forces a new resource to be created.
InputMappingFields Changes to this property will trigger replacement. DomainInputMappingFieldsArgs
A input_mapping_fields block as defined below. Changing this forces a new resource to be created.
InputSchema Changes to this property will trigger replacement. 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.
LocalAuthEnabled bool
Whether local authentication methods is enabled for the EventGrid Domain. Defaults to true.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.
PrimaryAccessKey string
The Primary Shared Access Key associated with the EventGrid Domain.
PublicNetworkAccessEnabled bool
Whether or not public network access is allowed for this server. Defaults to true.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
SecondaryAccessKey string
The Secondary Shared Access Key associated with the EventGrid Domain.
Tags map[string]string
A mapping of tags to assign to the resource.
autoCreateTopicWithFirstSubscription Boolean
Whether to create the domain topic when the first event subscription at the scope of the domain topic is created. Defaults to true.
autoDeleteTopicWithLastSubscription Boolean
Whether to delete the domain topic when the last event subscription at the scope of the domain topic is deleted. Defaults to true.
endpoint String
The Endpoint associated with the EventGrid Domain.
identity DomainIdentity
An identity block as defined below.
inboundIpRules List<DomainInboundIpRule>
One or more inbound_ip_rule blocks as defined below.
inputMappingDefaultValues Changes to this property will trigger replacement. DomainInputMappingDefaultValues
A input_mapping_default_values block as defined below. Changing this forces a new resource to be created.
inputMappingFields Changes to this property will trigger replacement. DomainInputMappingFields
A input_mapping_fields block as defined below. Changing this forces a new resource to be created.
inputSchema Changes to this property will trigger replacement. 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.
localAuthEnabled Boolean
Whether local authentication methods is enabled for the EventGrid Domain. Defaults to true.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.
primaryAccessKey String
The Primary Shared Access Key associated with the EventGrid Domain.
publicNetworkAccessEnabled Boolean
Whether or not public network access is allowed for this server. Defaults to true.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
secondaryAccessKey String
The Secondary Shared Access Key associated with the EventGrid Domain.
tags Map<String,String>
A mapping of tags to assign to the resource.
autoCreateTopicWithFirstSubscription boolean
Whether to create the domain topic when the first event subscription at the scope of the domain topic is created. Defaults to true.
autoDeleteTopicWithLastSubscription boolean
Whether to delete the domain topic when the last event subscription at the scope of the domain topic is deleted. Defaults to true.
endpoint string
The Endpoint associated with the EventGrid Domain.
identity DomainIdentity
An identity block as defined below.
inboundIpRules DomainInboundIpRule[]
One or more inbound_ip_rule blocks as defined below.
inputMappingDefaultValues Changes to this property will trigger replacement. DomainInputMappingDefaultValues
A input_mapping_default_values block as defined below. Changing this forces a new resource to be created.
inputMappingFields Changes to this property will trigger replacement. DomainInputMappingFields
A input_mapping_fields block as defined below. Changing this forces a new resource to be created.
inputSchema Changes to this property will trigger replacement. 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.
localAuthEnabled boolean
Whether local authentication methods is enabled for the EventGrid Domain. Defaults to true.
location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.
primaryAccessKey string
The Primary Shared Access Key associated with the EventGrid Domain.
publicNetworkAccessEnabled boolean
Whether or not public network access is allowed for this server. Defaults to true.
resourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
secondaryAccessKey string
The Secondary Shared Access Key associated with the EventGrid Domain.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
auto_create_topic_with_first_subscription bool
Whether to create the domain topic when the first event subscription at the scope of the domain topic is created. Defaults to true.
auto_delete_topic_with_last_subscription bool
Whether to delete the domain topic when the last event subscription at the scope of the domain topic is deleted. Defaults to true.
endpoint str
The Endpoint associated with the EventGrid Domain.
identity DomainIdentityArgs
An identity block as defined below.
inbound_ip_rules Sequence[DomainInboundIpRuleArgs]
One or more inbound_ip_rule blocks as defined below.
input_mapping_default_values Changes to this property will trigger replacement. DomainInputMappingDefaultValuesArgs
A input_mapping_default_values block as defined below. Changing this forces a new resource to be created.
input_mapping_fields Changes to this property will trigger replacement. DomainInputMappingFieldsArgs
A input_mapping_fields block as defined below. Changing this forces a new resource to be created.
input_schema Changes to this property will trigger replacement. 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.
local_auth_enabled bool
Whether local authentication methods is enabled for the EventGrid Domain. Defaults to true.
location Changes to this property will trigger replacement. str
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.
primary_access_key str
The Primary Shared Access Key associated with the EventGrid Domain.
public_network_access_enabled bool
Whether or not public network access is allowed for this server. Defaults to true.
resource_group_name Changes to this property will trigger replacement. str
The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
secondary_access_key str
The Secondary Shared Access Key associated with the EventGrid Domain.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
autoCreateTopicWithFirstSubscription Boolean
Whether to create the domain topic when the first event subscription at the scope of the domain topic is created. Defaults to true.
autoDeleteTopicWithLastSubscription Boolean
Whether to delete the domain topic when the last event subscription at the scope of the domain topic is deleted. Defaults to true.
endpoint String
The Endpoint associated with the EventGrid Domain.
identity Property Map
An identity block as defined below.
inboundIpRules List<Property Map>
One or more inbound_ip_rule blocks as defined below.
inputMappingDefaultValues Changes to this property will trigger replacement. Property Map
A input_mapping_default_values block as defined below. Changing this forces a new resource to be created.
inputMappingFields Changes to this property will trigger replacement. Property Map
A input_mapping_fields block as defined below. Changing this forces a new resource to be created.
inputSchema Changes to this property will trigger replacement. 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.
localAuthEnabled Boolean
Whether local authentication methods is enabled for the EventGrid Domain. Defaults to true.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.
primaryAccessKey String
The Primary Shared Access Key associated with the EventGrid Domain.
publicNetworkAccessEnabled Boolean
Whether or not public network access is allowed for this server. Defaults to true.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
secondaryAccessKey String
The Secondary Shared Access Key associated with the EventGrid Domain.
tags Map<String>
A mapping of tags to assign to the resource.

Supporting Types

DomainIdentity
, DomainIdentityArgs

Type This property is required. string
Specifies the type of Managed Service Identity that should be configured on this Event Grid Domain. Possible values are SystemAssigned, UserAssigned.
IdentityIds List<string>

Specifies a list of User Assigned Managed Identity IDs to be assigned to this Event Grid Domain.

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

Specifies a list of User Assigned Managed Identity IDs to be assigned to this Event Grid Domain.

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 Domain 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 This property is required. String
Specifies the type of Managed Service Identity that should be configured on this Event Grid Domain. Possible values are SystemAssigned, UserAssigned.
identityIds List<String>

Specifies a list of User Assigned Managed Identity IDs to be assigned to this Event Grid Domain.

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 Domain 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 This property is required. string
Specifies the type of Managed Service Identity that should be configured on this Event Grid Domain. Possible values are SystemAssigned, UserAssigned.
identityIds string[]

Specifies a list of User Assigned Managed Identity IDs to be assigned to this Event Grid Domain.

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 Domain 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 This property is required. str
Specifies the type of Managed Service Identity that should be configured on this Event Grid Domain. 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 Domain.

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 Domain 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 This property is required. String
Specifies the type of Managed Service Identity that should be configured on this Event Grid Domain. Possible values are SystemAssigned, UserAssigned.
identityIds List<String>

Specifies a list of User Assigned Managed Identity IDs to be assigned to this Event Grid Domain.

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

DomainInboundIpRule
, DomainInboundIpRuleArgs

IpMask This property is required. string
The IP mask (CIDR) to match on.
Action string
The action to take when the rule is matched. Possible values are Allow. Defaults to Allow.
IpMask This property is required. string
The IP mask (CIDR) to match on.
Action string
The action to take when the rule is matched. Possible values are Allow. Defaults to Allow.
ipMask This property is required. String
The IP mask (CIDR) to match on.
action String
The action to take when the rule is matched. Possible values are Allow. Defaults to Allow.
ipMask This property is required. string
The IP mask (CIDR) to match on.
action string
The action to take when the rule is matched. Possible values are Allow. Defaults to Allow.
ip_mask This property is required. str
The IP mask (CIDR) to match on.
action str
The action to take when the rule is matched. Possible values are Allow. Defaults to Allow.
ipMask This property is required. String
The IP mask (CIDR) to match on.
action String
The action to take when the rule is matched. Possible values are Allow. Defaults to Allow.

DomainInputMappingDefaultValues
, DomainInputMappingDefaultValuesArgs

DataVersion Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string
Specifies the default subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
DataVersion Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string
Specifies the default subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
dataVersion Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. String
Specifies the default subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
dataVersion Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. str
Specifies the default subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
dataVersion Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. String
Specifies the default subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

DomainInputMappingFields
, DomainInputMappingFieldsArgs

DataVersion Changes to this property will trigger replacement. string
Specifies the data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
EventTime Changes to this property will trigger replacement. string
Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
EventType Changes to this property will trigger replacement. string
Specifies the event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
Id Changes to this property will trigger replacement. string
Specifies the id of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
Subject Changes to this property will trigger replacement. string
Specifies the subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
Topic Changes to this property will trigger replacement. string
Specifies the topic of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
DataVersion Changes to this property will trigger replacement. string
Specifies the data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
EventTime Changes to this property will trigger replacement. string
Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
EventType Changes to this property will trigger replacement. string
Specifies the event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
Id Changes to this property will trigger replacement. string
Specifies the id of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
Subject Changes to this property will trigger replacement. string
Specifies the subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
Topic Changes to this property will trigger replacement. string
Specifies the topic of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
dataVersion Changes to this property will trigger replacement. String
Specifies the data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
eventTime Changes to this property will trigger replacement. String
Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
eventType Changes to this property will trigger replacement. String
Specifies the event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
id Changes to this property will trigger replacement. String
Specifies the id of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
subject Changes to this property will trigger replacement. String
Specifies the subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
topic Changes to this property will trigger replacement. String
Specifies the topic of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
dataVersion Changes to this property will trigger replacement. string
Specifies the data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
eventTime Changes to this property will trigger replacement. string
Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
eventType Changes to this property will trigger replacement. string
Specifies the event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
id Changes to this property will trigger replacement. string
Specifies the id of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
subject Changes to this property will trigger replacement. string
Specifies the subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
topic Changes to this property will trigger replacement. string
Specifies the topic of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
data_version Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. str
Specifies the event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
id Changes to this property will trigger replacement. str
Specifies the id of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
subject Changes to this property will trigger replacement. str
Specifies the subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
topic Changes to this property will trigger replacement. str
Specifies the topic of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
dataVersion Changes to this property will trigger replacement. String
Specifies the data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
eventTime Changes to this property will trigger replacement. String
Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
eventType Changes to this property will trigger replacement. String
Specifies the event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
id Changes to this property will trigger replacement. String
Specifies the id of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
subject Changes to this property will trigger replacement. String
Specifies the subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
topic Changes to this property will trigger replacement. String
Specifies the topic of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

Import

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

$ pulumi import azure:eventhub/domain:Domain domain1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.EventGrid/domains/domain1
Copy

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.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure