Microsoft.EventGrid domains 2020-01-01-preview

Article
01/14/2024

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-01-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    inputSchema: 'string'
    inputSchemaMapping: {
      inputSchemaMappingType: 'string'
      // For remaining properties, see InputSchemaMapping objects
    }
  }
}

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

domains

Name	Description	Value
name	The resource name	string (required) Character limit: 3-50 Valid characters: Alphanumerics and hyphens.
location	Location of the resource	string (required)
tags	Tags of the resource	Dictionary of tag names and values. See Tags in templates
properties	Properties of the domain	DomainProperties

DomainProperties

Name	Description	Value
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

InputSchemaMapping

Name	Description	Value
inputSchemaMappingType	Set the object type	Json (required)

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

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

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

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-01-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "inputSchema": "string",
    "inputSchemaMapping": {
      "inputSchemaMappingType": "string"
      // For remaining properties, see InputSchemaMapping objects
    }
  }
}

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

domains

Name	Description	Value
type	The resource type	'Microsoft.EventGrid/domains'
apiVersion	The resource api version	'2020-01-01-preview'
name	The resource name	string (required) Character limit: 3-50 Valid characters: Alphanumerics and hyphens.
location	Location of the resource	string (required)
tags	Tags of the resource	Dictionary of tag names and values. See Tags in templates
properties	Properties of the domain	DomainProperties

DomainProperties

Name	Description	Value
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

InputSchemaMapping

Name	Description	Value
inputSchemaMappingType	Set the object type	Json (required)

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

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

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

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-01-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      inputSchema = "string"
      inputSchemaMapping = {
        inputSchemaMappingType = "string"
        // For remaining properties, see InputSchemaMapping objects
      }
    }
  })
}

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

domains

Name	Description	Value
type	The resource type	"Microsoft.EventGrid/domains@2020-01-01-preview"
name	The resource name	string (required) Character limit: 3-50 Valid characters: Alphanumerics and hyphens.
location	Location of the resource	string (required)
parent_id	To deploy to a resource group, use the ID of that resource group.	string (required)
tags	Tags of the resource	Dictionary of tag names and values.
properties	Properties of the domain	DomainProperties

DomainProperties

Name	Description	Value
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

InputSchemaMapping

Name	Description	Value
inputSchemaMappingType	Set the object type	Json (required)

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

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

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

Share via

Microsoft.EventGrid domains 2020-01-01-preview

Bicep resource definition

Resource format

InputSchemaMapping objects

Property values

domains

DomainProperties

InputSchemaMapping

JsonInputSchemaMapping

JsonInputSchemaMappingProperties

JsonFieldWithDefault

JsonField

ARM template resource definition

Resource format

InputSchemaMapping objects

Property values

domains

DomainProperties

InputSchemaMapping

JsonInputSchemaMapping

JsonInputSchemaMappingProperties

JsonFieldWithDefault

JsonField

Terraform (AzAPI provider) resource definition

Resource format

InputSchemaMapping objects

Property values

domains

DomainProperties

InputSchemaMapping

JsonInputSchemaMapping

JsonInputSchemaMappingProperties

JsonFieldWithDefault

JsonField

Feedback

Additional resources