kafka_configurations

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

Overview

Name	kafka_configurations
Type	Resource
Id	azure.purview.kafka_configurations

Fields

The following fields are returned by SELECT queries:

get

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.

list_by_account

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

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName, kafkaConfigurationName	api-version	Gets the kafka configuration for the account
list_by_account	select	subscriptionId, resourceGroupName, accountName	api-version, $skipToken	Lists the Kafka configurations in the Account
create_or_update	insert	subscriptionId, resourceGroupName, accountName, kafkaConfigurationName	api-version	Create or update Kafka Configuration
delete	delete	subscriptionId, resourceGroupName, accountName, kafkaConfigurationName	api-version	Deletes a KafkaConfiguration resource.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
accountName	string	The name of the account.
kafkaConfigurationName	string	Name of kafka configuration.
resourceGroupName	string	The resource group name.
subscriptionId	string	The subscription identifier
$skipToken	string	The skip token.
api-version	string	The api version to use.

SELECT examples

get

Gets the kafka configuration for the account

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

list_by_account

Lists the Kafka configurations in the Account

SELECT
id,
name,
properties,
systemData,
type
FROM azure.purview.kafka_configurations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND api-version = '{{ api-version }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Create or update Kafka Configuration

INSERT INTO azure.purview.kafka_configurations (
data__properties,
subscriptionId,
resourceGroupName,
accountName,
kafkaConfigurationName,
api-version
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ kafkaConfigurationName }}',
'{{ api-version }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: kafka_configurations
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the kafka_configurations resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the kafka_configurations resource.
    - name: accountName
      value: string
      description: Required parameter for the kafka_configurations resource.
    - name: kafkaConfigurationName
      value: string
      description: Required parameter for the kafka_configurations resource.
    - name: properties
      value: object
      description: |
        The kafka configuration properties of the event streaming service attached to the Purview account for kafka notifications.
    - name: api-version
      value: string
      description: The api version to use.

DELETE examples

delete

Deletes a KafkaConfiguration resource.

DELETE FROM azure.purview.kafka_configurations
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND kafkaConfigurationName = '{{ kafkaConfigurationName }}' --required
AND api-version = '{{ api-version }}'
;