Microsoft.Purview accounts/kafkaConfigurations

Bicep 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 Bicep to your template.

resource symbolicname 'Microsoft.Purview/accounts/kafkaConfigurations@2024-04-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    consumerGroup: 'string'
    credentials: {
      identityId: 'string'
      type: 'string'
    }
    eventHubPartitionId: 'string'
    eventHubResourceId: 'string'
    eventHubType: 'string'
    eventStreamingState: 'string'
    eventStreamingType: 'string'
  }
}

Property Values

Microsoft.Purview/accounts/kafkaConfigurations

Name Description Value
name The resource name string

Constraints:
Min length = 3
Max length = 63
Pattern = ^[A-Za-z0-9]+(?:-[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: accounts
properties The kafka configuration properties of the event streaming service attached to the Purview account for kafka notifications. KafkaConfigurationProperties

Credentials

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

KafkaConfigurationProperties

Name Description Value
consumerGroup Consumer group for hook event hub. string
credentials Credentials to access the event streaming service attached to the purview account. Credentials
eventHubPartitionId Optional partition Id for notification event hub. If not set, all partitions will be leveraged. string
eventHubResourceId A type definition that refers the id to an Azure Resource Manager resource. 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'

ARM template resource definition

The accounts/kafkaConfigurations resource type can be deployed with operations that target:

Usage Examples

Resource format

To create a Microsoft.Purview/accounts/kafkaConfigurations resource, add the following JSON to your template.

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

Property Values

Microsoft.Purview/accounts/kafkaConfigurations

Name Description Value
apiVersion The api version '2024-04-01-preview'
name The resource name string

Constraints:
Min length = 3
Max length = 63
Pattern = ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$ (required)
properties The kafka configuration properties of the event streaming service attached to the Purview account for kafka notifications. KafkaConfigurationProperties
type The resource type 'Microsoft.Purview/accounts/kafkaConfigurations'

Credentials

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

KafkaConfigurationProperties

Name Description Value
consumerGroup Consumer group for hook event hub. string
credentials Credentials to access the event streaming service attached to the purview account. Credentials
eventHubPartitionId Optional partition Id for notification event hub. If not set, all partitions will be leveraged. string
eventHubResourceId A type definition that refers the id to an Azure Resource Manager resource. 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'

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Purview/accounts/kafkaConfigurations@2024-04-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      consumerGroup = "string"
      credentials = {
        identityId = "string"
        type = "string"
      }
      eventHubPartitionId = "string"
      eventHubResourceId = "string"
      eventHubType = "string"
      eventStreamingState = "string"
      eventStreamingType = "string"
    }
  }
}

Property Values

Microsoft.Purview/accounts/kafkaConfigurations

Name Description Value
name The resource name string

Constraints:
Min length = 3
Max length = 63
Pattern = ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: accounts
properties The kafka configuration properties of the event streaming service attached to the Purview account for kafka notifications. KafkaConfigurationProperties
type The resource type "Microsoft.Purview/accounts/kafkaConfigurations@2024-04-01-preview"

Credentials

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

KafkaConfigurationProperties

Name Description Value
consumerGroup Consumer group for hook event hub. string
credentials Credentials to access the event streaming service attached to the purview account. Credentials
eventHubPartitionId Optional partition Id for notification event hub. If not set, all partitions will be leveraged. string
eventHubResourceId A type definition that refers the id to an Azure Resource Manager resource. 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'
  • Last updated on