EventGrid Domain.
Uses Azure REST API version 2025-02-15. In version 2.x of the Azure Native provider, it used API version 2022-06-15.
Other available API versions: 2022-06-15, 2023-06-01-preview, 2023-12-15-preview, 2024-06-01-preview, 2024-12-15-preview, 2025-04-01-preview, 2025-07-15-preview, 2025-11-15-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native eventgrid [ApiVersion]. See the version guide for details.
Example Usage
Domains_CreateOrUpdate
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var domain = new AzureNative.EventGrid.Domain("domain", new()
{
DomainName = "exampledomain1",
InboundIpRules = new[]
{
new AzureNative.EventGrid.Inputs.InboundIpRuleArgs
{
Action = AzureNative.EventGrid.IpActionType.Allow,
IpMask = "12.18.30.15",
},
new AzureNative.EventGrid.Inputs.InboundIpRuleArgs
{
Action = AzureNative.EventGrid.IpActionType.Allow,
IpMask = "12.18.176.1",
},
},
Location = "westus2",
PublicNetworkAccess = AzureNative.EventGrid.PublicNetworkAccess.Enabled,
ResourceGroupName = "examplerg",
Tags =
{
{ "tag1", "value1" },
{ "tag2", "value2" },
},
});
});
package main
import (
eventgrid "github.com/pulumi/pulumi-azure-native-sdk/eventgrid/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := eventgrid.NewDomain(ctx, "domain", &eventgrid.DomainArgs{
DomainName: pulumi.String("exampledomain1"),
InboundIpRules: eventgrid.InboundIpRuleArray{
&eventgrid.InboundIpRuleArgs{
Action: pulumi.String(eventgrid.IpActionTypeAllow),
IpMask: pulumi.String("12.18.30.15"),
},
&eventgrid.InboundIpRuleArgs{
Action: pulumi.String(eventgrid.IpActionTypeAllow),
IpMask: pulumi.String("12.18.176.1"),
},
},
Location: pulumi.String("westus2"),
PublicNetworkAccess: pulumi.String(eventgrid.PublicNetworkAccessEnabled),
ResourceGroupName: pulumi.String("examplerg"),
Tags: pulumi.StringMap{
"tag1": pulumi.String("value1"),
"tag2": pulumi.String("value2"),
},
})
if err != nil {
return err
}
return nil
})
}
terraform {
required_providers {
azure-native = {
source = "pulumi/azure-native"
}
}
}
resource "azure-native_eventgrid_domain" "domain" {
lifecycle {
create_before_destroy = true
}
domain_name = "exampledomain1"
inbound_ip_rules {
action = "Allow"
ip_mask = "12.18.30.15"
}
inbound_ip_rules {
action = "Allow"
ip_mask = "12.18.176.1"
}
location = "westus2"
public_network_access = "Enabled"
resource_group_name = "examplerg"
tags = {
"tag1" = "value1"
"tag2" = "value2"
}
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.eventgrid.Domain;
import com.pulumi.azurenative.eventgrid.DomainArgs;
import com.pulumi.azurenative.eventgrid.inputs.InboundIpRuleArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 domain = new Domain("domain", DomainArgs.builder()
.domainName("exampledomain1")
.inboundIpRules(
InboundIpRuleArgs.builder()
.action("Allow")
.ipMask("12.18.30.15")
.build(),
InboundIpRuleArgs.builder()
.action("Allow")
.ipMask("12.18.176.1")
.build())
.location("westus2")
.publicNetworkAccess("Enabled")
.resourceGroupName("examplerg")
.tags(Map.ofEntries(
Map.entry("tag1", "value1"),
Map.entry("tag2", "value2")
))
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const domain = new azure_native.eventgrid.Domain("domain", {
domainName: "exampledomain1",
inboundIpRules: [
{
action: azure_native.eventgrid.IpActionType.Allow,
ipMask: "12.18.30.15",
},
{
action: azure_native.eventgrid.IpActionType.Allow,
ipMask: "12.18.176.1",
},
],
location: "westus2",
publicNetworkAccess: azure_native.eventgrid.PublicNetworkAccess.Enabled,
resourceGroupName: "examplerg",
tags: {
tag1: "value1",
tag2: "value2",
},
});
import pulumi
import pulumi_azure_native as azure_native
domain = azure_native.eventgrid.Domain("domain",
domain_name="exampledomain1",
inbound_ip_rules=[
{
"action": azure_native.eventgrid.IpActionType.ALLOW,
"ip_mask": "12.18.30.15",
},
{
"action": azure_native.eventgrid.IpActionType.ALLOW,
"ip_mask": "12.18.176.1",
},
],
location="westus2",
public_network_access=azure_native.eventgrid.PublicNetworkAccess.ENABLED,
resource_group_name="examplerg",
tags={
"tag1": "value1",
"tag2": "value2",
})
resources:
domain:
type: azure-native:eventgrid:Domain
properties:
domainName: exampledomain1
inboundIpRules:
- action: Allow
ipMask: 12.18.30.15
- action: Allow
ipMask: 12.18.176.1
location: westus2
publicNetworkAccess: Enabled
resourceGroupName: examplerg
tags:
tag1: value1
tag2: value2
Create Domain Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
@overload
def Domain(resource_name: str,
args: DomainArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Domain(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
identity: Optional[IdentityInfoArgs] = None,
input_schema: Optional[Union[str, InputSchema]] = None,
disable_local_auth: Optional[bool] = None,
domain_name: Optional[str] = None,
event_type_info: Optional[EventTypeInfoArgs] = None,
auto_create_topic_with_first_subscription: Optional[bool] = None,
inbound_ip_rules: Optional[Sequence[InboundIpRuleArgs]] = None,
data_residency_boundary: Optional[Union[str, DataResidencyBoundary]] = None,
input_schema_mapping: Optional[JsonInputSchemaMappingArgs] = None,
location: Optional[str] = None,
minimum_tls_version_allowed: Optional[Union[str, TlsVersion]] = None,
public_network_access: Optional[Union[str, PublicNetworkAccess]] = None,
auto_delete_topic_with_last_subscription: Optional[bool] = None,
tags: Optional[Mapping[str, str]] = None)
public Domain(String name, DomainArgs args)
public Domain(String name, DomainArgs args, CustomResourceOptions options)
type: azure-native:eventgrid:Domain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "azure-native_eventgrid_domain" "name" {
# resource properties
}
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.
Constructor example
The following reference example uses placeholder values for all input properties.
var exampledomainResourceResourceFromEventgrid = new AzureNative.EventGrid.Domain("exampledomainResourceResourceFromEventgrid", new()
{
ResourceGroupName = "string",
Identity = new AzureNative.EventGrid.Inputs.IdentityInfoArgs
{
PrincipalId = "string",
TenantId = "string",
Type = "string",
UserAssignedIdentities =
{
{ "string", new AzureNative.EventGrid.Inputs.UserIdentityPropertiesArgs
{
ClientId = "string",
PrincipalId = "string",
} },
},
},
InputSchema = "string",
DisableLocalAuth = false,
DomainName = "string",
EventTypeInfo = new AzureNative.EventGrid.Inputs.EventTypeInfoArgs
{
InlineEventTypes =
{
{ "string", new AzureNative.EventGrid.Inputs.InlineEventPropertiesArgs
{
DataSchemaUrl = "string",
Description = "string",
DisplayName = "string",
DocumentationUrl = "string",
} },
},
Kind = "string",
},
AutoCreateTopicWithFirstSubscription = false,
InboundIpRules = new[]
{
new AzureNative.EventGrid.Inputs.InboundIpRuleArgs
{
Action = "string",
IpMask = "string",
},
},
DataResidencyBoundary = "string",
InputSchemaMapping = new AzureNative.EventGrid.Inputs.JsonInputSchemaMappingArgs
{
InputSchemaMappingType = "Json",
DataVersion = new AzureNative.EventGrid.Inputs.JsonFieldWithDefaultArgs
{
DefaultValue = "string",
SourceField = "string",
},
EventTime = new AzureNative.EventGrid.Inputs.JsonFieldArgs
{
SourceField = "string",
},
EventType = new AzureNative.EventGrid.Inputs.JsonFieldWithDefaultArgs
{
DefaultValue = "string",
SourceField = "string",
},
Id = new AzureNative.EventGrid.Inputs.JsonFieldArgs
{
SourceField = "string",
},
Subject = new AzureNative.EventGrid.Inputs.JsonFieldWithDefaultArgs
{
DefaultValue = "string",
SourceField = "string",
},
Topic = new AzureNative.EventGrid.Inputs.JsonFieldArgs
{
SourceField = "string",
},
},
Location = "string",
MinimumTlsVersionAllowed = "string",
PublicNetworkAccess = "string",
AutoDeleteTopicWithLastSubscription = false,
Tags =
{
{ "string", "string" },
},
});
example, err := eventgrid.NewDomain(ctx, "exampledomainResourceResourceFromEventgrid", &eventgrid.DomainArgs{
ResourceGroupName: pulumi.String("string"),
Identity: &eventgrid.IdentityInfoArgs{
PrincipalId: pulumi.String("string"),
TenantId: pulumi.String("string"),
Type: pulumi.String("string"),
UserAssignedIdentities: eventgrid.UserIdentityPropertiesMap{
"string": &eventgrid.UserIdentityPropertiesArgs{
ClientId: pulumi.String("string"),
PrincipalId: pulumi.String("string"),
},
},
},
InputSchema: pulumi.String("string"),
DisableLocalAuth: pulumi.Bool(false),
DomainName: pulumi.String("string"),
EventTypeInfo: &eventgrid.EventTypeInfoArgs{
InlineEventTypes: eventgrid.InlineEventPropertiesMap{
"string": &eventgrid.InlineEventPropertiesArgs{
DataSchemaUrl: pulumi.String("string"),
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
DocumentationUrl: pulumi.String("string"),
},
},
Kind: pulumi.String("string"),
},
AutoCreateTopicWithFirstSubscription: pulumi.Bool(false),
InboundIpRules: eventgrid.InboundIpRuleArray{
&eventgrid.InboundIpRuleArgs{
Action: pulumi.String("string"),
IpMask: pulumi.String("string"),
},
},
DataResidencyBoundary: pulumi.String("string"),
InputSchemaMapping: &eventgrid.JsonInputSchemaMappingArgs{
InputSchemaMappingType: pulumi.String("Json"),
DataVersion: &eventgrid.JsonFieldWithDefaultArgs{
DefaultValue: pulumi.String("string"),
SourceField: pulumi.String("string"),
},
EventTime: &eventgrid.JsonFieldArgs{
SourceField: pulumi.String("string"),
},
EventType: &eventgrid.JsonFieldWithDefaultArgs{
DefaultValue: pulumi.String("string"),
SourceField: pulumi.String("string"),
},
Id: &eventgrid.JsonFieldArgs{
SourceField: pulumi.String("string"),
},
Subject: &eventgrid.JsonFieldWithDefaultArgs{
DefaultValue: pulumi.String("string"),
SourceField: pulumi.String("string"),
},
Topic: &eventgrid.JsonFieldArgs{
SourceField: pulumi.String("string"),
},
},
Location: pulumi.String("string"),
MinimumTlsVersionAllowed: pulumi.String("string"),
PublicNetworkAccess: pulumi.String("string"),
AutoDeleteTopicWithLastSubscription: pulumi.Bool(false),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
resource "azure-native_eventgrid_domain" "exampledomainResourceResourceFromEventgrid" {
lifecycle {
create_before_destroy = true
}
resource_group_name = "string"
identity = {
principal_id = "string"
tenant_id = "string"
type = "string"
user_assigned_identities = {
"string" = {
client_id = "string"
principal_id = "string"
}
}
}
input_schema = "string"
disable_local_auth = false
domain_name = "string"
event_type_info = {
inline_event_types = {
"string" = {
data_schema_url = "string"
description = "string"
display_name = "string"
documentation_url = "string"
}
}
kind = "string"
}
auto_create_topic_with_first_subscription = false
inbound_ip_rules {
action = "string"
ip_mask = "string"
}
data_residency_boundary = "string"
input_schema_mapping = {
input_schema_mapping_type = "Json"
data_version = {
default_value = "string"
source_field = "string"
}
event_time = {
source_field = "string"
}
event_type = {
default_value = "string"
source_field = "string"
}
id = {
source_field = "string"
}
subject = {
default_value = "string"
source_field = "string"
}
topic = {
source_field = "string"
}
}
location = "string"
minimum_tls_version_allowed = "string"
public_network_access = "string"
auto_delete_topic_with_last_subscription = false
tags = {
"string" = "string"
}
}
var exampledomainResourceResourceFromEventgrid = new com.pulumi.azurenative.eventgrid.Domain("exampledomainResourceResourceFromEventgrid", com.pulumi.azurenative.eventgrid.DomainArgs.builder()
.resourceGroupName("string")
.identity(IdentityInfoArgs.builder()
.principalId("string")
.tenantId("string")
.type("string")
.userAssignedIdentities(Map.of("string", com.pulumi.azurenative.eventgrid.inputs.UserIdentityPropertiesArgs.builder()
.clientId("string")
.principalId("string")
.build()))
.build())
.inputSchema("string")
.disableLocalAuth(false)
.domainName("string")
.eventTypeInfo(EventTypeInfoArgs.builder()
.inlineEventTypes(Map.of("string", InlineEventPropertiesArgs.builder()
.dataSchemaUrl("string")
.description("string")
.displayName("string")
.documentationUrl("string")
.build()))
.kind("string")
.build())
.autoCreateTopicWithFirstSubscription(false)
.inboundIpRules(InboundIpRuleArgs.builder()
.action("string")
.ipMask("string")
.build())
.dataResidencyBoundary("string")
.inputSchemaMapping(JsonInputSchemaMappingArgs.builder()
.dataVersion(JsonFieldWithDefaultArgs.builder()
.defaultValue("string")
.sourceField("string")
.build())
.eventTime(JsonFieldArgs.builder()
.sourceField("string")
.build())
.eventType(JsonFieldWithDefaultArgs.builder()
.defaultValue("string")
.sourceField("string")
.build())
.id(JsonFieldArgs.builder()
.sourceField("string")
.build())
.subject(JsonFieldWithDefaultArgs.builder()
.defaultValue("string")
.sourceField("string")
.build())
.topic(JsonFieldArgs.builder()
.sourceField("string")
.build())
.build())
.location("string")
.minimumTlsVersionAllowed("string")
.publicNetworkAccess("string")
.autoDeleteTopicWithLastSubscription(false)
.tags(Map.of("string", "string"))
.build());
exampledomain_resource_resource_from_eventgrid = azure_native.eventgrid.Domain("exampledomainResourceResourceFromEventgrid",
resource_group_name="string",
identity={
"principal_id": "string",
"tenant_id": "string",
"type": "string",
"user_assigned_identities": {
"string": {
"client_id": "string",
"principal_id": "string",
},
},
},
input_schema="string",
disable_local_auth=False,
domain_name="string",
event_type_info={
"inline_event_types": {
"string": {
"data_schema_url": "string",
"description": "string",
"display_name": "string",
"documentation_url": "string",
},
},
"kind": "string",
},
auto_create_topic_with_first_subscription=False,
inbound_ip_rules=[{
"action": "string",
"ip_mask": "string",
}],
data_residency_boundary="string",
input_schema_mapping={
"input_schema_mapping_type": "Json",
"data_version": {
"default_value": "string",
"source_field": "string",
},
"event_time": {
"source_field": "string",
},
"event_type": {
"default_value": "string",
"source_field": "string",
},
"id": {
"source_field": "string",
},
"subject": {
"default_value": "string",
"source_field": "string",
},
"topic": {
"source_field": "string",
},
},
location="string",
minimum_tls_version_allowed="string",
public_network_access="string",
auto_delete_topic_with_last_subscription=False,
tags={
"string": "string",
})
const exampledomainResourceResourceFromEventgrid = new azure_native.eventgrid.Domain("exampledomainResourceResourceFromEventgrid", {
resourceGroupName: "string",
identity: {
principalId: "string",
tenantId: "string",
type: "string",
userAssignedIdentities: {
string: {
clientId: "string",
principalId: "string",
},
},
},
inputSchema: "string",
disableLocalAuth: false,
domainName: "string",
eventTypeInfo: {
inlineEventTypes: {
string: {
dataSchemaUrl: "string",
description: "string",
displayName: "string",
documentationUrl: "string",
},
},
kind: "string",
},
autoCreateTopicWithFirstSubscription: false,
inboundIpRules: [{
action: "string",
ipMask: "string",
}],
dataResidencyBoundary: "string",
inputSchemaMapping: {
inputSchemaMappingType: "Json",
dataVersion: {
defaultValue: "string",
sourceField: "string",
},
eventTime: {
sourceField: "string",
},
eventType: {
defaultValue: "string",
sourceField: "string",
},
id: {
sourceField: "string",
},
subject: {
defaultValue: "string",
sourceField: "string",
},
topic: {
sourceField: "string",
},
},
location: "string",
minimumTlsVersionAllowed: "string",
publicNetworkAccess: "string",
autoDeleteTopicWithLastSubscription: false,
tags: {
string: "string",
},
});
type: azure-native:eventgrid:Domain
properties:
autoCreateTopicWithFirstSubscription: false
autoDeleteTopicWithLastSubscription: false
dataResidencyBoundary: string
disableLocalAuth: false
domainName: string
eventTypeInfo:
inlineEventTypes:
string:
dataSchemaUrl: string
description: string
displayName: string
documentationUrl: string
kind: string
identity:
principalId: string
tenantId: string
type: string
userAssignedIdentities:
string:
clientId: string
principalId: string
inboundIpRules:
- action: string
ipMask: string
inputSchema: string
inputSchemaMapping:
dataVersion:
defaultValue: string
sourceField: string
eventTime:
sourceField: string
eventType:
defaultValue: string
sourceField: string
id:
sourceField: string
inputSchemaMappingType: Json
subject:
defaultValue: string
sourceField: string
topic:
sourceField: string
location: string
minimumTlsVersionAllowed: string
publicNetworkAccess: string
resourceGroupName: string
tags:
string: string
Domain Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
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
string
- The name of the resource group within the user's subscription.
- AutoCreateTopicWithFirstSubscription
bool
- This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource.
In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true.
When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is
created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic
by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the
flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the
domain topic on demand if needed.
- AutoDeleteTopicWithLastSubscription
bool
- This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource.
In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true.
When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope
of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed
(e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full
control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer
resources by the user.
- DataResidencyBoundary
string | Pulumi.AzureNative.EventGrid.DataResidencyBoundary
- Data Residency Boundary of the resource.
- DisableLocalAuth
bool
- This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the domain.
- DomainName
string
- Name of the domain.
- EventTypeInfo
Pulumi.AzureNative.EventGrid.Inputs.EventTypeInfo
- Event Type Information for the domain. This information is provided by the publisher and can be used by the
subscriber to view different types of events that are published.
- Identity
Pulumi.AzureNative.EventGrid.Inputs.IdentityInfo
- Identity information for the Event Grid Domain resource.
- InboundIpRules
List<Pulumi.AzureNative.EventGrid.Inputs.InboundIpRule>
- This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.
- InputSchema
string | Pulumi.AzureNative.EventGrid.InputSchema
- This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource.
- InputSchemaMapping
Pulumi.AzureNative.EventGrid.Inputs.JsonInputSchemaMapping
- Information about the InputSchemaMapping which specified the info about mapping event payload.
- Location
string
- Location of the resource.
- MinimumTlsVersionAllowed
string | Pulumi.AzureNative.EventGrid.TlsVersion
- Minimum TLS version of the publisher allowed to publish to this domain
- PublicNetworkAccess
string | Pulumi.AzureNative.EventGrid.PublicNetworkAccess
- This determines if traffic is allowed over public network. By default it is enabled.
You can further restrict to specific IPs by configuring
- Tags
Dictionary<string, string>
- Tags of the resource.
- ResourceGroupName
string
- The name of the resource group within the user's subscription.
- AutoCreateTopicWithFirstSubscription
bool
- This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource.
In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true.
When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is
created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic
by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the
flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the
domain topic on demand if needed.
- AutoDeleteTopicWithLastSubscription
bool
- This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource.
In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true.
When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope
of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed
(e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full
control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer
resources by the user.
- DataResidencyBoundary
string | DataResidencyBoundary
- Data Residency Boundary of the resource.
- DisableLocalAuth
bool
- This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the domain.
- DomainName
string
- Name of the domain.
- EventTypeInfo
EventTypeInfoArgs
- Event Type Information for the domain. This information is provided by the publisher and can be used by the
subscriber to view different types of events that are published.
- Identity
IdentityInfoArgs
- Identity information for the Event Grid Domain resource.
- InboundIpRules
[]InboundIpRuleArgs
- This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.
- InputSchema
string | InputSchema
- This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource.
- InputSchemaMapping
JsonInputSchemaMappingArgs
- Information about the InputSchemaMapping which specified the info about mapping event payload.
- Location
string
- Location of the resource.
- MinimumTlsVersionAllowed
string | TlsVersion
- Minimum TLS version of the publisher allowed to publish to this domain
- PublicNetworkAccess
string | PublicNetworkAccess
- This determines if traffic is allowed over public network. By default it is enabled.
You can further restrict to specific IPs by configuring
- Tags
map[string]string
- Tags of the resource.
- resource_group_name
string
- The name of the resource group within the user's subscription.
- auto_create_topic_with_first_subscription
bool
- This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource.
In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true.
When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is
created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic
by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the
flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the
domain topic on demand if needed.
- auto_delete_topic_with_last_subscription
bool
- This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource.
In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true.
When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope
of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed
(e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full
control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer
resources by the user.
- data_residency_boundary
string | "WithinGeopair" | "WithinRegion"
- Data Residency Boundary of the resource.
- disable_local_auth
bool
- This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the domain.
- domain_name
string
- Name of the domain.
- event_type_info
object
- Event Type Information for the domain. This information is provided by the publisher and can be used by the
subscriber to view different types of events that are published.
- identity
object
- Identity information for the Event Grid Domain resource.
- inbound_ip_rules
list(object)
- This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.
- input_schema
string | "EventGridSchema" | "CustomEventSchema" | "CloudEventSchemaV1_0"
- This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource.
- input_schema_mapping
object
- Information about the InputSchemaMapping which specified the info about mapping event payload.
- location
string
- Location of the resource.
- minimum_tls_version_allowed
string | "1.0" | "1.1" | "1.2"
- Minimum TLS version of the publisher allowed to publish to this domain
- public_network_access
string | "Enabled" | "Disabled"
- This determines if traffic is allowed over public network. By default it is enabled.
You can further restrict to specific IPs by configuring
- tags
map(string)
- Tags of the resource.
- resourceGroupName
String
- The name of the resource group within the user's subscription.
- autoCreateTopicWithFirstSubscription
Boolean
- This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource.
In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true.
When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is
created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic
by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the
flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the
domain topic on demand if needed.
- autoDeleteTopicWithLastSubscription
Boolean
- This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource.
In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true.
When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope
of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed
(e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full
control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer
resources by the user.
- dataResidencyBoundary
String | DataResidencyBoundary
- Data Residency Boundary of the resource.
- disableLocalAuth
Boolean
- This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the domain.
- domainName
String
- Name of the domain.
- eventTypeInfo
EventTypeInfo
- Event Type Information for the domain. This information is provided by the publisher and can be used by the
subscriber to view different types of events that are published.
- identity
IdentityInfo
- Identity information for the Event Grid Domain resource.
- inboundIpRules
List<InboundIpRule>
- This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.
- inputSchema
String | InputSchema
- This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource.
- inputSchemaMapping
JsonInputSchemaMapping
- Information about the InputSchemaMapping which specified the info about mapping event payload.
- location
String
- Location of the resource.
- minimumTlsVersionAllowed
String | TlsVersion
- Minimum TLS version of the publisher allowed to publish to this domain
- publicNetworkAccess
String | PublicNetworkAccess
- This determines if traffic is allowed over public network. By default it is enabled.
You can further restrict to specific IPs by configuring
- tags
Map<String,String>
- Tags of the resource.
- resourceGroupName
string
- The name of the resource group within the user's subscription.
- autoCreateTopicWithFirstSubscription
boolean
- This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource.
In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true.
When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is
created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic
by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the
flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the
domain topic on demand if needed.
- autoDeleteTopicWithLastSubscription
boolean
- This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource.
In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true.
When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope
of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed
(e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full
control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer
resources by the user.
- dataResidencyBoundary
string | DataResidencyBoundary
- Data Residency Boundary of the resource.
- disableLocalAuth
boolean
- This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the domain.
- domainName
string
- Name of the domain.
- eventTypeInfo
EventTypeInfo
- Event Type Information for the domain. This information is provided by the publisher and can be used by the
subscriber to view different types of events that are published.
- identity
IdentityInfo
- Identity information for the Event Grid Domain resource.
- inboundIpRules
InboundIpRule[]
- This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.
- inputSchema
string | InputSchema
- This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource.
- inputSchemaMapping
JsonInputSchemaMapping
- Information about the InputSchemaMapping which specified the info about mapping event payload.
- location
string
- Location of the resource.
- minimumTlsVersionAllowed
string | TlsVersion
- Minimum TLS version of the publisher allowed to publish to this domain
- publicNetworkAccess
string | PublicNetworkAccess
- This determines if traffic is allowed over public network. By default it is enabled.
You can further restrict to specific IPs by configuring
- tags
{[key: string]: string}
- Tags of the resource.
- resource_group_name
str
- The name of the resource group within the user's subscription.
- auto_create_topic_with_first_subscription
bool
- This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource.
In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true.
When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is
created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic
by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the
flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the
domain topic on demand if needed.
- auto_delete_topic_with_last_subscription
bool
- This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource.
In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true.
When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope
of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed
(e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full
control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer
resources by the user.
- data_residency_boundary
str | DataResidencyBoundary
- Data Residency Boundary of the resource.
- disable_local_auth
bool
- This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the domain.
- domain_name
str
- Name of the domain.
- event_type_info
EventTypeInfoArgs
- Event Type Information for the domain. This information is provided by the publisher and can be used by the
subscriber to view different types of events that are published.
- identity
IdentityInfoArgs
- Identity information for the Event Grid Domain resource.
- inbound_ip_rules
Sequence[InboundIpRuleArgs]
- This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.
- input_schema
str | InputSchema
- This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource.
- input_schema_mapping
JsonInputSchemaMappingArgs
- Information about the InputSchemaMapping which specified the info about mapping event payload.
- location
str
- Location of the resource.
- minimum_tls_version_allowed
str | TlsVersion
- Minimum TLS version of the publisher allowed to publish to this domain
- public_network_access
str | PublicNetworkAccess
- This determines if traffic is allowed over public network. By default it is enabled.
You can further restrict to specific IPs by configuring
- tags
Mapping[str, str]
- Tags of the resource.
- resourceGroupName
String
- The name of the resource group within the user's subscription.
- autoCreateTopicWithFirstSubscription
Boolean
- This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource.
In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true.
When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is
created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic
by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the
flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the
domain topic on demand if needed.
- autoDeleteTopicWithLastSubscription
Boolean
- This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource.
In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true.
When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope
of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed
(e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full
control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer
resources by the user.
- dataResidencyBoundary
String | "WithinGeopair" | "WithinRegion"
- Data Residency Boundary of the resource.
- disableLocalAuth
Boolean
- This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the domain.
- domainName
String
- Name of the domain.
- eventTypeInfo
Property Map
- Event Type Information for the domain. This information is provided by the publisher and can be used by the
subscriber to view different types of events that are published.
- identity
Property Map
- Identity information for the Event Grid Domain resource.
- inboundIpRules
List<Property Map>
- This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.
- inputSchema
String | "EventGridSchema" | "CustomEventSchema" | "CloudEventSchemaV1_0"
- This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource.
- inputSchemaMapping
Property Map
- Information about the InputSchemaMapping which specified the info about mapping event payload.
- location
String
- Location of the resource.
- minimumTlsVersionAllowed
String | "1.0" | "1.1" | "1.2"
- Minimum TLS version of the publisher allowed to publish to this domain
- publicNetworkAccess
String | "Enabled" | "Disabled"
- This determines if traffic is allowed over public network. By default it is enabled.
You can further restrict to specific IPs by configuring
- tags
Map<String>
- Tags of the resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the Domain resource produces the following output properties:
Supporting Types
ConnectionStateResponse, ConnectionStateResponseArgs
ConnectionState information.DataResidencyBoundary, DataResidencyBoundaryArgs
| Name | Value |
|---|
| WithinGeopair | WithinGeopair |
| WithinRegion | WithinRegion |
| Name | Value |
|---|
| DataResidencyBoundaryWithinGeopair | WithinGeopair |
| DataResidencyBoundaryWithinRegion | WithinRegion |
| Value |
|---|
WithinGeopair |
WithinRegion |
| Name | Value |
|---|
| WithinGeopair | WithinGeopair |
| WithinRegion | WithinRegion |
| Name | Value |
|---|
| WithinGeopair | WithinGeopair |
| WithinRegion | WithinRegion |
| Name | Value |
|---|
| WITHIN_GEOPAIR | WithinGeopair |
| WITHIN_REGION | WithinRegion |
| Value |
|---|
WithinGeopair |
WithinRegion |
EventDefinitionKind, EventDefinitionKindArgs
| Name | Value |
|---|
| EventDefinitionKindInline | Inline |
EventTypeInfo, EventTypeInfoArgs
The event type information for Channels.- InlineEventTypes
Dictionary<string, Pulumi.AzureNative.EventGrid.Inputs.InlineEventProperties>
- A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event.
An example of a valid inline event name is "Contoso.OrderCreated".
The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.
- Kind
string | Pulumi.AzureNative.EventGrid.EventDefinitionKind
- The kind of event type used.
- InlineEventTypes
map[string]InlineEventProperties
- A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event.
An example of a valid inline event name is "Contoso.OrderCreated".
The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.
- Kind
string | EventDefinitionKind
- The kind of event type used.
- inline_event_types
map(object)
- A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event.
An example of a valid inline event name is "Contoso.OrderCreated".
The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.
- kind
string | "Inline"
- The kind of event type used.
- inlineEventTypes
Map<String,InlineEventProperties>
- A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event.
An example of a valid inline event name is "Contoso.OrderCreated".
The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.
- kind
String | EventDefinitionKind
- The kind of event type used.
- inlineEventTypes
{[key: string]: InlineEventProperties}
- A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event.
An example of a valid inline event name is "Contoso.OrderCreated".
The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.
- kind
string | EventDefinitionKind
- The kind of event type used.
- inline_event_types
Mapping[str, InlineEventProperties]
- A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event.
An example of a valid inline event name is "Contoso.OrderCreated".
The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.
- kind
str | EventDefinitionKind
- The kind of event type used.
- inlineEventTypes
Map<Property Map>
- A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event.
An example of a valid inline event name is "Contoso.OrderCreated".
The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.
- kind
String | "Inline"
- The kind of event type used.
EventTypeInfoResponse, EventTypeInfoResponseArgs
The event type information for Channels.- InlineEventTypes
Dictionary<string, Pulumi.AzureNative.EventGrid.Inputs.InlineEventPropertiesResponse>
- A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event.
An example of a valid inline event name is "Contoso.OrderCreated".
The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.
- Kind
string
- The kind of event type used.
- InlineEventTypes
map[string]InlineEventPropertiesResponse
- A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event.
An example of a valid inline event name is "Contoso.OrderCreated".
The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.
- Kind
string
- The kind of event type used.
- inline_event_types
map(object)
- A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event.
An example of a valid inline event name is "Contoso.OrderCreated".
The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.
- kind
string
- The kind of event type used.
- inlineEventTypes
Map<String,InlineEventPropertiesResponse>
- A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event.
An example of a valid inline event name is "Contoso.OrderCreated".
The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.
- kind
String
- The kind of event type used.
- inlineEventTypes
{[key: string]: InlineEventPropertiesResponse}
- A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event.
An example of a valid inline event name is "Contoso.OrderCreated".
The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.
- kind
string
- The kind of event type used.
- inline_event_types
Mapping[str, InlineEventPropertiesResponse]
- A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event.
An example of a valid inline event name is "Contoso.OrderCreated".
The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.
- kind
str
- The kind of event type used.
- inlineEventTypes
Map<Property Map>
- A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event.
An example of a valid inline event name is "Contoso.OrderCreated".
The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.
- kind
String
- The kind of event type used.
IdentityInfo, IdentityInfoArgs
The identity information for the resource.- PrincipalId
string
- The principal ID of resource identity.
- TenantId
string
- The tenant ID of resource.
- Type
string | Pulumi.AzureNative.EventGrid.IdentityType
- The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity.
- UserAssignedIdentities
Dictionary<string, Pulumi.AzureNative.EventGrid.Inputs.UserIdentityProperties>
- The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
This property is currently not used and reserved for future usage.
- PrincipalId
string
- The principal ID of resource identity.
- TenantId
string
- The tenant ID of resource.
- Type
string | IdentityType
- The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity.
- UserAssignedIdentities
map[string]UserIdentityProperties
- The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
This property is currently not used and reserved for future usage.
- principal_id
string
- The principal ID of resource identity.
- tenant_id
string
- The tenant ID of resource.
- type
string | "None" | "SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned"
- The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity.
- user_assigned_identities
map(object)
- The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
This property is currently not used and reserved for future usage.
- principalId
String
- The principal ID of resource identity.
- tenantId
String
- The tenant ID of resource.
- type
String | IdentityType
- The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity.
- userAssignedIdentities
Map<String,UserIdentityProperties>
- The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
This property is currently not used and reserved for future usage.
- principalId
string
- The principal ID of resource identity.
- tenantId
string
- The tenant ID of resource.
- type
string | IdentityType
- The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity.
- userAssignedIdentities
{[key: string]: UserIdentityProperties}
- The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
This property is currently not used and reserved for future usage.
- principal_id
str
- The principal ID of resource identity.
- tenant_id
str
- The tenant ID of resource.
- type
str | IdentityType
- The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity.
- user_assigned_identities
Mapping[str, UserIdentityProperties]
- The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
This property is currently not used and reserved for future usage.
- principalId
String
- The principal ID of resource identity.
- tenantId
String
- The tenant ID of resource.
- type
String | "None" | "SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned"
- The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity.
- userAssignedIdentities
Map<Property Map>
- The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
This property is currently not used and reserved for future usage.
IdentityInfoResponse, IdentityInfoResponseArgs
The identity information for the resource.- PrincipalId
string
- The principal ID of resource identity.
- TenantId
string
- The tenant ID of resource.
- Type
string
- The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity.
- UserAssignedIdentities
Dictionary<string, Pulumi.AzureNative.EventGrid.Inputs.UserIdentityPropertiesResponse>
- The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
This property is currently not used and reserved for future usage.
- PrincipalId
string
- The principal ID of resource identity.
- TenantId
string
- The tenant ID of resource.
- Type
string
- The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity.
- UserAssignedIdentities
map[string]UserIdentityPropertiesResponse
- The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
This property is currently not used and reserved for future usage.
- principal_id
string
- The principal ID of resource identity.
- tenant_id
string
- The tenant ID of resource.
- type
string
- The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity.
- user_assigned_identities
map(object)
- The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
This property is currently not used and reserved for future usage.
- principalId
String
- The principal ID of resource identity.
- tenantId
String
- The tenant ID of resource.
- type
String
- The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity.
- userAssignedIdentities
Map<String,UserIdentityPropertiesResponse>
- The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
This property is currently not used and reserved for future usage.
- principalId
string
- The principal ID of resource identity.
- tenantId
string
- The tenant ID of resource.
- type
string
- The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity.
- userAssignedIdentities
{[key: string]: UserIdentityPropertiesResponse}
- The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
This property is currently not used and reserved for future usage.
- principal_id
str
- The principal ID of resource identity.
- tenant_id
str
- The tenant ID of resource.
- type
str
- The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity.
- user_assigned_identities
Mapping[str, UserIdentityPropertiesResponse]
- The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
This property is currently not used and reserved for future usage.
- principalId
String
- The principal ID of resource identity.
- tenantId
String
- The tenant ID of resource.
- type
String
- The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity.
- userAssignedIdentities
Map<Property Map>
- The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
This property is currently not used and reserved for future usage.
IdentityType, IdentityTypeArgs
| Name | Value |
|---|
| None | None |
| SystemAssigned | SystemAssigned |
| UserAssigned | UserAssigned |
| SystemAssigned_UserAssigned | SystemAssigned, UserAssigned |
| Name | Value |
|---|
| IdentityTypeNone | None |
| IdentityTypeSystemAssigned | SystemAssigned |
| IdentityTypeUserAssigned | UserAssigned |
| IdentityType_SystemAssigned_UserAssigned | SystemAssigned, UserAssigned |
| Value |
|---|
None |
SystemAssigned |
UserAssigned |
SystemAssigned, UserAssigned |
| Name | Value |
|---|
| None | None |
| SystemAssigned | SystemAssigned |
| UserAssigned | UserAssigned |
| SystemAssigned_UserAssigned | SystemAssigned, UserAssigned |
| Name | Value |
|---|
| None | None |
| SystemAssigned | SystemAssigned |
| UserAssigned | UserAssigned |
| SystemAssigned_UserAssigned | SystemAssigned, UserAssigned |
| Name | Value |
|---|
| NONE | None |
| SYSTEM_ASSIGNED | SystemAssigned |
| USER_ASSIGNED | UserAssigned |
| SYSTEM_ASSIGNED_USER_ASSIGNED | SystemAssigned, UserAssigned |
| Value |
|---|
None |
SystemAssigned |
UserAssigned |
SystemAssigned, UserAssigned |
InboundIpRule, InboundIpRuleArgs
- Action
string | IpActionType
- Action to perform based on the match or no match of the IpMask.
- IpMask
string
- IP Address in CIDR notation e.g., 10.0.0.0/8.
- action
string | "Allow"
- Action to perform based on the match or no match of the IpMask.
- ip_mask
string
- IP Address in CIDR notation e.g., 10.0.0.0/8.
- action
String | IpActionType
- Action to perform based on the match or no match of the IpMask.
- ipMask
String
- IP Address in CIDR notation e.g., 10.0.0.0/8.
- action
string | IpActionType
- Action to perform based on the match or no match of the IpMask.
- ipMask
string
- IP Address in CIDR notation e.g., 10.0.0.0/8.
- action
str | IpActionType
- Action to perform based on the match or no match of the IpMask.
- ip_mask
str
- IP Address in CIDR notation e.g., 10.0.0.0/8.
- action
String | "Allow"
- Action to perform based on the match or no match of the IpMask.
- ipMask
String
- IP Address in CIDR notation e.g., 10.0.0.0/8.
InboundIpRuleResponse, InboundIpRuleResponseArgs
- Action
string
- Action to perform based on the match or no match of the IpMask.
- IpMask
string
- IP Address in CIDR notation e.g., 10.0.0.0/8.
- Action
string
- Action to perform based on the match or no match of the IpMask.
- IpMask
string
- IP Address in CIDR notation e.g., 10.0.0.0/8.
- action
string
- Action to perform based on the match or no match of the IpMask.
- ip_mask
string
- IP Address in CIDR notation e.g., 10.0.0.0/8.
- action
String
- Action to perform based on the match or no match of the IpMask.
- ipMask
String
- IP Address in CIDR notation e.g., 10.0.0.0/8.
- action
string
- Action to perform based on the match or no match of the IpMask.
- ipMask
string
- IP Address in CIDR notation e.g., 10.0.0.0/8.
- action
str
- Action to perform based on the match or no match of the IpMask.
- ip_mask
str
- IP Address in CIDR notation e.g., 10.0.0.0/8.
- action
String
- Action to perform based on the match or no match of the IpMask.
- ipMask
String
- IP Address in CIDR notation e.g., 10.0.0.0/8.
InlineEventProperties, InlineEventPropertiesArgs
Additional information about every inline event.InlineEventPropertiesResponse, InlineEventPropertiesResponseArgs
Additional information about every inline event.| Name | Value |
|---|
| EventGridSchema | EventGridSchema |
| CustomEventSchema | CustomEventSchema |
| CloudEventSchemaV1_0 | CloudEventSchemaV1_0 |
| Name | Value |
|---|
| InputSchemaEventGridSchema | EventGridSchema |
| InputSchemaCustomEventSchema | CustomEventSchema |
| InputSchema_CloudEventSchemaV1_0 | CloudEventSchemaV1_0 |
| Value |
|---|
EventGridSchema |
CustomEventSchema |
CloudEventSchemaV1_0 |
| Name | Value |
|---|
| EventGridSchema | EventGridSchema |
| CustomEventSchema | CustomEventSchema |
| CloudEventSchemaV1_0 | CloudEventSchemaV1_0 |
| Name | Value |
|---|
| EventGridSchema | EventGridSchema |
| CustomEventSchema | CustomEventSchema |
| CloudEventSchemaV1_0 | CloudEventSchemaV1_0 |
| Name | Value |
|---|
| EVENT_GRID_SCHEMA | EventGridSchema |
| CUSTOM_EVENT_SCHEMA | CustomEventSchema |
| CLOUD_EVENT_SCHEMA_V1_0 | CloudEventSchemaV1_0 |
| Value |
|---|
EventGridSchema |
CustomEventSchema |
CloudEventSchemaV1_0 |
IpActionType, IpActionTypeArgs
| Name | Value |
|---|
| IpActionTypeAllow | Allow |
JsonField, JsonFieldArgs
This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'id', 'topic' and 'eventtime' properties. This represents a field in the input event schema.- SourceField
string
- Name of a field in the input event schema that's to be used as the source of a mapping.
- SourceField
string
- Name of a field in the input event schema that's to be used as the source of a mapping.
- source_field
string
- Name of a field in the input event schema that's to be used as the source of a mapping.
- sourceField
String
- Name of a field in the input event schema that's to be used as the source of a mapping.
- sourceField
string
- Name of a field in the input event schema that's to be used as the source of a mapping.
- source_field
str
- Name of a field in the input event schema that's to be used as the source of a mapping.
- sourceField
String
- Name of a field in the input event schema that's to be used as the source of a mapping.
JsonFieldResponse, JsonFieldResponseArgs
This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'id', 'topic' and 'eventtime' properties. This represents a field in the input event schema.- SourceField
string
- Name of a field in the input event schema that's to be used as the source of a mapping.
- SourceField
string
- Name of a field in the input event schema that's to be used as the source of a mapping.
- source_field
string
- Name of a field in the input event schema that's to be used as the source of a mapping.
- sourceField
String
- Name of a field in the input event schema that's to be used as the source of a mapping.
- sourceField
string
- Name of a field in the input event schema that's to be used as the source of a mapping.
- source_field
str
- Name of a field in the input event schema that's to be used as the source of a mapping.
- sourceField
String
- Name of a field in the input event schema that's to be used as the source of a mapping.
JsonFieldWithDefault, JsonFieldWithDefaultArgs
This is used to express the source of an input schema mapping for a single target field
in the Event Grid Event schema. This is currently used in the mappings for the 'subject',
'eventtype' and 'dataversion' properties. This represents a field in the input event schema
along with a default value to be used, and at least one of these two properties should be provided.- DefaultValue
string
- The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.
- SourceField
string
- Name of a field in the input event schema that's to be used as the source of a mapping.
- DefaultValue
string
- The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.
- SourceField
string
- Name of a field in the input event schema that's to be used as the source of a mapping.
- default_value
string
- The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.
- source_field
string
- Name of a field in the input event schema that's to be used as the source of a mapping.
- defaultValue
String
- The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.
- sourceField
String
- Name of a field in the input event schema that's to be used as the source of a mapping.
- defaultValue
string
- The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.
- sourceField
string
- Name of a field in the input event schema that's to be used as the source of a mapping.
- default_value
str
- The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.
- source_field
str
- Name of a field in the input event schema that's to be used as the source of a mapping.
- defaultValue
String
- The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.
- sourceField
String
- Name of a field in the input event schema that's to be used as the source of a mapping.
JsonFieldWithDefaultResponse, JsonFieldWithDefaultResponseArgs
This is used to express the source of an input schema mapping for a single target field
in the Event Grid Event schema. This is currently used in the mappings for the 'subject',
'eventtype' and 'dataversion' properties. This represents a field in the input event schema
along with a default value to be used, and at least one of these two properties should be provided.- DefaultValue
string
- The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.
- SourceField
string
- Name of a field in the input event schema that's to be used as the source of a mapping.
- DefaultValue
string
- The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.
- SourceField
string
- Name of a field in the input event schema that's to be used as the source of a mapping.
- default_value
string
- The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.
- source_field
string
- Name of a field in the input event schema that's to be used as the source of a mapping.
- defaultValue
String
- The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.
- sourceField
String
- Name of a field in the input event schema that's to be used as the source of a mapping.
- defaultValue
string
- The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.
- sourceField
string
- Name of a field in the input event schema that's to be used as the source of a mapping.
- default_value
str
- The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.
- source_field
str
- Name of a field in the input event schema that's to be used as the source of a mapping.
- defaultValue
String
- The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.
- sourceField
String
- Name of a field in the input event schema that's to be used as the source of a mapping.
This enables publishing to Event Grid using a custom input schema. This can be used to map properties from a custom input JSON schema to the Event Grid event schema.- data_version
object
- The mapping information for the DataVersion property of the Event Grid Event.
- event_time
object
- The mapping information for the EventTime property of the Event Grid Event.
- event_type
object
- The mapping information for the EventType property of the Event Grid Event.
- id
object
- The mapping information for the Id property of the Event Grid Event.
- subject
object
- The mapping information for the Subject property of the Event Grid Event.
- topic
object
- The mapping information for the Topic property of the Event Grid Event.
This enables publishing to Event Grid using a custom input schema. This can be used to map properties from a custom input JSON schema to the Event Grid event schema.- data_version
object
- The mapping information for the DataVersion property of the Event Grid Event.
- event_time
object
- The mapping information for the EventTime property of the Event Grid Event.
- event_type
object
- The mapping information for the EventType property of the Event Grid Event.
- id
object
- The mapping information for the Id property of the Event Grid Event.
- subject
object
- The mapping information for the Subject property of the Event Grid Event.
- topic
object
- The mapping information for the Topic property of the Event Grid Event.
PrivateEndpointConnectionResponse, PrivateEndpointConnectionResponseArgs
PrivateEndpointResponse, PrivateEndpointResponseArgs
PrivateEndpoint information.- Id
string
- The ARM identifier for Private Endpoint.
- Id
string
- The ARM identifier for Private Endpoint.
- id
string
- The ARM identifier for Private Endpoint.
- id
String
- The ARM identifier for Private Endpoint.
- id
string
- The ARM identifier for Private Endpoint.
- id
str
- The ARM identifier for Private Endpoint.
- id
String
- The ARM identifier for Private Endpoint.
PublicNetworkAccess, PublicNetworkAccessArgs
| Name | Value |
|---|
| Enabled | Enabled |
| Disabled | Disabled |
| Name | Value |
|---|
| PublicNetworkAccessEnabled | Enabled |
| PublicNetworkAccessDisabled | Disabled |
| Name | Value |
|---|
| Enabled | Enabled |
| Disabled | Disabled |
| Name | Value |
|---|
| Enabled | Enabled |
| Disabled | Disabled |
| Name | Value |
|---|
| ENABLED | Enabled |
| DISABLED | Disabled |
SystemDataResponse, SystemDataResponseArgs
Metadata pertaining to creation and last modification of the resource.- CreatedAt
string
- The timestamp of resource creation (UTC).
- CreatedBy
string
- The identity that created the resource.
- CreatedByType
string
- The type of identity that created the resource.
- LastModifiedAt
string
- The timestamp of resource last modification (UTC)
- LastModifiedBy
string
- The identity that last modified the resource.
- LastModifiedByType
string
- The type of identity that last modified the resource.
- CreatedAt
string
- The timestamp of resource creation (UTC).
- CreatedBy
string
- The identity that created the resource.
- CreatedByType
string
- The type of identity that created the resource.
- LastModifiedAt
string
- The timestamp of resource last modification (UTC)
- LastModifiedBy
string
- The identity that last modified the resource.
- LastModifiedByType
string
- The type of identity that last modified the resource.
- createdAt
String
- The timestamp of resource creation (UTC).
- createdBy
String
- The identity that created the resource.
- createdByType
String
- The type of identity that created the resource.
- lastModifiedAt
String
- The timestamp of resource last modification (UTC)
- lastModifiedBy
String
- The identity that last modified the resource.
- lastModifiedByType
String
- The type of identity that last modified the resource.
- createdAt
string
- The timestamp of resource creation (UTC).
- createdBy
string
- The identity that created the resource.
- createdByType
string
- The type of identity that created the resource.
- lastModifiedAt
string
- The timestamp of resource last modification (UTC)
- lastModifiedBy
string
- The identity that last modified the resource.
- lastModifiedByType
string
- The type of identity that last modified the resource.
- createdAt
String
- The timestamp of resource creation (UTC).
- createdBy
String
- The identity that created the resource.
- createdByType
String
- The type of identity that created the resource.
- lastModifiedAt
String
- The timestamp of resource last modification (UTC)
- lastModifiedBy
String
- The identity that last modified the resource.
- lastModifiedByType
String
- The type of identity that last modified the resource.
TlsVersion, TlsVersionArgs
| Name | Value |
|---|
| TlsVersion_1_0 | 1.0 |
| TlsVersion_1_1 | 1.1 |
| TlsVersion_1_2 | 1.2 |
| Name | Value |
|---|
| TlsVersion_1_0 | 1.0 |
| TlsVersion_1_1 | 1.1 |
| TlsVersion_1_2 | 1.2 |
| Name | Value |
|---|
| _1_0 | 1.0 |
| _1_1 | 1.1 |
| _1_2 | 1.2 |
| Name | Value |
|---|
| TlsVersion_1_0 | 1.0 |
| TlsVersion_1_1 | 1.1 |
| TlsVersion_1_2 | 1.2 |
| Name | Value |
|---|
| TLS_VERSION_1_0 | 1.0 |
| TLS_VERSION_1_1 | 1.1 |
| TLS_VERSION_1_2 | 1.2 |
UserIdentityProperties, UserIdentityPropertiesArgs
The information about the user identity.- ClientId
string
- The client id of user assigned identity.
- PrincipalId
string
- The principal id of user assigned identity.
- ClientId
string
- The client id of user assigned identity.
- PrincipalId
string
- The principal id of user assigned identity.
- client_id
string
- The client id of user assigned identity.
- principal_id
string
- The principal id of user assigned identity.
- clientId
String
- The client id of user assigned identity.
- principalId
String
- The principal id of user assigned identity.
- clientId
string
- The client id of user assigned identity.
- principalId
string
- The principal id of user assigned identity.
- client_id
str
- The client id of user assigned identity.
- principal_id
str
- The principal id of user assigned identity.
- clientId
String
- The client id of user assigned identity.
- principalId
String
- The principal id of user assigned identity.
UserIdentityPropertiesResponse, UserIdentityPropertiesResponseArgs
The information about the user identity.- ClientId
string
- The client id of user assigned identity.
- PrincipalId
string
- The principal id of user assigned identity.
- ClientId
string
- The client id of user assigned identity.
- PrincipalId
string
- The principal id of user assigned identity.
- client_id
string
- The client id of user assigned identity.
- principal_id
string
- The principal id of user assigned identity.
- clientId
String
- The client id of user assigned identity.
- principalId
String
- The principal id of user assigned identity.
- clientId
string
- The client id of user assigned identity.
- principalId
string
- The principal id of user assigned identity.
- client_id
str
- The client id of user assigned identity.
- principal_id
str
- The principal id of user assigned identity.
- clientId
String
- The client id of user assigned identity.
- principalId
String
- The principal id of user assigned identity.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:eventgrid:Domain exampledomain1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0