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

vw_kafka_connectors

Name	Datatype	Description
client_id_prefix	text	field from the properties object
extended_location	text	field from the properties object
image	text	field from the properties object
instances	text	field from the properties object
kafkaConnectorName	text	field from the properties object
kafka_connection	text	field from the properties object
local_broker_connection	text	field from the properties object
location	text	The geo-location where the resource lives
log_level	text	field from the properties object
mqName	text	field from the properties object
node_tolerations	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.

kafka_connectors

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

Methods

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

SELECT examples

List KafkaConnectorResource resources by MqResource

vw_kafka_connectors

SELECT
client_id_prefix,
extended_location,
image,
instances,
kafkaConnectorName,
kafka_connection,
local_broker_connection,
location,
log_level,
mqName,
node_tolerations,
provisioning_state,
resourceGroupName,
subscriptionId,
tags
FROM azure.iot_mq.vw_kafka_connectors
WHERE mqName = '{{ mqName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

kafka_connectors

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

INSERT example

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

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: clientIdPrefix
          value: string
        - name: image
          value:
            - name: pullPolicy
              value: string
            - name: pullSecrets
              value: string
            - name: repository
              value: string
            - name: tag
              value: string
        - name: instances
          value: integer
        - name: kafkaConnection
          value:
            - name: authentication
              value:
                - name: authType
                  value:
                    - name: sasl
                      value:
                        - name: saslType
                          value: []
                        - name: token
                          value:
                            - name: keyVault
                              value:
                                - name: username
                                  value: string
                                - name: vault
                                  value:
                                    - name: credentials
                                      value:
                                        - name: servicePrincipalLocalSecretName
                                          value: string
                                    - name: directoryId
                                      value: string
                                    - name: name
                                      value: string
                                - name: vaultSecret
                                  value:
                                    - name: name
                                      value: string
                                    - name: version
                                      value: string
                            - name: secretName
                              value: string
                    - name: systemAssignedManagedIdentity
                      value:
                        - name: audience
                          value: string
                        - name: extensionName
                          value: string
                    - name: x509
                      value:
                        - name: keyVault
                          value: []
                        - name: secretName
                          value: string
                - name: enabled
                  value: boolean
            - name: endpoint
              value: string
            - name: tls
              value:
                - name: tlsEnabled
                  value: boolean
                - name: trustedCaCertificateConfigMap
                  value: string
        - name: localBrokerConnection
          value:
            - name: authentication
              value:
                - name: kubernetes
                  value:
                    - name: secretPath
                      value: string
                    - name: serviceAccountTokenName
                      value: string
            - name: endpoint
              value: string
            - name: tls
              value:
                - name: tlsEnabled
                  value: boolean
                - name: trustedCaCertificateConfigMap
                  value: string
        - name: logLevel
          value: string
        - name: nodeTolerations
          value:
            - name: effect
              value: string
            - name: key
              value: string
            - name: operator
              value: string
            - name: value
              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_connectors resource.

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

DELETE example

Deletes the specified kafka_connectors resource.

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