OrganizationsClient Interface

Package:

com.azure.resourcemanager.confluent.fluent

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-confluent:1.2.0

public interface OrganizationsClient

An instance of this class provides access to all the operations defined in OrganizationsClient.

Method Summary

Modifier and Type	Method and Description
abstract SyncPoller<PollResult<OrganizationResourceInner>,OrganizationResourceInner>	beginCreate(String resourceGroupName, String organizationName) Create Organization resource.
abstract SyncPoller<PollResult<OrganizationResourceInner>,OrganizationResourceInner>	beginCreate(String resourceGroupName, String organizationName, OrganizationResourceInner body, Context context) Create Organization resource.
abstract SyncPoller<PollResult<Void>,Void>	beginDelete(String resourceGroupName, String organizationName) Delete Organization resource.
abstract SyncPoller<PollResult<Void>,Void>	beginDelete(String resourceGroupName, String organizationName, Context context) Delete Organization resource.
abstract OrganizationResourceInner	create(String resourceGroupName, String organizationName) Create Organization resource.
abstract OrganizationResourceInner	create(String resourceGroupName, String organizationName, OrganizationResourceInner body, Context context) Create Organization resource.
abstract ApiKeyRecordInner	createApiKey(String resourceGroupName, String organizationName, String environmentId, String clusterId, CreateApiKeyModel body) Creates API key for a schema registry Cluster ID or Kafka Cluster ID under a environment.
abstract Response<ApiKeyRecordInner>	createApiKeyWithResponse(String resourceGroupName, String organizationName, String environmentId, String clusterId, CreateApiKeyModel body, Context context) Creates API key for a schema registry Cluster ID or Kafka Cluster ID under a environment.
abstract void	delete(String resourceGroupName, String organizationName) Delete Organization resource.
abstract void	delete(String resourceGroupName, String organizationName, Context context) Delete Organization resource.
abstract void	deleteClusterApiKey(String resourceGroupName, String organizationName, String apiKeyId) Deletes API key of a kafka or schema registry cluster.
abstract Response<Void>	deleteClusterApiKeyWithResponse(String resourceGroupName, String organizationName, String apiKeyId, Context context) Deletes API key of a kafka or schema registry cluster.
abstract OrganizationResourceInner	getByResourceGroup(String resourceGroupName, String organizationName) Get the properties of a specific Organization resource.
abstract Response<OrganizationResourceInner>	getByResourceGroupWithResponse(String resourceGroupName, String organizationName, Context context) Get the properties of a specific Organization resource.
abstract ApiKeyRecordInner	getClusterApiKey(String resourceGroupName, String organizationName, String apiKeyId) Get API key details of a kafka or schema registry cluster.
abstract Response<ApiKeyRecordInner>	getClusterApiKeyWithResponse(String resourceGroupName, String organizationName, String apiKeyId, Context context) Get API key details of a kafka or schema registry cluster.
abstract SCClusterRecordInner	getClusterById(String resourceGroupName, String organizationName, String environmentId, String clusterId) Get cluster by Id.
abstract Response<SCClusterRecordInner>	getClusterByIdWithResponse(String resourceGroupName, String organizationName, String environmentId, String clusterId, Context context) Get cluster by Id.
abstract SCEnvironmentRecordInner	getEnvironmentById(String resourceGroupName, String organizationName, String environmentId) Get Environment details by environment Id.
abstract Response<SCEnvironmentRecordInner>	getEnvironmentByIdWithResponse(String resourceGroupName, String organizationName, String environmentId, Context context) Get Environment details by environment Id.
abstract SchemaRegistryClusterRecordInner	getSchemaRegistryClusterById(String resourceGroupName, String organizationName, String environmentId, String clusterId) Get schema registry cluster by Id.
abstract Response<SchemaRegistryClusterRecordInner>	getSchemaRegistryClusterByIdWithResponse(String resourceGroupName, String organizationName, String environmentId, String clusterId, Context context) Get schema registry cluster by Id.
abstract PagedIterable<OrganizationResourceInner>	list() List all organizations under the specified subscription.
abstract PagedIterable<OrganizationResourceInner>	list(Context context) List all organizations under the specified subscription.
abstract PagedIterable<OrganizationResourceInner>	listByResourceGroup(String resourceGroupName) List all Organizations under the specified resource group.
abstract PagedIterable<OrganizationResourceInner>	listByResourceGroup(String resourceGroupName, Context context) List all Organizations under the specified resource group.
abstract PagedIterable<SCClusterRecordInner>	listClusters(String resourceGroupName, String organizationName, String environmentId) Lists of all the clusters in a environment.
abstract PagedIterable<SCClusterRecordInner>	listClusters(String resourceGroupName, String organizationName, String environmentId, Integer pageSize, String pageToken, Context context) Lists of all the clusters in a environment.
abstract PagedIterable<SCEnvironmentRecordInner>	listEnvironments(String resourceGroupName, String organizationName) Lists of all the environments in a organization.
abstract PagedIterable<SCEnvironmentRecordInner>	listEnvironments(String resourceGroupName, String organizationName, Integer pageSize, String pageToken, Context context) Lists of all the environments in a organization.
abstract ListRegionsSuccessResponseInner	listRegions(String resourceGroupName, String organizationName, ListAccessRequestModel body) cloud provider regions available for creating Schema Registry clusters.
abstract Response<ListRegionsSuccessResponseInner>	listRegionsWithResponse(String resourceGroupName, String organizationName, ListAccessRequestModel body, Context context) cloud provider regions available for creating Schema Registry clusters.
abstract PagedIterable<SchemaRegistryClusterRecordInner>	listSchemaRegistryClusters(String resourceGroupName, String organizationName, String environmentId) Get schema registry clusters.
abstract PagedIterable<SchemaRegistryClusterRecordInner>	listSchemaRegistryClusters(String resourceGroupName, String organizationName, String environmentId, Integer pageSize, String pageToken, Context context) Get schema registry clusters.
abstract OrganizationResourceInner	update(String resourceGroupName, String organizationName) Update Organization resource.
abstract Response<OrganizationResourceInner>	updateWithResponse(String resourceGroupName, String organizationName, OrganizationResourceUpdate body, Context context) Update Organization resource.

Method Details

beginCreate

public abstract SyncPoller<PollResult<OrganizationResourceInner>,OrganizationResourceInner> beginCreate(String resourceGroupName, String organizationName)

Create Organization resource.

Parameters:

resourceGroupName - Resource group name.

organizationName - Organization resource name.

Returns:

the SyncPoller<T,U> for polling of organization resource.

beginCreate

public abstract SyncPoller<PollResult<OrganizationResourceInner>,OrganizationResourceInner> beginCreate(String resourceGroupName, String organizationName, OrganizationResourceInner body, Context context)

Create Organization resource.

Parameters:

resourceGroupName - Resource group name.

organizationName - Organization resource name.

body - Organization resource model.

context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of organization resource.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String organizationName)

Delete Organization resource.

Parameters:

resourceGroupName - Resource group name.

organizationName - Organization resource name.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String organizationName, Context context)

Delete Organization resource.

Parameters:

resourceGroupName - Resource group name.

organizationName - Organization resource name.

context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

create

public abstract OrganizationResourceInner create(String resourceGroupName, String organizationName)

Create Organization resource.

Parameters:

resourceGroupName - Resource group name.

organizationName - Organization resource name.

Returns:

organization resource.

create

public abstract OrganizationResourceInner create(String resourceGroupName, String organizationName, OrganizationResourceInner body, Context context)

Create Organization resource.

Parameters:

resourceGroupName - Resource group name.

organizationName - Organization resource name.

body - Organization resource model.

context - The context to associate with this operation.

Returns:

organization resource.

createApiKey

public abstract ApiKeyRecordInner createApiKey(String resourceGroupName, String organizationName, String environmentId, String clusterId, CreateApiKeyModel body)

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

Parameters:

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

organizationName - Organization resource name.

environmentId - Confluent environment id.

clusterId - Confluent kafka or schema registry cluster id.

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

Returns:

details API key.

createApiKeyWithResponse

public abstract Response<ApiKeyRecordInner> createApiKeyWithResponse(String resourceGroupName, String organizationName, String environmentId, String clusterId, CreateApiKeyModel body, Context context)

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

Parameters:

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

organizationName - Organization resource name.

environmentId - Confluent environment id.

clusterId - Confluent kafka or schema registry cluster id.

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

context - The context to associate with this operation.

Returns:

details API key along with Response<T>.

delete

public abstract void delete(String resourceGroupName, String organizationName)

Delete Organization resource.

Parameters:

resourceGroupName - Resource group name.

organizationName - Organization resource name.

delete

public abstract void delete(String resourceGroupName, String organizationName, Context context)

Delete Organization resource.

Parameters:

resourceGroupName - Resource group name.

organizationName - Organization resource name.

context - The context to associate with this operation.

deleteClusterApiKey

public abstract void deleteClusterApiKey(String resourceGroupName, String organizationName, String apiKeyId)

Deletes API key of a kafka or schema registry cluster.

Parameters:

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

organizationName - Organization resource name.

apiKeyId - Confluent API Key id.

deleteClusterApiKeyWithResponse

public abstract Response<Void> deleteClusterApiKeyWithResponse(String resourceGroupName, String organizationName, String apiKeyId, Context context)

Deletes API key of a kafka or schema registry cluster.

Parameters:

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

organizationName - Organization resource name.

apiKeyId - Confluent API Key id.

context - The context to associate with this operation.

Returns:

the Response<T>.

getByResourceGroup

public abstract OrganizationResourceInner getByResourceGroup(String resourceGroupName, String organizationName)

Get the properties of a specific Organization resource.

Parameters:

resourceGroupName - Resource group name.

organizationName - Organization resource name.

Returns:

the properties of a specific Organization resource.

getByResourceGroupWithResponse

public abstract Response<OrganizationResourceInner> getByResourceGroupWithResponse(String resourceGroupName, String organizationName, Context context)

Get the properties of a specific Organization resource.

Parameters:

resourceGroupName - Resource group name.

organizationName - Organization resource name.

context - The context to associate with this operation.

Returns:

the properties of a specific Organization resource along with Response<T>.

getClusterApiKey

public abstract ApiKeyRecordInner getClusterApiKey(String resourceGroupName, String organizationName, String apiKeyId)

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

Parameters:

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

organizationName - Organization resource name.

apiKeyId - Confluent API Key id.

Returns:

aPI key details of a kafka or schema registry cluster.

getClusterApiKeyWithResponse

public abstract Response<ApiKeyRecordInner> getClusterApiKeyWithResponse(String resourceGroupName, String organizationName, String apiKeyId, Context context)

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

Parameters:

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

organizationName - Organization resource name.

apiKeyId - Confluent API Key id.

context - The context to associate with this operation.

Returns:

aPI key details of a kafka or schema registry cluster along with Response<T>.

getClusterById

public abstract SCClusterRecordInner getClusterById(String resourceGroupName, String organizationName, String environmentId, String clusterId)

Get cluster by Id.

Parameters:

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

organizationName - Organization resource name.

environmentId - Confluent environment id.

clusterId - Confluent kafka or schema registry cluster id.

Returns:

cluster by Id.

getClusterByIdWithResponse

public abstract Response<SCClusterRecordInner> getClusterByIdWithResponse(String resourceGroupName, String organizationName, String environmentId, String clusterId, Context context)

Get cluster by Id.

Parameters:

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

organizationName - Organization resource name.

environmentId - Confluent environment id.

clusterId - Confluent kafka or schema registry cluster id.

context - The context to associate with this operation.

Returns:

cluster by Id along with Response<T>.

getEnvironmentById

public abstract SCEnvironmentRecordInner getEnvironmentById(String resourceGroupName, String organizationName, String environmentId)

Get Environment details by environment Id.

Parameters:

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

organizationName - Organization resource name.

environmentId - Confluent environment id.

Returns:

environment details by environment Id.

getEnvironmentByIdWithResponse

public abstract Response<SCEnvironmentRecordInner> getEnvironmentByIdWithResponse(String resourceGroupName, String organizationName, String environmentId, Context context)

Get Environment details by environment Id.

Parameters:

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

organizationName - Organization resource name.

environmentId - Confluent environment id.

context - The context to associate with this operation.

Returns:

environment details by environment Id along with Response<T>.

getSchemaRegistryClusterById

public abstract SchemaRegistryClusterRecordInner getSchemaRegistryClusterById(String resourceGroupName, String organizationName, String environmentId, String clusterId)

Get schema registry cluster by Id.

Parameters:

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

organizationName - Organization resource name.

environmentId - Confluent environment id.

clusterId - Confluent kafka or schema registry cluster id.

Returns:

schema registry cluster by Id.

getSchemaRegistryClusterByIdWithResponse

public abstract Response<SchemaRegistryClusterRecordInner> getSchemaRegistryClusterByIdWithResponse(String resourceGroupName, String organizationName, String environmentId, String clusterId, Context context)

Get schema registry cluster by Id.

Parameters:

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

organizationName - Organization resource name.

environmentId - Confluent environment id.

clusterId - Confluent kafka or schema registry cluster id.

context - The context to associate with this operation.

Returns:

schema registry cluster by Id along with Response<T>.

list

public abstract PagedIterable<OrganizationResourceInner> list()

List all organizations under the specified subscription.

Returns:

the response of a list operation as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<OrganizationResourceInner> list(Context context)

List all organizations under the specified subscription.

Parameters:

context - The context to associate with this operation.

Returns:

the response of a list operation as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<OrganizationResourceInner> listByResourceGroup(String resourceGroupName)

List all Organizations under the specified resource group.

Parameters:

resourceGroupName - Resource group name.

Returns:

the response of a list operation as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<OrganizationResourceInner> listByResourceGroup(String resourceGroupName, Context context)

List all Organizations under the specified resource group.

Parameters:

resourceGroupName - Resource group name.

context - The context to associate with this operation.

Returns:

the response of a list operation as paginated response with PagedIterable<T>.

listClusters

public abstract PagedIterable<SCClusterRecordInner> listClusters(String resourceGroupName, String organizationName, String environmentId)

Lists of all the clusters in a environment.

Parameters:

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

organizationName - Organization resource name.

environmentId - Confluent environment id.

Returns:

result of GET request to list clusters in the environment of a confluent organization as paginated response with PagedIterable<T>.

listClusters

public abstract PagedIterable<SCClusterRecordInner> listClusters(String resourceGroupName, String organizationName, String environmentId, Integer pageSize, String pageToken, Context context)

Lists of all the clusters in a environment.

Parameters:

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

organizationName - Organization resource name.

environmentId - Confluent environment id.

pageSize - Pagination size.

pageToken - An opaque pagination token to fetch the next set of records.

context - The context to associate with this operation.

Returns:

result of GET request to list clusters in the environment of a confluent organization as paginated response with PagedIterable<T>.

listEnvironments

public abstract PagedIterable<SCEnvironmentRecordInner> listEnvironments(String resourceGroupName, String organizationName)

Lists of all the environments in a organization.

Parameters:

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

organizationName - Organization resource name.

Returns:

result of GET request to list Confluent operations as paginated response with PagedIterable<T>.

listEnvironments

public abstract PagedIterable<SCEnvironmentRecordInner> listEnvironments(String resourceGroupName, String organizationName, Integer pageSize, String pageToken, Context context)

Lists of all the environments in a organization.

Parameters:

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

organizationName - Organization resource name.

pageSize - Pagination size.

pageToken - An opaque pagination token to fetch the next set of records.

context - The context to associate with this operation.

Returns:

result of GET request to list Confluent operations as paginated response with PagedIterable<T>.

listRegions

public abstract ListRegionsSuccessResponseInner listRegions(String resourceGroupName, String organizationName, ListAccessRequestModel body)

cloud provider regions available for creating Schema Registry clusters.

Parameters:

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

organizationName - Organization resource name.

body - List Access Request Model.

Returns:

result of POST request to list regions supported by confluent.

listRegionsWithResponse

public abstract Response<ListRegionsSuccessResponseInner> listRegionsWithResponse(String resourceGroupName, String organizationName, ListAccessRequestModel body, Context context)

cloud provider regions available for creating Schema Registry clusters.

Parameters:

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

organizationName - Organization resource name.

body - List Access Request Model.

context - The context to associate with this operation.

Returns:

result of POST request to list regions supported by confluent along with Response<T>.

listSchemaRegistryClusters

public abstract PagedIterable<SchemaRegistryClusterRecordInner> listSchemaRegistryClusters(String resourceGroupName, String organizationName, String environmentId)

Get schema registry clusters.

Parameters:

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

organizationName - Organization resource name.

environmentId - Confluent environment id.

Returns:

schema registry clusters as paginated response with PagedIterable<T>.

listSchemaRegistryClusters

public abstract PagedIterable<SchemaRegistryClusterRecordInner> listSchemaRegistryClusters(String resourceGroupName, String organizationName, String environmentId, Integer pageSize, String pageToken, Context context)

Get schema registry clusters.

Parameters:

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

organizationName - Organization resource name.

environmentId - Confluent environment id.

pageSize - Pagination size.

pageToken - An opaque pagination token to fetch the next set of records.

context - The context to associate with this operation.

Returns:

schema registry clusters as paginated response with PagedIterable<T>.

update

public abstract OrganizationResourceInner update(String resourceGroupName, String organizationName)

Update Organization resource.

Parameters:

resourceGroupName - Resource group name.

organizationName - Organization resource name.

Returns:

organization resource.

updateWithResponse

public abstract Response<OrganizationResourceInner> updateWithResponse(String resourceGroupName, String organizationName, OrganizationResourceUpdate body, Context context)

Update Organization resource.

Parameters:

resourceGroupName - Resource group name.

organizationName - Organization resource name.

body - Updated Organization resource.

context - The context to associate with this operation.

Returns:

organization resource along with Response<T>.