topics

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

Overview

Name	topics
Type	Resource
Id	azure_isv.confluent.topics

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
configs	object	Config Specification of the topic.
inputConfigs	array	Input Config Specification of the topic.
kind	string	Type of topic.
metadata	object	Metadata of the record.
partitions	object	Partition Specification of the topic.
partitionsCount	string	Partition count of the topic.
partitionsReassignments	object	Partition Reassignment Specification of the topic.
replicationFactor	string	Replication factor of the topic.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
topicId	string	Topic Id returned by Confluent.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
configs	object	Config Specification of the topic.
inputConfigs	array	Input Config Specification of the topic.
kind	string	Type of topic.
metadata	object	Metadata of the record.
partitions	object	Partition Specification of the topic.
partitionsCount	string	Partition count of the topic.
partitionsReassignments	object	Partition Reassignment Specification of the topic.
replicationFactor	string	Replication factor of the topic.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
topicId	string	Topic Id returned by Confluent.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, organization_name, environment_id, cluster_id, topic_name, subscription_id		Get confluent topic by Name.
list	select	resource_group_name, organization_name, environment_id, cluster_id, subscription_id	pageSize, pageToken	Lists of all the topics in a clusters.
create	insert	resource_group_name, organization_name, environment_id, cluster_id, topic_name, subscription_id		Create confluent topics by Name.
delete	delete	resource_group_name, organization_name, environment_id, cluster_id, topic_name, subscription_id		Delete confluent topic by name.

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
cluster_id	string	Confluent kafka or schema registry cluster id. Required.
environment_id	string	Confluent environment id. Required.
organization_name	string	Organization resource name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
topic_name	string	Confluent kafka or schema registry topic name. Required.
pageSize	integer	Pagination size. Default value is None.
pageToken	string	An opaque pagination token to fetch the next set of records. Default value is None.

SELECT examples

get

Get confluent topic by Name.

SELECT
id,
name,
configs,
inputConfigs,
kind,
metadata,
partitions,
partitionsCount,
partitionsReassignments,
replicationFactor,
systemData,
topicId,
type
FROM azure_isv.confluent.topics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND environment_id = '{{ environment_id }}' -- required
AND cluster_id = '{{ cluster_id }}' -- required
AND topic_name = '{{ topic_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists of all the topics in a clusters.

SELECT
id,
name,
configs,
inputConfigs,
kind,
metadata,
partitions,
partitionsCount,
partitionsReassignments,
replicationFactor,
systemData,
topicId,
type
FROM azure_isv.confluent.topics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND environment_id = '{{ environment_id }}' -- required
AND cluster_id = '{{ cluster_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

Create confluent topics by Name.

INSERT INTO azure_isv.confluent.topics (
properties,
resource_group_name,
organization_name,
environment_id,
cluster_id,
topic_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ organization_name }}',
'{{ environment_id }}',
'{{ cluster_id }}',
'{{ topic_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: topics
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the topics resource.
  - name: organization_name
    value: "{{ organization_name }}"
    description: Required parameter for the topics resource.
  - name: environment_id
    value: "{{ environment_id }}"
    description: Required parameter for the topics resource.
  - name: cluster_id
    value: "{{ cluster_id }}"
    description: Required parameter for the topics resource.
  - name: topic_name
    value: "{{ topic_name }}"
    description: Required parameter for the topics resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the topics resource.
  - name: properties
    description: |
      Topic Properties.
    value:
      kind: "{{ kind }}"
      topicId: "{{ topicId }}"
      metadata:
        self: "{{ self }}"
        resourceName: "{{ resourceName }}"
      partitions:
        related: "{{ related }}"
      configs:
        related: "{{ related }}"
      inputConfigs:
        - name: "{{ name }}"
          value: "{{ value }}"
      partitionsReassignments:
        related: "{{ related }}"
      partitionsCount: "{{ partitionsCount }}"
      replicationFactor: "{{ replicationFactor }}"

DELETE examples

delete

Delete confluent topic by name.

DELETE FROM azure_isv.confluent.topics
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND organization_name = '{{ organization_name }}' --required
AND environment_id = '{{ environment_id }}' --required
AND cluster_id = '{{ cluster_id }}' --required
AND topic_name = '{{ topic_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;