kafka_configurations

Creates, updates, deletes, gets or lists a kafka_configurations resource.

Overview

Name	kafka_configurations
Type	Resource
Id	azure.purview.kafka_configurations

Fields

vw_kafka_configurations

Name	Datatype	Description
id	text	Gets or sets the identifier.
name	text	Gets or sets the name.
accountName	text	field from the properties object
consumer_group	text	field from the properties object
credentials	text	field from the properties object
event_hub_partition_id	text	field from the properties object
event_hub_resource_id	text	field from the properties object
event_hub_type	text	field from the properties object
event_streaming_state	text	field from the properties object
event_streaming_type	text	field from the properties object
kafkaConfigurationName	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
type	text	Gets or sets the type.

kafka_configurations

Name	Datatype	Description
id	string	Gets or sets the identifier.
name	string	Gets or sets the name.
properties	object	The kafka configuration properties of the event streaming service attached to the Purview account for kafka notifications.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	Gets or sets the type.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	accountName, kafkaConfigurationName, resourceGroupName, subscriptionId	Gets the kafka configuration for the account
list_by_account	SELECT	accountName, resourceGroupName, subscriptionId	Lists the Kafka configurations in the Account
create_or_update	INSERT	accountName, kafkaConfigurationName, resourceGroupName, subscriptionId	Create or update Kafka Configuration
delete	DELETE	accountName, kafkaConfigurationName, resourceGroupName, subscriptionId	Deletes a KafkaConfiguration resource.

SELECT examples

Lists the Kafka configurations in the Account

vw_kafka_configurations

SELECT
id,
name,
accountName,
consumer_group,
credentials,
event_hub_partition_id,
event_hub_resource_id,
event_hub_type,
event_streaming_state,
event_streaming_type,
kafkaConfigurationName,
resourceGroupName,
subscriptionId,
system_data,
type
FROM azure.purview.vw_kafka_configurations
WHERE accountName = '{{ accountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

kafka_configurations

SELECT
id,
name,
properties,
systemData,
type
FROM azure.purview.kafka_configurations
WHERE accountName = '{{ accountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new kafka_configurations resource.

All Properties

/*+ create */
INSERT INTO azure.purview.kafka_configurations (
accountName,
kafkaConfigurationName,
resourceGroupName,
subscriptionId,
properties
)
SELECT 
'{{ accountName }}',
'{{ kafkaConfigurationName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: systemData
      value: string
    - name: type
      value: string
    - name: properties
      value:
        - name: consumerGroup
          value: string
        - name: credentials
          value:
            - name: identityId
              value: string
            - name: type
              value: string
        - name: eventHubPartitionId
          value: string
        - name: eventHubResourceId
          value: string
        - name: eventHubType
          value: string
        - name: eventStreamingState
          value: string
        - name: eventStreamingType
          value: string

DELETE example

Deletes the specified kafka_configurations resource.

/*+ delete */
DELETE FROM azure.purview.kafka_configurations
WHERE accountName = '{{ accountName }}'
AND kafkaConfigurationName = '{{ kafkaConfigurationName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';