kafka_connectors

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

Overview

Name	kafka_connectors
Type	Resource
Id	azure.iot_mq.kafka_connectors

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_mq_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		Get a KafkaConnectorResource
list_by_mq_resource	select	subscriptionId, resourceGroupName, mqName		List KafkaConnectorResource resources by MqResource
create_or_update	insert	subscriptionId, resourceGroupName, mqName, kafkaConnectorName, data__extendedLocation		Create a KafkaConnectorResource
update	update	subscriptionId, resourceGroupName, mqName, kafkaConnectorName		Update a KafkaConnectorResource
delete	delete	subscriptionId, resourceGroupName, mqName, kafkaConnectorName		Delete a KafkaConnectorResource

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.

SELECT examples

get

Get a KafkaConnectorResource

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

list_by_mq_resource

List KafkaConnectorResource resources by MqResource

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

INSERT examples

create_or_update

Create a KafkaConnectorResource

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

Manifest

# Description fields are for documentation purposes
- name: kafka_connectors
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the kafka_connectors resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the kafka_connectors resource.
    - name: mqName
      value: string
      description: Required parameter for the kafka_connectors resource.
    - name: kafkaConnectorName
      value: string
      description: Required parameter for the kafka_connectors 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 KafkaConnectorResource

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

DELETE examples

delete

Delete a KafkaConnectorResource

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