Microsoft.EventGrid domains 2020-06-01

• Latest
• 2025-02-15
• 2024-12-15-preview
• 2024-06-01-preview
• 2023-12-15-preview
• 2023-06-01-preview
• 2022-06-15
• 2021-12-01
• 2021-10-15-preview
• 2021-06-01-preview
• 2020-10-15-preview
• 2020-06-01
• 2020-04-01-preview
• 2020-01-01-preview
• 2019-06-01
• 2019-02-01-preview
• 2018-09-15-preview

Bicep resource definition

The domains resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.EventGrid/domains resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.EventGrid/domains@2020-06-01' = {
  location: 'string'
  name: 'string'
  properties: {
    inboundIpRules: [
      {
        action: 'string'
        ipMask: 'string'
      }
    ]
    inputSchema: 'string'
    inputSchemaMapping: {
      inputSchemaMappingType: 'string'
      // For remaining properties, see InputSchemaMapping objects
    }
    publicNetworkAccess: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

InputSchemaMapping objects

Set the inputSchemaMappingType property to specify the type of object.

For Json, use:

{
  inputSchemaMappingType: 'Json'
  properties: {
    dataVersion: {
      defaultValue: 'string'
      sourceField: 'string'
    }
    eventTime: {
      sourceField: 'string'
    }
    eventType: {
      defaultValue: 'string'
      sourceField: 'string'
    }
    id: {
      sourceField: 'string'
    }
    subject: {
      defaultValue: 'string'
      sourceField: 'string'
    }
    topic: {
      sourceField: 'string'
    }
  }
}

Property Values

DomainProperties

Name	Description	Value
inboundIpRules	This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.	InboundIpRule[]
inputSchema	This determines the format that Event Grid should expect for incoming events published to the domain.	'CloudEventSchemaV1_0' 'CustomEventSchema' 'EventGridSchema'
inputSchemaMapping	Information about the InputSchemaMapping which specified the info about mapping event payload.	InputSchemaMapping
publicNetworkAccess	This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" />	'Disabled' 'Enabled'

InboundIpRule

Name	Description	Value
action	Action to perform based on the match or no match of the IpMask.	'Allow'
ipMask	IP Address in CIDR notation e.g., 10.0.0.0/8.	string

InputSchemaMapping

Name	Description	Value
inputSchemaMappingType	Set to 'Json' for type JsonInputSchemaMapping.	'Json' (required)

JsonField

Name	Description	Value
sourceField	Name of a field in the input event schema that's to be used as the source of a mapping.	string

JsonFieldWithDefault

Name	Description	Value
defaultValue	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.	string
sourceField	Name of a field in the input event schema that's to be used as the source of a mapping.	string

JsonInputSchemaMapping

Name	Description	Value
inputSchemaMappingType	Type of the custom mapping	'Json' (required)
properties	JSON Properties of the input schema mapping	JsonInputSchemaMappingProperties

JsonInputSchemaMappingProperties

Name	Description	Value
dataVersion	The mapping information for the DataVersion property of the Event Grid Event.	JsonFieldWithDefault
eventTime	The mapping information for the EventTime property of the Event Grid Event.	JsonField
eventType	The mapping information for the EventType property of the Event Grid Event.	JsonFieldWithDefault
id	The mapping information for the Id property of the Event Grid Event.	JsonField
subject	The mapping information for the Subject property of the Event Grid Event.	JsonFieldWithDefault
topic	The mapping information for the Topic property of the Event Grid Event.	JsonField

Microsoft.EventGrid/domains

Name	Description	Value
location	Location of the resource.	string (required)
name	The resource name	string (required)
properties	Properties of the domain.	DomainProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

TrackedResourceTags

Name	Description	Value

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module	Description
Event Grid Domain	AVM Resource Module for Event Grid Domain

ARM template resource definition

The domains resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.EventGrid/domains resource, add the following JSON to your template.

{
  "type": "Microsoft.EventGrid/domains",
  "apiVersion": "2020-06-01",
  "name": "string",
  "location": "string",
  "properties": {
    "inboundIpRules": [
      {
        "action": "string",
        "ipMask": "string"
      }
    ],
    "inputSchema": "string",
    "inputSchemaMapping": {
      "inputSchemaMappingType": "string"
      // For remaining properties, see InputSchemaMapping objects
    },
    "publicNetworkAccess": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

InputSchemaMapping objects

Set the inputSchemaMappingType property to specify the type of object.

For Json, use:

{
  "inputSchemaMappingType": "Json",
  "properties": {
    "dataVersion": {
      "defaultValue": "string",
      "sourceField": "string"
    },
    "eventTime": {
      "sourceField": "string"
    },
    "eventType": {
      "defaultValue": "string",
      "sourceField": "string"
    },
    "id": {
      "sourceField": "string"
    },
    "subject": {
      "defaultValue": "string",
      "sourceField": "string"
    },
    "topic": {
      "sourceField": "string"
    }
  }
}

Property Values

DomainProperties

Name	Description	Value
inboundIpRules	This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.	InboundIpRule[]
inputSchema	This determines the format that Event Grid should expect for incoming events published to the domain.	'CloudEventSchemaV1_0' 'CustomEventSchema' 'EventGridSchema'
inputSchemaMapping	Information about the InputSchemaMapping which specified the info about mapping event payload.	InputSchemaMapping
publicNetworkAccess	This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" />	'Disabled' 'Enabled'

InboundIpRule

Name	Description	Value
action	Action to perform based on the match or no match of the IpMask.	'Allow'
ipMask	IP Address in CIDR notation e.g., 10.0.0.0/8.	string

InputSchemaMapping

Name	Description	Value
inputSchemaMappingType	Set to 'Json' for type JsonInputSchemaMapping.	'Json' (required)

JsonField

Name	Description	Value
sourceField	Name of a field in the input event schema that's to be used as the source of a mapping.	string

JsonFieldWithDefault

Name	Description	Value
defaultValue	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.	string
sourceField	Name of a field in the input event schema that's to be used as the source of a mapping.	string

JsonInputSchemaMapping

Name	Description	Value
inputSchemaMappingType	Type of the custom mapping	'Json' (required)
properties	JSON Properties of the input schema mapping	JsonInputSchemaMappingProperties

JsonInputSchemaMappingProperties

Name	Description	Value
dataVersion	The mapping information for the DataVersion property of the Event Grid Event.	JsonFieldWithDefault
eventTime	The mapping information for the EventTime property of the Event Grid Event.	JsonField
eventType	The mapping information for the EventType property of the Event Grid Event.	JsonFieldWithDefault
id	The mapping information for the Id property of the Event Grid Event.	JsonField
subject	The mapping information for the Subject property of the Event Grid Event.	JsonFieldWithDefault
topic	The mapping information for the Topic property of the Event Grid Event.	JsonField

Microsoft.EventGrid/domains

Name	Description	Value
apiVersion	The api version	'2020-06-01'
location	Location of the resource.	string (required)
name	The resource name	string (required)
properties	Properties of the domain.	DomainProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.EventGrid/domains'

TrackedResourceTags

Name	Description	Value

Usage Examples

Terraform (AzAPI provider) resource definition

The domains resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.EventGrid/domains resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/domains@2020-06-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      inboundIpRules = [
        {
          action = "string"
          ipMask = "string"
        }
      ]
      inputSchema = "string"
      inputSchemaMapping = {
        inputSchemaMappingType = "string"
        // For remaining properties, see InputSchemaMapping objects
      }
      publicNetworkAccess = "string"
    }
  })
}

InputSchemaMapping objects

Set the inputSchemaMappingType property to specify the type of object.

For Json, use:

{
  inputSchemaMappingType = "Json"
  properties = {
    dataVersion = {
      defaultValue = "string"
      sourceField = "string"
    }
    eventTime = {
      sourceField = "string"
    }
    eventType = {
      defaultValue = "string"
      sourceField = "string"
    }
    id = {
      sourceField = "string"
    }
    subject = {
      defaultValue = "string"
      sourceField = "string"
    }
    topic = {
      sourceField = "string"
    }
  }
}

Property Values

DomainProperties

Name	Description	Value
inboundIpRules	This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.	InboundIpRule[]
inputSchema	This determines the format that Event Grid should expect for incoming events published to the domain.	'CloudEventSchemaV1_0' 'CustomEventSchema' 'EventGridSchema'
inputSchemaMapping	Information about the InputSchemaMapping which specified the info about mapping event payload.	InputSchemaMapping
publicNetworkAccess	This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" />	'Disabled' 'Enabled'

InboundIpRule

Name	Description	Value
action	Action to perform based on the match or no match of the IpMask.	'Allow'
ipMask	IP Address in CIDR notation e.g., 10.0.0.0/8.	string

InputSchemaMapping

Name	Description	Value
inputSchemaMappingType	Set to 'Json' for type JsonInputSchemaMapping.	'Json' (required)

JsonField

Name	Description	Value
sourceField	Name of a field in the input event schema that's to be used as the source of a mapping.	string

JsonFieldWithDefault

Name	Description	Value
defaultValue	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.	string
sourceField	Name of a field in the input event schema that's to be used as the source of a mapping.	string

JsonInputSchemaMapping

Name	Description	Value
inputSchemaMappingType	Type of the custom mapping	'Json' (required)
properties	JSON Properties of the input schema mapping	JsonInputSchemaMappingProperties

JsonInputSchemaMappingProperties

Name	Description	Value
dataVersion	The mapping information for the DataVersion property of the Event Grid Event.	JsonFieldWithDefault
eventTime	The mapping information for the EventTime property of the Event Grid Event.	JsonField
eventType	The mapping information for the EventType property of the Event Grid Event.	JsonFieldWithDefault
id	The mapping information for the Id property of the Event Grid Event.	JsonField
subject	The mapping information for the Subject property of the Event Grid Event.	JsonFieldWithDefault
topic	The mapping information for the Topic property of the Event Grid Event.	JsonField

Microsoft.EventGrid/domains

Name	Description	Value
location	Location of the resource.	string (required)
name	The resource name	string (required)
properties	Properties of the domain.	DomainProperties
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.EventGrid/domains@2020-06-01"

TrackedResourceTags

Name	Description	Value

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module	Description
Event Grid Domain	AVM Resource Module for Event Grid Domain