We recommend using Azure Native.
azure.eventhub.Domain
Explore with Pulumi AI
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",
    },
});
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",
    })
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
	})
}
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" },
        },
    });
});
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());
    }
}
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
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 string
- The unique name of the resource.
- args DomainArgs
- 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 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 string
- The unique name of the resource.
- args DomainArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DomainArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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:
- ResourceGroup stringName 
- The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
- AutoCreate boolTopic With First Subscription 
- Whether to create the domain topic when the first event subscription at the scope of the domain topic is created. Defaults to true.
- AutoDelete boolTopic With Last Subscription 
- 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 identityblock as defined below.
- InboundIp List<DomainRules Inbound Ip Rule> 
- One or more inbound_ip_ruleblocks as defined below.
- InputMapping DomainDefault Values Input Mapping Default Values 
- A input_mapping_default_valuesblock as defined below. Changing this forces a new resource to be created.
- InputMapping DomainFields Input Mapping Fields 
- A input_mapping_fieldsblock as defined below. Changing this forces a new resource to be created.
- InputSchema string
- Specifies the schema in which incoming events will be published to this domain. Allowed values are CloudEventSchemaV1_0,CustomEventSchema, orEventGridSchema. Defaults toEventGridSchema. Changing this forces a new resource to be created.
- LocalAuth boolEnabled 
- Whether local authentication methods is enabled for the EventGrid Domain. Defaults to true.
- Location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- Name string
- Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.
- PublicNetwork boolAccess Enabled 
- Whether or not public network access is allowed for this server. Defaults to true.
- Dictionary<string, string>
- A mapping of tags to assign to the resource.
- ResourceGroup stringName 
- The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
- AutoCreate boolTopic With First Subscription 
- Whether to create the domain topic when the first event subscription at the scope of the domain topic is created. Defaults to true.
- AutoDelete boolTopic With Last Subscription 
- 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 Args 
- An identityblock as defined below.
- InboundIp []DomainRules Inbound Ip Rule Args 
- One or more inbound_ip_ruleblocks as defined below.
- InputMapping DomainDefault Values Input Mapping Default Values Args 
- A input_mapping_default_valuesblock as defined below. Changing this forces a new resource to be created.
- InputMapping DomainFields Input Mapping Fields Args 
- A input_mapping_fieldsblock as defined below. Changing this forces a new resource to be created.
- InputSchema string
- Specifies the schema in which incoming events will be published to this domain. Allowed values are CloudEventSchemaV1_0,CustomEventSchema, orEventGridSchema. Defaults toEventGridSchema. Changing this forces a new resource to be created.
- LocalAuth boolEnabled 
- Whether local authentication methods is enabled for the EventGrid Domain. Defaults to true.
- Location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- Name string
- Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.
- PublicNetwork boolAccess Enabled 
- Whether or not public network access is allowed for this server. Defaults to true.
- map[string]string
- A mapping of tags to assign to the resource.
- resourceGroup StringName 
- The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
- autoCreate BooleanTopic With First Subscription 
- Whether to create the domain topic when the first event subscription at the scope of the domain topic is created. Defaults to true.
- autoDelete BooleanTopic With Last Subscription 
- 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 identityblock as defined below.
- inboundIp List<DomainRules Inbound Ip Rule> 
- One or more inbound_ip_ruleblocks as defined below.
- inputMapping DomainDefault Values Input Mapping Default Values 
- A input_mapping_default_valuesblock as defined below. Changing this forces a new resource to be created.
- inputMapping DomainFields Input Mapping Fields 
- A input_mapping_fieldsblock as defined below. Changing this forces a new resource to be created.
- inputSchema String
- Specifies the schema in which incoming events will be published to this domain. Allowed values are CloudEventSchemaV1_0,CustomEventSchema, orEventGridSchema. Defaults toEventGridSchema. Changing this forces a new resource to be created.
- localAuth BooleanEnabled 
- Whether local authentication methods is enabled for the EventGrid Domain. Defaults to true.
- location String
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name String
- Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.
- publicNetwork BooleanAccess Enabled 
- Whether or not public network access is allowed for this server. Defaults to true.
- Map<String,String>
- A mapping of tags to assign to the resource.
- resourceGroup stringName 
- The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
- autoCreate booleanTopic With First Subscription 
- Whether to create the domain topic when the first event subscription at the scope of the domain topic is created. Defaults to true.
- autoDelete booleanTopic With Last Subscription 
- 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 identityblock as defined below.
- inboundIp DomainRules Inbound Ip Rule[] 
- One or more inbound_ip_ruleblocks as defined below.
- inputMapping DomainDefault Values Input Mapping Default Values 
- A input_mapping_default_valuesblock as defined below. Changing this forces a new resource to be created.
- inputMapping DomainFields Input Mapping Fields 
- A input_mapping_fieldsblock as defined below. Changing this forces a new resource to be created.
- inputSchema string
- Specifies the schema in which incoming events will be published to this domain. Allowed values are CloudEventSchemaV1_0,CustomEventSchema, orEventGridSchema. Defaults toEventGridSchema. Changing this forces a new resource to be created.
- localAuth booleanEnabled 
- Whether local authentication methods is enabled for the EventGrid Domain. Defaults to true.
- location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name string
- Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.
- publicNetwork booleanAccess Enabled 
- Whether or not public network access is allowed for this server. Defaults to true.
- {[key: string]: string}
- A mapping of tags to assign to the resource.
- resource_group_ strname 
- The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
- auto_create_ booltopic_ with_ first_ subscription 
- 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_ booltopic_ with_ last_ subscription 
- 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 Args 
- An identityblock as defined below.
- inbound_ip_ Sequence[Domainrules Inbound Ip Rule Args] 
- One or more inbound_ip_ruleblocks as defined below.
- input_mapping_ Domaindefault_ values Input Mapping Default Values Args 
- A input_mapping_default_valuesblock as defined below. Changing this forces a new resource to be created.
- input_mapping_ Domainfields Input Mapping Fields Args 
- A input_mapping_fieldsblock as defined below. Changing this forces a new resource to be created.
- input_schema str
- Specifies the schema in which incoming events will be published to this domain. Allowed values are CloudEventSchemaV1_0,CustomEventSchema, orEventGridSchema. Defaults toEventGridSchema. Changing this forces a new resource to be created.
- local_auth_ boolenabled 
- Whether local authentication methods is enabled for the EventGrid Domain. Defaults to true.
- location str
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name str
- Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.
- public_network_ boolaccess_ enabled 
- Whether or not public network access is allowed for this server. Defaults to true.
- Mapping[str, str]
- A mapping of tags to assign to the resource.
- resourceGroup StringName 
- The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
- autoCreate BooleanTopic With First Subscription 
- Whether to create the domain topic when the first event subscription at the scope of the domain topic is created. Defaults to true.
- autoDelete BooleanTopic With Last Subscription 
- 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 identityblock as defined below.
- inboundIp List<Property Map>Rules 
- One or more inbound_ip_ruleblocks as defined below.
- inputMapping Property MapDefault Values 
- A input_mapping_default_valuesblock as defined below. Changing this forces a new resource to be created.
- inputMapping Property MapFields 
- A input_mapping_fieldsblock as defined below. Changing this forces a new resource to be created.
- inputSchema String
- Specifies the schema in which incoming events will be published to this domain. Allowed values are CloudEventSchemaV1_0,CustomEventSchema, orEventGridSchema. Defaults toEventGridSchema. Changing this forces a new resource to be created.
- localAuth BooleanEnabled 
- Whether local authentication methods is enabled for the EventGrid Domain. Defaults to true.
- location String
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name String
- Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.
- publicNetwork BooleanAccess Enabled 
- Whether or not public network access is allowed for this server. Defaults to true.
- 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.
- PrimaryAccess stringKey 
- The Primary Shared Access Key associated with the EventGrid Domain.
- SecondaryAccess stringKey 
- 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.
- PrimaryAccess stringKey 
- The Primary Shared Access Key associated with the EventGrid Domain.
- SecondaryAccess stringKey 
- 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.
- primaryAccess StringKey 
- The Primary Shared Access Key associated with the EventGrid Domain.
- secondaryAccess StringKey 
- 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.
- primaryAccess stringKey 
- The Primary Shared Access Key associated with the EventGrid Domain.
- secondaryAccess stringKey 
- 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_ strkey 
- The Primary Shared Access Key associated with the EventGrid Domain.
- secondary_access_ strkey 
- 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.
- primaryAccess StringKey 
- The Primary Shared Access Key associated with the EventGrid Domain.
- secondaryAccess StringKey 
- 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) -> Domainfunc 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
- 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.
- AutoCreate boolTopic With First Subscription 
- Whether to create the domain topic when the first event subscription at the scope of the domain topic is created. Defaults to true.
- AutoDelete boolTopic With Last Subscription 
- 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 identityblock as defined below.
- InboundIp List<DomainRules Inbound Ip Rule> 
- One or more inbound_ip_ruleblocks as defined below.
- InputMapping DomainDefault Values Input Mapping Default Values 
- A input_mapping_default_valuesblock as defined below. Changing this forces a new resource to be created.
- InputMapping DomainFields Input Mapping Fields 
- A input_mapping_fieldsblock as defined below. Changing this forces a new resource to be created.
- InputSchema string
- Specifies the schema in which incoming events will be published to this domain. Allowed values are CloudEventSchemaV1_0,CustomEventSchema, orEventGridSchema. Defaults toEventGridSchema. Changing this forces a new resource to be created.
- LocalAuth boolEnabled 
- Whether local authentication methods is enabled for the EventGrid Domain. Defaults to true.
- Location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- Name string
- Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.
- PrimaryAccess stringKey 
- The Primary Shared Access Key associated with the EventGrid Domain.
- PublicNetwork boolAccess Enabled 
- Whether or not public network access is allowed for this server. Defaults to true.
- ResourceGroup stringName 
- The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
- SecondaryAccess stringKey 
- The Secondary Shared Access Key associated with the EventGrid Domain.
- Dictionary<string, string>
- A mapping of tags to assign to the resource.
- AutoCreate boolTopic With First Subscription 
- Whether to create the domain topic when the first event subscription at the scope of the domain topic is created. Defaults to true.
- AutoDelete boolTopic With Last Subscription 
- 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 Args 
- An identityblock as defined below.
- InboundIp []DomainRules Inbound Ip Rule Args 
- One or more inbound_ip_ruleblocks as defined below.
- InputMapping DomainDefault Values Input Mapping Default Values Args 
- A input_mapping_default_valuesblock as defined below. Changing this forces a new resource to be created.
- InputMapping DomainFields Input Mapping Fields Args 
- A input_mapping_fieldsblock as defined below. Changing this forces a new resource to be created.
- InputSchema string
- Specifies the schema in which incoming events will be published to this domain. Allowed values are CloudEventSchemaV1_0,CustomEventSchema, orEventGridSchema. Defaults toEventGridSchema. Changing this forces a new resource to be created.
- LocalAuth boolEnabled 
- Whether local authentication methods is enabled for the EventGrid Domain. Defaults to true.
- Location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- Name string
- Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.
- PrimaryAccess stringKey 
- The Primary Shared Access Key associated with the EventGrid Domain.
- PublicNetwork boolAccess Enabled 
- Whether or not public network access is allowed for this server. Defaults to true.
- ResourceGroup stringName 
- The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
- SecondaryAccess stringKey 
- The Secondary Shared Access Key associated with the EventGrid Domain.
- map[string]string
- A mapping of tags to assign to the resource.
- autoCreate BooleanTopic With First Subscription 
- Whether to create the domain topic when the first event subscription at the scope of the domain topic is created. Defaults to true.
- autoDelete BooleanTopic With Last Subscription 
- 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 identityblock as defined below.
- inboundIp List<DomainRules Inbound Ip Rule> 
- One or more inbound_ip_ruleblocks as defined below.
- inputMapping DomainDefault Values Input Mapping Default Values 
- A input_mapping_default_valuesblock as defined below. Changing this forces a new resource to be created.
- inputMapping DomainFields Input Mapping Fields 
- A input_mapping_fieldsblock as defined below. Changing this forces a new resource to be created.
- inputSchema String
- Specifies the schema in which incoming events will be published to this domain. Allowed values are CloudEventSchemaV1_0,CustomEventSchema, orEventGridSchema. Defaults toEventGridSchema. Changing this forces a new resource to be created.
- localAuth BooleanEnabled 
- Whether local authentication methods is enabled for the EventGrid Domain. Defaults to true.
- location String
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name String
- Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.
- primaryAccess StringKey 
- The Primary Shared Access Key associated with the EventGrid Domain.
- publicNetwork BooleanAccess Enabled 
- Whether or not public network access is allowed for this server. Defaults to true.
- resourceGroup StringName 
- The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
- secondaryAccess StringKey 
- The Secondary Shared Access Key associated with the EventGrid Domain.
- Map<String,String>
- A mapping of tags to assign to the resource.
- autoCreate booleanTopic With First Subscription 
- Whether to create the domain topic when the first event subscription at the scope of the domain topic is created. Defaults to true.
- autoDelete booleanTopic With Last Subscription 
- 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 identityblock as defined below.
- inboundIp DomainRules Inbound Ip Rule[] 
- One or more inbound_ip_ruleblocks as defined below.
- inputMapping DomainDefault Values Input Mapping Default Values 
- A input_mapping_default_valuesblock as defined below. Changing this forces a new resource to be created.
- inputMapping DomainFields Input Mapping Fields 
- A input_mapping_fieldsblock as defined below. Changing this forces a new resource to be created.
- inputSchema string
- Specifies the schema in which incoming events will be published to this domain. Allowed values are CloudEventSchemaV1_0,CustomEventSchema, orEventGridSchema. Defaults toEventGridSchema. Changing this forces a new resource to be created.
- localAuth booleanEnabled 
- Whether local authentication methods is enabled for the EventGrid Domain. Defaults to true.
- location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name string
- Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.
- primaryAccess stringKey 
- The Primary Shared Access Key associated with the EventGrid Domain.
- publicNetwork booleanAccess Enabled 
- Whether or not public network access is allowed for this server. Defaults to true.
- resourceGroup stringName 
- The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
- secondaryAccess stringKey 
- The Secondary Shared Access Key associated with the EventGrid Domain.
- {[key: string]: string}
- A mapping of tags to assign to the resource.
- auto_create_ booltopic_ with_ first_ subscription 
- 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_ booltopic_ with_ last_ subscription 
- 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
DomainIdentity Args 
- An identityblock as defined below.
- inbound_ip_ Sequence[Domainrules Inbound Ip Rule Args] 
- One or more inbound_ip_ruleblocks as defined below.
- input_mapping_ Domaindefault_ values Input Mapping Default Values Args 
- A input_mapping_default_valuesblock as defined below. Changing this forces a new resource to be created.
- input_mapping_ Domainfields Input Mapping Fields Args 
- A input_mapping_fieldsblock as defined below. Changing this forces a new resource to be created.
- input_schema str
- Specifies the schema in which incoming events will be published to this domain. Allowed values are CloudEventSchemaV1_0,CustomEventSchema, orEventGridSchema. Defaults toEventGridSchema. Changing this forces a new resource to be created.
- local_auth_ boolenabled 
- Whether local authentication methods is enabled for the EventGrid Domain. Defaults to true.
- location str
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name str
- Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.
- primary_access_ strkey 
- The Primary Shared Access Key associated with the EventGrid Domain.
- public_network_ boolaccess_ enabled 
- Whether or not public network access is allowed for this server. Defaults to true.
- resource_group_ strname 
- The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
- secondary_access_ strkey 
- The Secondary Shared Access Key associated with the EventGrid Domain.
- Mapping[str, str]
- A mapping of tags to assign to the resource.
- autoCreate BooleanTopic With First Subscription 
- Whether to create the domain topic when the first event subscription at the scope of the domain topic is created. Defaults to true.
- autoDelete BooleanTopic With Last Subscription 
- 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 identityblock as defined below.
- inboundIp List<Property Map>Rules 
- One or more inbound_ip_ruleblocks as defined below.
- inputMapping Property MapDefault Values 
- A input_mapping_default_valuesblock as defined below. Changing this forces a new resource to be created.
- inputMapping Property MapFields 
- A input_mapping_fieldsblock as defined below. Changing this forces a new resource to be created.
- inputSchema String
- Specifies the schema in which incoming events will be published to this domain. Allowed values are CloudEventSchemaV1_0,CustomEventSchema, orEventGridSchema. Defaults toEventGridSchema. Changing this forces a new resource to be created.
- localAuth BooleanEnabled 
- Whether local authentication methods is enabled for the EventGrid Domain. Defaults to true.
- location String
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name String
- Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.
- primaryAccess StringKey 
- The Primary Shared Access Key associated with the EventGrid Domain.
- publicNetwork BooleanAccess Enabled 
- Whether or not public network access is allowed for this server. Defaults to true.
- resourceGroup StringName 
- The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.
- secondaryAccess StringKey 
- The Secondary Shared Access Key associated with the EventGrid Domain.
- Map<String>
- A mapping of tags to assign to the resource.
Supporting Types
DomainIdentity, DomainIdentityArgs    
- Type 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 - typeis set to- UserAssigned- NOTE: When - typeis set to- SystemAssigned, The assigned- principal_idand- tenant_idcan 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 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 - typeis set to- UserAssigned- NOTE: When - typeis set to- SystemAssigned, The assigned- principal_idand- tenant_idcan 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 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 - typeis set to- UserAssigned- NOTE: When - typeis set to- SystemAssigned, The assigned- principal_idand- tenant_idcan 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 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 - typeis set to- UserAssigned- NOTE: When - typeis set to- SystemAssigned, The assigned- principal_idand- tenant_idcan 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 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 - typeis set to- UserAssigned- NOTE: When - typeis set to- SystemAssigned, The assigned- principal_idand- tenant_idcan 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 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 - typeis set to- UserAssigned- NOTE: When - typeis set to- SystemAssigned, The assigned- principal_idand- tenant_idcan 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        
DomainInputMappingDefaultValues, DomainInputMappingDefaultValuesArgs          
- DataVersion string
- Specifies the default data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- EventType string
- Specifies the default event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- Subject string
- Specifies the default subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- DataVersion string
- Specifies the default data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- EventType string
- Specifies the default event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- Subject string
- Specifies the default subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- dataVersion String
- Specifies the default data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- eventType String
- Specifies the default event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- subject String
- Specifies the default subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- dataVersion string
- Specifies the default data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- eventType string
- Specifies the default event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- subject string
- Specifies the default subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- data_version 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 str
- Specifies the default event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- subject str
- Specifies the default subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- dataVersion String
- Specifies the default data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- eventType String
- Specifies the default event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- subject String
- Specifies the default subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
DomainInputMappingFields, DomainInputMappingFieldsArgs        
- DataVersion string
- Specifies the data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- EventTime string
- Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- EventType string
- Specifies the event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- Id string
- Specifies the id of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- Subject string
- Specifies the subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- Topic string
- Specifies the topic of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- DataVersion string
- Specifies the data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- EventTime string
- Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- EventType string
- Specifies the event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- Id string
- Specifies the id of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- Subject string
- Specifies the subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- Topic string
- Specifies the topic of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- dataVersion String
- Specifies the data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- eventTime String
- Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- eventType String
- Specifies the event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- id String
- Specifies the id of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- subject String
- Specifies the subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- topic String
- Specifies the topic of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- dataVersion string
- Specifies the data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- eventTime string
- Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- eventType string
- Specifies the event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- id string
- Specifies the id of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- subject string
- Specifies the subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- topic string
- Specifies the topic of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- data_version 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 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 str
- Specifies the event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- id str
- Specifies the id of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- subject str
- Specifies the subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- topic str
- Specifies the topic of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- dataVersion String
- Specifies the data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- eventTime String
- Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- eventType String
- Specifies the event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- id String
- Specifies the id of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- subject String
- Specifies the subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
- topic String
- Specifies the topic of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.
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
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 azurermTerraform Provider.