Organizations Interface

Package:

com.azure.resourcemanager.confluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-confluent:1.3.0-beta.1

public interface Organizations

Resource collection API of Organizations.

Method Summary

Modifier and Type	Method and Description
abstract ApiKeyRecord	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<ApiKeyRecord>	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 Blank	define(String name) Begins definition for a new OrganizationResource resource.
abstract void	delete(String resourceGroupName, String organizationName, Context context) Delete Organization resource.
abstract void	deleteById(String id) Delete Organization resource.
abstract void	deleteByIdWithResponse(String id, Context context) Delete Organization resource.
abstract void	deleteByResourceGroup(String resourceGroupName, String organizationName) 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 OrganizationResource	getById(String id) Get the properties of a specific Organization resource.
abstract Response<OrganizationResource>	getByIdWithResponse(String id, Context context) Get the properties of a specific Organization resource.
abstract OrganizationResource	getByResourceGroup(String resourceGroupName, String organizationName) Get the properties of a specific Organization resource.
abstract Response<OrganizationResource>	getByResourceGroupWithResponse(String resourceGroupName, String organizationName, Context context) Get the properties of a specific Organization resource.
abstract ApiKeyRecord	getClusterApiKey(String resourceGroupName, String organizationName, String apiKeyId) Get API key details of a kafka or schema registry cluster.
abstract Response<ApiKeyRecord>	getClusterApiKeyWithResponse(String resourceGroupName, String organizationName, String apiKeyId, Context context) Get API key details of a kafka or schema registry cluster.
abstract SCClusterRecord	getClusterById(String resourceGroupName, String organizationName, String environmentId, String clusterId) Get cluster by Id.
abstract Response<SCClusterRecord>	getClusterByIdWithResponse(String resourceGroupName, String organizationName, String environmentId, String clusterId, Context context) Get cluster by Id.
abstract SCEnvironmentRecord	getEnvironmentById(String resourceGroupName, String organizationName, String environmentId) Get Environment details by environment Id.
abstract Response<SCEnvironmentRecord>	getEnvironmentByIdWithResponse(String resourceGroupName, String organizationName, String environmentId, Context context) Get Environment details by environment Id.
abstract SchemaRegistryClusterRecord	getSchemaRegistryClusterById(String resourceGroupName, String organizationName, String environmentId, String clusterId) Get schema registry cluster by Id.
abstract Response<SchemaRegistryClusterRecord>	getSchemaRegistryClusterByIdWithResponse(String resourceGroupName, String organizationName, String environmentId, String clusterId, Context context) Get schema registry cluster by Id.
abstract PagedIterable<OrganizationResource>	list() List all organizations under the specified subscription.
abstract PagedIterable<OrganizationResource>	list(Context context) List all organizations under the specified subscription.
abstract PagedIterable<OrganizationResource>	listByResourceGroup(String resourceGroupName) List all Organizations under the specified resource group.
abstract PagedIterable<OrganizationResource>	listByResourceGroup(String resourceGroupName, Context context) List all Organizations under the specified resource group.
abstract PagedIterable<SCClusterRecord>	listClusters(String resourceGroupName, String organizationName, String environmentId) Lists of all the clusters in a environment.
abstract PagedIterable<SCClusterRecord>	listClusters(String resourceGroupName, String organizationName, String environmentId, Integer pageSize, String pageToken, Context context) Lists of all the clusters in a environment.
abstract PagedIterable<SCEnvironmentRecord>	listEnvironments(String resourceGroupName, String organizationName) Lists of all the environments in a organization.
abstract PagedIterable<SCEnvironmentRecord>	listEnvironments(String resourceGroupName, String organizationName, Integer pageSize, String pageToken, Context context) Lists of all the environments in a organization.
abstract ListRegionsSuccessResponse	listRegions(String resourceGroupName, String organizationName, ListAccessRequestModel body) cloud provider regions available for creating Schema Registry clusters.
abstract Response<ListRegionsSuccessResponse>	listRegionsWithResponse(String resourceGroupName, String organizationName, ListAccessRequestModel body, Context context) cloud provider regions available for creating Schema Registry clusters.
abstract PagedIterable<SchemaRegistryClusterRecord>	listSchemaRegistryClusters(String resourceGroupName, String organizationName, String environmentId) Get schema registry clusters.
abstract PagedIterable<SchemaRegistryClusterRecord>	listSchemaRegistryClusters(String resourceGroupName, String organizationName, String environmentId, Integer pageSize, String pageToken, Context context) Get schema registry clusters.

Method Details

createApiKey

public abstract ApiKeyRecord 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<ApiKeyRecord> 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>.

define

public abstract OrganizationResource.DefinitionStages.Blank define(String name)

Begins definition for a new OrganizationResource resource.

Parameters:

name - resource name.

Returns:

the first stage of the new OrganizationResource definition.

delete

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

Delete Organization resource.

Parameters:

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

organizationName - Organization resource name.

context - The context to associate with this operation.

deleteById

public abstract void deleteById(String id)

Delete Organization resource.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Delete Organization resource.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

deleteByResourceGroup

public abstract void deleteByResourceGroup(String resourceGroupName, String organizationName)

Delete Organization resource.

Parameters:

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

organizationName - Organization resource name.

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

getById

public abstract OrganizationResource getById(String id)

Get the properties of a specific Organization resource.

Parameters:

id - the resource ID.

Returns:

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

getByIdWithResponse

public abstract Response<OrganizationResource> getByIdWithResponse(String id, Context context)

Get the properties of a specific Organization resource.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

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

getByResourceGroup

public abstract OrganizationResource getByResourceGroup(String resourceGroupName, String organizationName)

Get the properties of a specific Organization resource.

Parameters:

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

organizationName - Organization resource name.

Returns:

the properties of a specific Organization resource.

getByResourceGroupWithResponse

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

Get the properties of a specific Organization resource.

Parameters:

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

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 ApiKeyRecord 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<ApiKeyRecord> 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 SCClusterRecord 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<SCClusterRecord> 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 SCEnvironmentRecord 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<SCEnvironmentRecord> 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 SchemaRegistryClusterRecord 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 connector name.

Returns:

schema registry cluster by Id.

getSchemaRegistryClusterByIdWithResponse

public abstract Response<SchemaRegistryClusterRecord> 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 connector name.

context - The context to associate with this operation.

Returns:

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

list

public abstract PagedIterable<OrganizationResource> list()

List all organizations under the specified subscription.

Returns:

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

list

public abstract PagedIterable<OrganizationResource> list(Context context)

List all organizations under the specified subscription.

Parameters:

context - The context to associate with this operation.

Returns:

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

listByResourceGroup

public abstract PagedIterable<OrganizationResource> listByResourceGroup(String resourceGroupName)

List all Organizations under the specified resource group.

Parameters:

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

Returns:

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

listByResourceGroup

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

List all Organizations under the specified resource group.

Parameters:

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

context - The context to associate with this operation.

Returns:

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

listClusters

public abstract PagedIterable<SCClusterRecord> 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<SCClusterRecord> 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<SCEnvironmentRecord> 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<SCEnvironmentRecord> 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 ListRegionsSuccessResponse 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<ListRegionsSuccessResponse> 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<SchemaRegistryClusterRecord> 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<SchemaRegistryClusterRecord> 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>.