kafka_connector_topic_maps

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

Overview

Name	kafka_connector_topic_maps
Type	Resource
Id	azure.iot_mq.kafka_connector_topic_maps

Fields

vw_kafka_connector_topic_maps

Name	Datatype	Description
batching	text	field from the properties object
compression	text	field from the properties object
copy_mqtt_properties	text	field from the properties object
extended_location	text	field from the properties object
kafkaConnectorName	text	field from the properties object
kafka_connector_ref	text	field from the properties object
location	text	The geo-location where the resource lives
mqName	text	field from the properties object
partition_key_property	text	field from the properties object
partition_strategy	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
routes	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
topicMapName	text	field from the properties object

kafka_connector_topic_maps

Name	Datatype	Description
extendedLocation	object	ExtendedLocation properties
location	string	The geo-location where the resource lives
properties	object	KafkaTopicMap Properties
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	kafkaConnectorName, mqName, resourceGroupName, subscriptionId, topicMapName	Get a KafkaTopicMapResource
list_by_kafka_connector_resource	SELECT	kafkaConnectorName, mqName, resourceGroupName, subscriptionId	List KafkaTopicMapResource resources by KafkaConnectorResource
create_or_update	INSERT	kafkaConnectorName, mqName, resourceGroupName, subscriptionId, topicMapName, data__extendedLocation	Create a KafkaTopicMapResource
delete	DELETE	kafkaConnectorName, mqName, resourceGroupName, subscriptionId, topicMapName	Delete a KafkaTopicMapResource
update	UPDATE	kafkaConnectorName, mqName, resourceGroupName, subscriptionId, topicMapName	Update a KafkaTopicMapResource

SELECT examples

List KafkaTopicMapResource resources by KafkaConnectorResource

vw_kafka_connector_topic_maps

SELECT
batching,
compression,
copy_mqtt_properties,
extended_location,
kafkaConnectorName,
kafka_connector_ref,
location,
mqName,
partition_key_property,
partition_strategy,
provisioning_state,
resourceGroupName,
routes,
subscriptionId,
tags,
topicMapName
FROM azure.iot_mq.vw_kafka_connector_topic_maps
WHERE kafkaConnectorName = '{{ kafkaConnectorName }}'
AND mqName = '{{ mqName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

kafka_connector_topic_maps

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.iot_mq.kafka_connector_topic_maps
WHERE kafkaConnectorName = '{{ kafkaConnectorName }}'
AND mqName = '{{ mqName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.iot_mq.kafka_connector_topic_maps (
kafkaConnectorName,
mqName,
resourceGroupName,
subscriptionId,
topicMapName,
data__extendedLocation,
properties,
extendedLocation,
tags,
location
)
SELECT 
'{{ kafkaConnectorName }}',
'{{ mqName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ topicMapName }}',
'{{ data__extendedLocation }}',
'{{ properties }}',
'{{ extendedLocation }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: batching
          value:
            - name: enabled
              value: boolean
            - name: latencyMs
              value: integer
            - name: maxBytes
              value: integer
            - name: maxMessages
              value: integer
        - name: compression
          value: string
        - name: copyMqttProperties
          value: string
        - name: kafkaConnectorRef
          value: string
        - name: partitionKeyProperty
          value: string
        - name: partitionStrategy
          value: string
        - name: routes
          value:
            - - name: kafkaToMqtt
                value:
                  - name: consumerGroupId
                    value: string
                  - name: kafkaTopic
                    value: string
                  - name: mqttTopic
                    value: string
                  - name: name
                    value: string
                  - name: qos
                    value: integer
              - name: mqttToKafka
                value:
                  - name: kafkaAcks
                    value: []
                  - name: kafkaTopic
                    value: string
                  - name: mqttTopic
                    value: string
                  - name: name
                    value: string
                  - name: qos
                    value: integer
                  - name: sharedSubscription
                    value:
                      - name: groupMinimumShareNumber
                        value: integer
                      - name: groupName
                        value: string
        - name: provisioningState
          value: []
    - name: extendedLocation
      value:
        - name: name
          value: string
        - name: type
          value: []
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a kafka_connector_topic_maps resource.

/*+ update */
UPDATE azure.iot_mq.kafka_connector_topic_maps
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
kafkaConnectorName = '{{ kafkaConnectorName }}'
AND mqName = '{{ mqName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND topicMapName = '{{ topicMapName }}';

DELETE example

Deletes the specified kafka_connector_topic_maps resource.

/*+ delete */
DELETE FROM azure.iot_mq.kafka_connector_topic_maps
WHERE kafkaConnectorName = '{{ kafkaConnectorName }}'
AND mqName = '{{ mqName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND topicMapName = '{{ topicMapName }}';