Share via

Microsoft.EventGrid namespaces/topics 2023-06-01-preview

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.EventGrid/namespaces/topics@2023-06-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    eventRetentionInDays: int
    inputSchema: 'string'
    publisherType: 'string'
  }
}

Property Values

Microsoft.EventGrid/namespaces/topics

Name Description Value
name The resource name string

Constraints:
Min length = 3
Max length = 50
Pattern = ^[a-zA-Z0-9-]*$ (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: namespaces
properties Properties of the namespace topic. NamespaceTopicProperties

NamespaceTopicProperties

Name Description Value
eventRetentionInDays Event retention for the namespace topic expressed in days. The property default value is 1 day.
Min event retention duration value is 1 day and max event retention duration value is 1 day.		 int
inputSchema This determines the format that is expected for incoming events published to the topic. 'CloudEventSchemaV1_0'
publisherType Publisher type of the namespace topic. 'Custom'

ARM template resource definition

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

{
  "type": "Microsoft.EventGrid/namespaces/topics",
  "apiVersion": "2023-06-01-preview",
  "name": "string",
  "properties": {
    "eventRetentionInDays": "int",
    "inputSchema": "string",
    "publisherType": "string"
  }
}

Property Values

Microsoft.EventGrid/namespaces/topics

Name Description Value
apiVersion The api version '2023-06-01-preview'
name The resource name string

Constraints:
Min length = 3
Max length = 50
Pattern = ^[a-zA-Z0-9-]*$ (required)
properties Properties of the namespace topic. NamespaceTopicProperties
type The resource type 'Microsoft.EventGrid/namespaces/topics'

NamespaceTopicProperties

Name Description Value
eventRetentionInDays Event retention for the namespace topic expressed in days. The property default value is 1 day.
Min event retention duration value is 1 day and max event retention duration value is 1 day.		 int
inputSchema This determines the format that is expected for incoming events published to the topic. 'CloudEventSchemaV1_0'
publisherType Publisher type of the namespace topic. 'Custom'

Usage Examples

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/namespaces/topics@2023-06-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      eventRetentionInDays = int
      inputSchema = "string"
      publisherType = "string"
    }
  })
}

Property Values

Microsoft.EventGrid/namespaces/topics

Name Description Value
name The resource name string

Constraints:
Min length = 3
Max length = 50
Pattern = ^[a-zA-Z0-9-]*$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: namespaces
properties Properties of the namespace topic. NamespaceTopicProperties
type The resource type "Microsoft.EventGrid/namespaces/topics@2023-06-01-preview"

NamespaceTopicProperties

Name Description Value
eventRetentionInDays Event retention for the namespace topic expressed in days. The property default value is 1 day.
Min event retention duration value is 1 day and max event retention duration value is 1 day.		 int
inputSchema This determines the format that is expected for incoming events published to the topic. 'CloudEventSchemaV1_0'
publisherType Publisher type of the namespace topic. 'Custom'