Organization interface

Interface representing a Organization.

Methods

beginCreate(string, string, OrganizationCreateOptionalParams)

Create Organization resource

beginCreateAndWait(string, string, OrganizationCreateOptionalParams)

Create Organization resource

beginDelete(string, string, OrganizationDeleteOptionalParams)

Delete Organization resource

beginDeleteAndWait(string, string, OrganizationDeleteOptionalParams)

Delete Organization resource

createAPIKey(string, string, string, string, CreateAPIKeyModel, OrganizationCreateAPIKeyOptionalParams)

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

deleteClusterAPIKey(string, string, string, OrganizationDeleteClusterAPIKeyOptionalParams)

Deletes API key of a kafka or schema registry cluster

get(string, string, OrganizationGetOptionalParams)

Get the properties of a specific Organization resource.

getClusterAPIKey(string, string, string, OrganizationGetClusterAPIKeyOptionalParams)

Get API key details of a kafka or schema registry cluster

getClusterById(string, string, string, string, OrganizationGetClusterByIdOptionalParams)

Get cluster by Id

getEnvironmentById(string, string, string, OrganizationGetEnvironmentByIdOptionalParams)

Get Environment details by environment Id

getSchemaRegistryClusterById(string, string, string, string, OrganizationGetSchemaRegistryClusterByIdOptionalParams)

Get schema registry cluster by Id

listByResourceGroup(string, OrganizationListByResourceGroupOptionalParams)

List all Organizations under the specified resource group.

listBySubscription(OrganizationListBySubscriptionOptionalParams)

List all organizations under the specified subscription.

listClusters(string, string, string, OrganizationListClustersOptionalParams)

Lists of all the clusters in a environment

listEnvironments(string, string, OrganizationListEnvironmentsOptionalParams)

Lists of all the environments in a organization

listRegions(string, string, ListAccessRequestModel, OrganizationListRegionsOptionalParams)

cloud provider regions available for creating Schema Registry clusters.

listSchemaRegistryClusters(string, string, string, OrganizationListSchemaRegistryClustersOptionalParams)

Get schema registry clusters

update(string, string, OrganizationUpdateOptionalParams)

Update Organization resource

Method Details

beginCreate(string, string, OrganizationCreateOptionalParams)

Create Organization resource

function beginCreate(resourceGroupName: string, organizationName: string, options?: OrganizationCreateOptionalParams): Promise<SimplePollerLike<OperationState<OrganizationResource>, OrganizationResource>>

Parameters

resourceGroupName

string

Resource group name

organizationName

string

Organization resource name

options
OrganizationCreateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<OrganizationResource>, OrganizationResource>>

beginCreateAndWait(string, string, OrganizationCreateOptionalParams)

Create Organization resource

function beginCreateAndWait(resourceGroupName: string, organizationName: string, options?: OrganizationCreateOptionalParams): Promise<OrganizationResource>

Parameters

resourceGroupName

string

Resource group name

organizationName

string

Organization resource name

options
OrganizationCreateOptionalParams

The options parameters.

Returns

beginDelete(string, string, OrganizationDeleteOptionalParams)

Delete Organization resource

function beginDelete(resourceGroupName: string, organizationName: string, options?: OrganizationDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

Resource group name

organizationName

string

Organization resource name

options
OrganizationDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, OrganizationDeleteOptionalParams)

Delete Organization resource

function beginDeleteAndWait(resourceGroupName: string, organizationName: string, options?: OrganizationDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Resource group name

organizationName

string

Organization resource name

options
OrganizationDeleteOptionalParams

The options parameters.

Returns

Promise<void>

createAPIKey(string, string, string, string, CreateAPIKeyModel, OrganizationCreateAPIKeyOptionalParams)

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

function createAPIKey(resourceGroupName: string, organizationName: string, environmentId: string, clusterId: string, body: CreateAPIKeyModel, options?: OrganizationCreateAPIKeyOptionalParams): Promise<APIKeyRecord>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

organizationName

string

Organization resource name

environmentId

string

Confluent environment id

clusterId

string

Confluent kafka or schema registry cluster id

body
CreateAPIKeyModel

Request payload for get creating API Key for schema registry Cluster ID or Kafka Cluster ID under a environment

options
OrganizationCreateAPIKeyOptionalParams

The options parameters.

Returns

Promise<APIKeyRecord>

deleteClusterAPIKey(string, string, string, OrganizationDeleteClusterAPIKeyOptionalParams)

Deletes API key of a kafka or schema registry cluster

function deleteClusterAPIKey(resourceGroupName: string, organizationName: string, apiKeyId: string, options?: OrganizationDeleteClusterAPIKeyOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

organizationName

string

Organization resource name

apiKeyId

string

Confluent API Key id

options
OrganizationDeleteClusterAPIKeyOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, OrganizationGetOptionalParams)

Get the properties of a specific Organization resource.

function get(resourceGroupName: string, organizationName: string, options?: OrganizationGetOptionalParams): Promise<OrganizationResource>

Parameters

resourceGroupName

string

Resource group name

organizationName

string

Organization resource name

options
OrganizationGetOptionalParams

The options parameters.

Returns

getClusterAPIKey(string, string, string, OrganizationGetClusterAPIKeyOptionalParams)

Get API key details of a kafka or schema registry cluster

function getClusterAPIKey(resourceGroupName: string, organizationName: string, apiKeyId: string, options?: OrganizationGetClusterAPIKeyOptionalParams): Promise<APIKeyRecord>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

organizationName

string

Organization resource name

apiKeyId

string

Confluent API Key id

options
OrganizationGetClusterAPIKeyOptionalParams

The options parameters.

Returns

Promise<APIKeyRecord>

getClusterById(string, string, string, string, OrganizationGetClusterByIdOptionalParams)

Get cluster by Id

function getClusterById(resourceGroupName: string, organizationName: string, environmentId: string, clusterId: string, options?: OrganizationGetClusterByIdOptionalParams): Promise<SCClusterRecord>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

organizationName

string

Organization resource name

environmentId

string

Confluent environment id

clusterId

string

Confluent kafka or schema registry cluster id

options
OrganizationGetClusterByIdOptionalParams

The options parameters.

Returns

Promise<SCClusterRecord>

getEnvironmentById(string, string, string, OrganizationGetEnvironmentByIdOptionalParams)

Get Environment details by environment Id

function getEnvironmentById(resourceGroupName: string, organizationName: string, environmentId: string, options?: OrganizationGetEnvironmentByIdOptionalParams): Promise<SCEnvironmentRecord>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

organizationName

string

Organization resource name

environmentId

string

Confluent environment id

options
OrganizationGetEnvironmentByIdOptionalParams

The options parameters.

Returns

getSchemaRegistryClusterById(string, string, string, string, OrganizationGetSchemaRegistryClusterByIdOptionalParams)

Get schema registry cluster by Id

function getSchemaRegistryClusterById(resourceGroupName: string, organizationName: string, environmentId: string, clusterId: string, options?: OrganizationGetSchemaRegistryClusterByIdOptionalParams): Promise<SchemaRegistryClusterRecord>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

organizationName

string

Organization resource name

environmentId

string

Confluent environment id

clusterId

string

Confluent kafka or schema registry cluster id

Returns

listByResourceGroup(string, OrganizationListByResourceGroupOptionalParams)

List all Organizations under the specified resource group.

function listByResourceGroup(resourceGroupName: string, options?: OrganizationListByResourceGroupOptionalParams): PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>

Parameters

resourceGroupName

string

Resource group name

options
OrganizationListByResourceGroupOptionalParams

The options parameters.

Returns

listBySubscription(OrganizationListBySubscriptionOptionalParams)

List all organizations under the specified subscription.

function listBySubscription(options?: OrganizationListBySubscriptionOptionalParams): PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>

Parameters

options
OrganizationListBySubscriptionOptionalParams

The options parameters.

Returns

listClusters(string, string, string, OrganizationListClustersOptionalParams)

Lists of all the clusters in a environment

function listClusters(resourceGroupName: string, organizationName: string, environmentId: string, options?: OrganizationListClustersOptionalParams): PagedAsyncIterableIterator<SCClusterRecord, SCClusterRecord[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

organizationName

string

Organization resource name

environmentId

string

Confluent environment id

options
OrganizationListClustersOptionalParams

The options parameters.

Returns

listEnvironments(string, string, OrganizationListEnvironmentsOptionalParams)

Lists of all the environments in a organization

function listEnvironments(resourceGroupName: string, organizationName: string, options?: OrganizationListEnvironmentsOptionalParams): PagedAsyncIterableIterator<SCEnvironmentRecord, SCEnvironmentRecord[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

organizationName

string

Organization resource name

options
OrganizationListEnvironmentsOptionalParams

The options parameters.

Returns

listRegions(string, string, ListAccessRequestModel, OrganizationListRegionsOptionalParams)

cloud provider regions available for creating Schema Registry clusters.

function listRegions(resourceGroupName: string, organizationName: string, body: ListAccessRequestModel, options?: OrganizationListRegionsOptionalParams): Promise<ListRegionsSuccessResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

organizationName

string

Organization resource name

body
ListAccessRequestModel

List Access Request Model

options
OrganizationListRegionsOptionalParams

The options parameters.

Returns

listSchemaRegistryClusters(string, string, string, OrganizationListSchemaRegistryClustersOptionalParams)

Get schema registry clusters

function listSchemaRegistryClusters(resourceGroupName: string, organizationName: string, environmentId: string, options?: OrganizationListSchemaRegistryClustersOptionalParams): PagedAsyncIterableIterator<SchemaRegistryClusterRecord, SchemaRegistryClusterRecord[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

organizationName

string

Organization resource name

environmentId

string

Confluent environment id

Returns

update(string, string, OrganizationUpdateOptionalParams)

Update Organization resource

function update(resourceGroupName: string, organizationName: string, options?: OrganizationUpdateOptionalParams): Promise<OrganizationResource>

Parameters

resourceGroupName

string

Resource group name

organizationName

string

Organization resource name

options
OrganizationUpdateOptionalParams

The options parameters.

Returns