Microsoft.Purview accounts/kafkaConfigurations

ARM template resource definition

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

{
  "type": "Microsoft.Purview/accounts/kafkaConfigurations",
  "apiVersion": "2021-12-01",
  "name": "string",
  "properties": {
    "consumerGroup": "string",
    "credentials": {
      "identityId": "string",
      "type": "string"
    },
    "eventHubPartitionId": "string",
    "eventHubResourceId": "string",
    "eventHubType": "string",
    "eventStreamingState": "string",
    "eventStreamingType": "string"
  }
}

Property values

accounts/kafkaConfigurations

Name Description Value
type The resource type 'Microsoft.Purview/accounts/kafkaConfigurations'
apiVersion The resource api version '2021-12-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
properties Gets or sets the kafka configuration properties. KafkaConfigurationProperties

KafkaConfigurationProperties

Name Description Value
consumerGroup Consumer group for hook event hub. string
credentials Credentials to access event hub. Credentials
eventHubPartitionId Optional partition Id for notification event hub. If not set, all partitions will be leveraged. string
eventHubResourceId string
eventHubType The event hub type. 'Hook'
'Notification'
eventStreamingState The state of the event streaming service 'Disabled'
'Enabled'
eventStreamingType The event streaming service type 'Azure'
'Managed'
'None'

Credentials

Name Description Value
identityId Identity identifier for UserAssign type. string
type Identity Type. 'None'
'SystemAssigned'
'UserAssigned'