connector

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

Overview

Name	connector
Type	Resource
Id	azure_isv.confluent.connector

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.
connectorBasicInfo	object	Connector Info Base.
connectorServiceTypeInfo	object	Connector Service type info base properties.
partnerConnectorInfo	object	The connection information consumed by applications.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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.
connectorBasicInfo	object	Connector Info Base.
connectorServiceTypeInfo	object	Connector Service type info base properties.
partnerConnectorInfo	object	The connection information consumed by applications.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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, connector_name, subscription_id		Get confluent connector by Name.
list	select	resource_group_name, organization_name, environment_id, cluster_id, subscription_id	pageSize, pageToken	Lists all the connectors in a cluster.
create_or_update	insert	resource_group_name, organization_name, environment_id, cluster_id, connector_name, subscription_id, properties		Create confluent connector by Name.
create_or_update	replace	resource_group_name, organization_name, environment_id, cluster_id, connector_name, subscription_id, properties		Create confluent connector by Name.
delete	delete	resource_group_name, organization_name, environment_id, cluster_id, connector_name, subscription_id		Delete confluent connector 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.
connector_name	string	Confluent connector name. 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
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 connector by Name.

SELECT
id,
name,
connectorBasicInfo,
connectorServiceTypeInfo,
partnerConnectorInfo,
systemData,
type
FROM azure_isv.confluent.connector
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 connector_name = '{{ connector_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all the connectors in a cluster.

SELECT
id,
name,
connectorBasicInfo,
connectorServiceTypeInfo,
partnerConnectorInfo,
systemData,
type
FROM azure_isv.confluent.connector
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_or_update

Create confluent connector by Name.

INSERT INTO azure_isv.confluent.connector (
properties,
resource_group_name,
organization_name,
environment_id,
cluster_id,
connector_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ organization_name }}',
'{{ environment_id }}',
'{{ cluster_id }}',
'{{ connector_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: connector
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the connector resource.
  - name: organization_name
    value: "{{ organization_name }}"
    description: Required parameter for the connector resource.
  - name: environment_id
    value: "{{ environment_id }}"
    description: Required parameter for the connector resource.
  - name: cluster_id
    value: "{{ cluster_id }}"
    description: Required parameter for the connector resource.
  - name: connector_name
    value: "{{ connector_name }}"
    description: Required parameter for the connector resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the connector resource.
  - name: properties
    description: |
      The properties of the Connector. Required.
    value:
      connectorBasicInfo:
        connectorType: "{{ connectorType }}"
        connectorClass: "{{ connectorClass }}"
        connectorName: "{{ connectorName }}"
        connectorId: "{{ connectorId }}"
        connectorState: "{{ connectorState }}"
      connectorServiceTypeInfo:
        connectorServiceType: "{{ connectorServiceType }}"
      partnerConnectorInfo:
        partnerConnectorType: "{{ partnerConnectorType }}"

REPLACE examples

create_or_update

Create confluent connector by Name.

REPLACE azure_isv.confluent.connector
SET 
properties = '{{ properties }}'
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 connector_name = '{{ connector_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete confluent connector by name.

DELETE FROM azure_isv.confluent.connector
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 connector_name = '{{ connector_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;