cluster

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

Overview

Name	cluster
Type	Resource
Id	azure_isv.confluent.cluster

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_or_update	insert	resource_group_name, organization_name, environment_id, cluster_id, subscription_id		Create confluent clusters.
create_or_update	replace	resource_group_name, organization_name, environment_id, cluster_id, subscription_id		Create confluent clusters.
delete	delete	resource_group_name, organization_name, environment_id, cluster_id, subscription_id		Delete confluent cluster by id.

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.
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

INSERT examples

create_or_update

Create confluent clusters.

INSERT INTO azure_isv.confluent.cluster (
kind,
properties,
resource_group_name,
organization_name,
environment_id,
cluster_id,
subscription_id
)
SELECT 
'{{ kind }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ organization_name }}',
'{{ environment_id }}',
'{{ cluster_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
kind,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: cluster
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the cluster resource.
  - name: organization_name
    value: "{{ organization_name }}"
    description: Required parameter for the cluster resource.
  - name: environment_id
    value: "{{ environment_id }}"
    description: Required parameter for the cluster resource.
  - name: cluster_id
    value: "{{ cluster_id }}"
    description: Required parameter for the cluster resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the cluster resource.
  - name: kind
    value: "{{ kind }}"
    description: |
      Type of cluster.
  - name: properties
    description: |
      Cluster Properties.
    value:
      metadata:
        self: "{{ self }}"
        resourceName: "{{ resourceName }}"
        createdTimestamp: "{{ createdTimestamp }}"
        updatedTimestamp: "{{ updatedTimestamp }}"
        deletedTimestamp: "{{ deletedTimestamp }}"
      spec:
        name: "{{ name }}"
        availability: "{{ availability }}"
        cloud: "{{ cloud }}"
        zone: "{{ zone }}"
        package: "{{ package }}"
        region: "{{ region }}"
        kafkaBootstrapEndpoint: "{{ kafkaBootstrapEndpoint }}"
        httpEndpoint: "{{ httpEndpoint }}"
        apiEndpoint: "{{ apiEndpoint }}"
        config:
          kind: "{{ kind }}"
        environment:
          id: "{{ id }}"
          environment: "{{ environment }}"
          related: "{{ related }}"
          resourceName: "{{ resourceName }}"
        network:
          id: "{{ id }}"
          environment: "{{ environment }}"
          related: "{{ related }}"
          resourceName: "{{ resourceName }}"
        byok:
          id: "{{ id }}"
          related: "{{ related }}"
          resourceName: "{{ resourceName }}"
      status:
        phase: "{{ phase }}"
        cku: {{ cku }}

REPLACE examples

create_or_update

Create confluent clusters.

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

DELETE examples

delete

Delete confluent cluster by id.

DELETE FROM azure_isv.confluent.cluster
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
;