organization

Creates, updates, deletes, gets or lists an organization resource.

Overview

Name	organization
Type	Resource
Id	azure_isv.confluent.organization

Fields

The following fields are returned by SELECT queries:

get_cluster_by_id

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.
kind	string	Type of cluster.
metadata	object	Metadata of the record.
spec	object	Specification of the cluster.
status	object	Specification of the cluster status.
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_schema_registry_clusters

Name	Datatype	Description
id	string	Id of the cluster.
kind	string	Kind of the cluster.
metadata	object	Metadata of the record.
spec	object	Specification of the schema registry cluster.
status	object	Specification of the cluster status.

get_cluster_api_key

Name	Datatype	Description
id	string	Id of the api key.
kind	string	Type of api key.
metadata	object	Metadata of the record.
spec	object	Specification of the API Key.

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.
createdTime	string (date-time)	The creation time of the resource.
linkOrganization	object	Link an existing Confluent organization.
location	string	The geo-location where the resource lives. Required.
offerDetail	object	Confluent offer detail. Required.
organizationId	string	Id of the Confluent organization.
provisioningState	string	Provision states for confluent RP. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified". (Accepted, Creating, Updating, Deleting, Succeeded, Failed, Canceled, Deleted, NotSpecified)
ssoUrl	string	SSO url for the Confluent organization.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userDetail	object	Subscriber detail. Required.

list_by_resource_group

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.
createdTime	string (date-time)	The creation time of the resource.
linkOrganization	object	Link an existing Confluent organization.
location	string	The geo-location where the resource lives. Required.
offerDetail	object	Confluent offer detail. Required.
organizationId	string	Id of the Confluent organization.
provisioningState	string	Provision states for confluent RP. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified". (Accepted, Creating, Updating, Deleting, Succeeded, Failed, Canceled, Deleted, NotSpecified)
ssoUrl	string	SSO url for the Confluent organization.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userDetail	object	Subscriber detail. Required.

list_by_subscription

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.
createdTime	string (date-time)	The creation time of the resource.
linkOrganization	object	Link an existing Confluent organization.
location	string	The geo-location where the resource lives. Required.
offerDetail	object	Confluent offer detail. Required.
organizationId	string	Id of the Confluent organization.
provisioningState	string	Provision states for confluent RP. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified". (Accepted, Creating, Updating, Deleting, Succeeded, Failed, Canceled, Deleted, NotSpecified)
ssoUrl	string	SSO url for the Confluent organization.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userDetail	object	Subscriber detail. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_cluster_by_id	select	resource_group_name, organization_name, environment_id, cluster_id, subscription_id		Get cluster by Id.
list_schema_registry_clusters	select	resource_group_name, organization_name, environment_id, subscription_id	pageSize, pageToken	Get schema registry clusters.
get_cluster_api_key	select	resource_group_name, organization_name, api_key_id, subscription_id		Get API key details of a kafka or schema registry cluster.
get	select	resource_group_name, organization_name, subscription_id		Get the properties of a specific Organization resource.
list_by_resource_group	select	resource_group_name, subscription_id		List all Organizations under the specified resource group.
list_by_subscription	select	subscription_id		List all organizations under the specified subscription.
create	insert	resource_group_name, organization_name, subscription_id, location, properties		Create Organization resource.
update	update	resource_group_name, organization_name, subscription_id		Update Organization resource.
delete	delete	resource_group_name, organization_name, subscription_id		Delete Organization resource.
get_environment_by_id	exec	resource_group_name, organization_name, environment_id, subscription_id		Get Environment details by environment Id.
list_regions	exec	resource_group_name, organization_name, subscription_id		cloud provider regions available for creating Schema Registry clusters.
list_environments	exec	resource_group_name, organization_name, subscription_id	pageSize, pageToken	Lists of all the environments in a organization.
list_clusters	exec	resource_group_name, organization_name, environment_id, subscription_id	pageSize, pageToken	Lists of all the clusters in a environment.
delete_cluster_api_key	exec	resource_group_name, organization_name, api_key_id, subscription_id		Deletes API key of a kafka or schema registry cluster.
get_schema_registry_cluster_by_id	exec	resource_group_name, organization_name, environment_id, cluster_id, subscription_id		Get schema registry cluster by Id.
create_api_key	exec	resource_group_name, organization_name, environment_id, cluster_id, subscription_id		Creates API key for a schema registry Cluster ID or Kafka Cluster ID under a environment.

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
api_key_id	string	Confluent API Key id. Required.
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
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_cluster_by_id

Get cluster by Id.

SELECT
id,
name,
kind,
metadata,
spec,
status,
systemData,
type
FROM azure_isv.confluent.organization
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
;

list_schema_registry_clusters

Get schema registry clusters.

SELECT
id,
kind,
metadata,
spec,
status
FROM azure_isv.confluent.organization
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND environment_id = '{{ environment_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

get_cluster_api_key

Get API key details of a kafka or schema registry cluster.

SELECT
id,
kind,
metadata,
spec
FROM azure_isv.confluent.organization
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND api_key_id = '{{ api_key_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Get the properties of a specific Organization resource.

SELECT
id,
name,
createdTime,
linkOrganization,
location,
offerDetail,
organizationId,
provisioningState,
ssoUrl,
systemData,
tags,
type,
userDetail
FROM azure_isv.confluent.organization
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List all Organizations under the specified resource group.

SELECT
id,
name,
createdTime,
linkOrganization,
location,
offerDetail,
organizationId,
provisioningState,
ssoUrl,
systemData,
tags,
type,
userDetail
FROM azure_isv.confluent.organization
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List all organizations under the specified subscription.

SELECT
id,
name,
createdTime,
linkOrganization,
location,
offerDetail,
organizationId,
provisioningState,
ssoUrl,
systemData,
tags,
type,
userDetail
FROM azure_isv.confluent.organization
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create Organization resource.

INSERT INTO azure_isv.confluent.organization (
tags,
location,
properties,
resource_group_name,
organization_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ organization_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: organization
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the organization resource.
  - name: organization_name
    value: "{{ organization_name }}"
    description: Required parameter for the organization resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the organization resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Organization resource properties. Required.
    value:
      createdTime: "{{ createdTime }}"
      provisioningState: "{{ provisioningState }}"
      organizationId: "{{ organizationId }}"
      ssoUrl: "{{ ssoUrl }}"
      offerDetail:
        publisherId: "{{ publisherId }}"
        id: "{{ id }}"
        planId: "{{ planId }}"
        planName: "{{ planName }}"
        termUnit: "{{ termUnit }}"
        termId: "{{ termId }}"
        privateOfferId: "{{ privateOfferId }}"
        privateOfferIds:
          - "{{ privateOfferIds }}"
        status: "{{ status }}"
      userDetail:
        firstName: "{{ firstName }}"
        lastName: "{{ lastName }}"
        emailAddress: "{{ emailAddress }}"
        userPrincipalName: "{{ userPrincipalName }}"
        aadEmail: "{{ aadEmail }}"
      linkOrganization:
        token: "{{ token }}"

UPDATE examples

update

Update Organization resource.

UPDATE azure_isv.confluent.organization
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND organization_name = '{{ organization_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete Organization resource.

DELETE FROM azure_isv.confluent.organization
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND organization_name = '{{ organization_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_environment_by_id

Get Environment details by environment Id.

EXEC azure_isv.confluent.organization.get_environment_by_id 
@resource_group_name='{{ resource_group_name }}' --required, 
@organization_name='{{ organization_name }}' --required, 
@environment_id='{{ environment_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_regions

cloud provider regions available for creating Schema Registry clusters.

EXEC azure_isv.confluent.organization.list_regions 
@resource_group_name='{{ resource_group_name }}' --required, 
@organization_name='{{ organization_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"searchFilters": "{{ searchFilters }}"
}'
;

list_environments

Lists of all the environments in a organization.

EXEC azure_isv.confluent.organization.list_environments 
@resource_group_name='{{ resource_group_name }}' --required, 
@organization_name='{{ organization_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@pageSize='{{ pageSize }}', 
@pageToken='{{ pageToken }}'
;

list_clusters

Lists of all the clusters in a environment.

EXEC azure_isv.confluent.organization.list_clusters 
@resource_group_name='{{ resource_group_name }}' --required, 
@organization_name='{{ organization_name }}' --required, 
@environment_id='{{ environment_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@pageSize='{{ pageSize }}', 
@pageToken='{{ pageToken }}'
;

delete_cluster_api_key

Deletes API key of a kafka or schema registry cluster.

EXEC azure_isv.confluent.organization.delete_cluster_api_key 
@resource_group_name='{{ resource_group_name }}' --required, 
@organization_name='{{ organization_name }}' --required, 
@api_key_id='{{ api_key_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_schema_registry_cluster_by_id

Get schema registry cluster by Id.

EXEC azure_isv.confluent.organization.get_schema_registry_cluster_by_id 
@resource_group_name='{{ resource_group_name }}' --required, 
@organization_name='{{ organization_name }}' --required, 
@environment_id='{{ environment_id }}' --required, 
@cluster_id='{{ cluster_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_api_key

Creates API key for a schema registry Cluster ID or Kafka Cluster ID under a environment.

EXEC azure_isv.confluent.organization.create_api_key 
@resource_group_name='{{ resource_group_name }}' --required, 
@organization_name='{{ organization_name }}' --required, 
@environment_id='{{ environment_id }}' --required, 
@cluster_id='{{ cluster_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"name": "{{ name }}", 
"description": "{{ description }}"
}'
;