Share via

Microsoft.EventGrid topics 2019-02-01-preview

  • Article

Bicep resource definition

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

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

Resource format

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

resource symbolicname 'Microsoft.EventGrid/topics@2019-02-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    inputSchema: 'string'
    inputSchemaMapping: {
      inputSchemaMappingType: 'string'
      // For remaining properties, see InputSchemaMapping objects
    }
  }
  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

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/topics

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

TopicProperties

Name Description Value
inputSchema This determines the format that Event Grid should expect for incoming events published to the topic. 'CloudEventV01Schema'
'CustomEventSchema'
'EventGridSchema'
inputSchemaMapping This enables publishing using custom event schemas. An InputSchemaMapping can be specified to map various properties of a source schema to various required properties of the EventGridEvent schema. InputSchemaMapping

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 Topic AVM Resource Module for Event Grid Topic

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File Description
Create Azure Event Grid Custom Topic and Queue Subscription Creates an Azure Event Grid custom topic and a service bus queue subscription. Template originally authored by Markus Meyer.
Create Azure Event Grid Custom Topic and Subscription Creates an Azure Event Grid custom topic and a webhook subscription. Template originally authored by John Downs.

ARM template resource definition

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

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

Resource format

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

{
  "type": "Microsoft.EventGrid/topics",
  "apiVersion": "2019-02-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "inputSchema": "string",
    "inputSchemaMapping": {
      "inputSchemaMappingType": "string"
      // For remaining properties, see InputSchemaMapping objects
    }
  },
  "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

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/topics

Name Description Value
apiVersion The api version '2019-02-01-preview'
location Location of the resource string (required)
name The resource name string (required)
properties Properties of the topic TopicProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.EventGrid/topics'

TopicProperties

Name Description Value
inputSchema This determines the format that Event Grid should expect for incoming events published to the topic. 'CloudEventV01Schema'
'CustomEventSchema'
'EventGridSchema'
inputSchemaMapping This enables publishing using custom event schemas. An InputSchemaMapping can be specified to map various properties of a source schema to various required properties of the EventGridEvent schema. InputSchemaMapping

TrackedResourceTags

Name Description Value

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template Description
Create Azure Event Grid Custom Topic and Queue Subscription

Deploy to Azure		 Creates an Azure Event Grid custom topic and a service bus queue subscription. Template originally authored by Markus Meyer.
Create Azure Event Grid Custom Topic and Subscription

Deploy to Azure		 Creates an Azure Event Grid custom topic and a webhook subscription. Template originally authored by John Downs.
Create Azure Event Grid Custom Topic Subscription

Deploy to Azure		 Creates an Azure Event Grid custom topic and a service bus topic subscription. Template originally authored by Markus Meyer.
Create Event Grid custom topic and event hub handler

Deploy to Azure		 Creates an Azure Event Grid custom topic and event hub to handle the events.
Custom Azure Event Grid Topic/Subscription with CloudEvents

Deploy to Azure		 Creates a custom Azure Event Grid topic, a webhook subscription having CloudEvents schema, and a Logic App as an event handler. Template originally authored by Justin Yoo.

Terraform (AzAPI provider) resource definition

The topics 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/topics resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/topics@2019-02-01-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  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

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/topics

Name Description Value
location Location of the resource string (required)
name The resource name string (required)
properties Properties of the topic TopicProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.EventGrid/topics@2019-02-01-preview"

TopicProperties

Name Description Value
inputSchema This determines the format that Event Grid should expect for incoming events published to the topic. 'CloudEventV01Schema'
'CustomEventSchema'
'EventGridSchema'
inputSchemaMapping This enables publishing using custom event schemas. An InputSchemaMapping can be specified to map various properties of a source schema to various required properties of the EventGridEvent schema. InputSchemaMapping

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 Topic AVM Resource Module for Event Grid Topic