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

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
extendedLocation	object	Extended Location
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_kafka_connector_resource

Azure operation completed successfully.

Name	Datatype	Description
extendedLocation	object	Extended Location
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, mqName, kafkaConnectorName, topicMapName		Get a KafkaTopicMapResource
list_by_kafka_connector_resource	select	subscriptionId, resourceGroupName, mqName, kafkaConnectorName		List KafkaTopicMapResource resources by KafkaConnectorResource
create_or_update	insert	subscriptionId, resourceGroupName, mqName, kafkaConnectorName, topicMapName, data__extendedLocation		Create a KafkaTopicMapResource
update	update	subscriptionId, resourceGroupName, mqName, kafkaConnectorName, topicMapName		Update a KafkaTopicMapResource
delete	delete	subscriptionId, resourceGroupName, mqName, kafkaConnectorName, topicMapName		Delete a KafkaTopicMapResource

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
kafkaConnectorName	string	Name of MQ kafkaConnector resource
mqName	string	Name of MQ resource
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
topicMapName	string	Name of MQ kafka/topicMap resource

SELECT examples

get

Get a KafkaTopicMapResource

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

list_by_kafka_connector_resource

List KafkaTopicMapResource resources by KafkaConnectorResource

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

INSERT examples

create_or_update

Create a KafkaTopicMapResource

INSERT INTO azure.iot_mq.kafka_connector_topic_maps (
data__properties,
data__extendedLocation,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
mqName,
kafkaConnectorName,
topicMapName
)
SELECT 
'{{ properties }}',
'{{ extendedLocation }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ mqName }}',
'{{ kafkaConnectorName }}',
'{{ topicMapName }}'
RETURNING
extendedLocation,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: kafka_connector_topic_maps
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the kafka_connector_topic_maps resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the kafka_connector_topic_maps resource.
    - name: mqName
      value: string
      description: Required parameter for the kafka_connector_topic_maps resource.
    - name: kafkaConnectorName
      value: string
      description: Required parameter for the kafka_connector_topic_maps resource.
    - name: topicMapName
      value: string
      description: Required parameter for the kafka_connector_topic_maps resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.
    - name: extendedLocation
      value: object
      description: |
        Extended Location
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Update a KafkaTopicMapResource

UPDATE azure.iot_mq.kafka_connector_topic_maps
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND mqName = '{{ mqName }}' --required
AND kafkaConnectorName = '{{ kafkaConnectorName }}' --required
AND topicMapName = '{{ topicMapName }}' --required
RETURNING
extendedLocation,
location,
properties,
tags;

DELETE examples

delete

Delete a KafkaTopicMapResource

DELETE FROM azure.iot_mq.kafka_connector_topic_maps
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND mqName = '{{ mqName }}' --required
AND kafkaConnectorName = '{{ kafkaConnectorName }}' --required
AND topicMapName = '{{ topicMapName }}' --required
;