Package com.azure.resourcemanager.synapse.models

Interface KustoPools

public interface KustoPools

Resource collection API of KustoPools.

Method Summary

Modifier and Type	Method	Description
void	addLanguageExtensions(String workspaceName, String kustoPoolName, String resourceGroupName, LanguageExtensionsList languageExtensionsToAdd)	Add a list of language extensions that can run within KQL queries.
void	addLanguageExtensions(String workspaceName, String kustoPoolName, String resourceGroupName, LanguageExtensionsList languageExtensionsToAdd, com.azure.core.util.Context context)	Add a list of language extensions that can run within KQL queries.
CheckNameResult	checkNameAvailability(String location, KustoPoolCheckNameRequest kustoPoolName)	Checks that the kusto pool name is valid and is not already in use.
com.azure.core.http.rest.Response<CheckNameResult>	checkNameAvailabilityWithResponse(String location, KustoPoolCheckNameRequest kustoPoolName, com.azure.core.util.Context context)	Checks that the kusto pool name is valid and is not already in use.
KustoPool.DefinitionStages.Blank	define(String name)	Begins definition for a new KustoPool resource.
void	delete(String workspaceName, String resourceGroupName, String kustoPoolName)	Deletes a Kusto pool.
void	delete(String workspaceName, String resourceGroupName, String kustoPoolName, com.azure.core.util.Context context)	Deletes a Kusto pool.
void	deleteById(String id)	Deletes a Kusto pool.
void	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Deletes a Kusto pool.
void	detachFollowerDatabases(String workspaceName, String kustoPoolName, String resourceGroupName, FollowerDatabaseDefinitionInner followerDatabaseToRemove)	Detaches all followers of a database owned by this Kusto Pool.
void	detachFollowerDatabases(String workspaceName, String kustoPoolName, String resourceGroupName, FollowerDatabaseDefinitionInner followerDatabaseToRemove, com.azure.core.util.Context context)	Detaches all followers of a database owned by this Kusto Pool.
KustoPool	get(String workspaceName, String kustoPoolName, String resourceGroupName)	Gets a Kusto pool.
KustoPool	getById(String id)	Gets a Kusto pool.
com.azure.core.http.rest.Response<KustoPool>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Gets a Kusto pool.
com.azure.core.http.rest.Response<KustoPool>	getWithResponse(String workspaceName, String kustoPoolName, String resourceGroupName, com.azure.core.util.Context context)	Gets a Kusto pool.
com.azure.core.http.rest.PagedIterable<SkuDescription>	list()	Lists eligible SKUs for Kusto Pool resource.
com.azure.core.http.rest.PagedIterable<SkuDescription>	list(com.azure.core.util.Context context)	Lists eligible SKUs for Kusto Pool resource.
KustoPoolListResult	listByWorkspace(String resourceGroupName, String workspaceName)	List all Kusto pools.
com.azure.core.http.rest.Response<KustoPoolListResult>	listByWorkspaceWithResponse(String resourceGroupName, String workspaceName, com.azure.core.util.Context context)	List all Kusto pools.
com.azure.core.http.rest.PagedIterable<FollowerDatabaseDefinition>	listFollowerDatabases(String workspaceName, String kustoPoolName, String resourceGroupName)	Returns a list of databases that are owned by this Kusto Pool and were followed by another Kusto Pool.
com.azure.core.http.rest.PagedIterable<FollowerDatabaseDefinition>	listFollowerDatabases(String workspaceName, String kustoPoolName, String resourceGroupName, com.azure.core.util.Context context)	Returns a list of databases that are owned by this Kusto Pool and were followed by another Kusto Pool.
com.azure.core.http.rest.PagedIterable<LanguageExtension>	listLanguageExtensions(String workspaceName, String kustoPoolName, String resourceGroupName)	Returns a list of language extensions that can run within KQL queries.
com.azure.core.http.rest.PagedIterable<LanguageExtension>	listLanguageExtensions(String workspaceName, String kustoPoolName, String resourceGroupName, com.azure.core.util.Context context)	Returns a list of language extensions that can run within KQL queries.
com.azure.core.http.rest.PagedIterable<AzureResourceSku>	listSkusByResource(String workspaceName, String kustoPoolName, String resourceGroupName)	Returns the SKUs available for the provided resource.
com.azure.core.http.rest.PagedIterable<AzureResourceSku>	listSkusByResource(String workspaceName, String kustoPoolName, String resourceGroupName, com.azure.core.util.Context context)	Returns the SKUs available for the provided resource.
void	removeLanguageExtensions(String workspaceName, String kustoPoolName, String resourceGroupName, LanguageExtensionsList languageExtensionsToRemove)	Remove a list of language extensions that can run within KQL queries.
void	removeLanguageExtensions(String workspaceName, String kustoPoolName, String resourceGroupName, LanguageExtensionsList languageExtensionsToRemove, com.azure.core.util.Context context)	Remove a list of language extensions that can run within KQL queries.
void	start(String workspaceName, String kustoPoolName, String resourceGroupName)	Starts a Kusto pool.
void	start(String workspaceName, String kustoPoolName, String resourceGroupName, com.azure.core.util.Context context)	Starts a Kusto pool.
void	stop(String workspaceName, String kustoPoolName, String resourceGroupName)	Stops a Kusto pool.
void	stop(String workspaceName, String kustoPoolName, String resourceGroupName, com.azure.core.util.Context context)	Stops a Kusto pool.

Method Detail

list

com.azure.core.http.rest.PagedIterable<SkuDescription> list()

Lists eligible SKUs for Kusto Pool resource.

Returns:

the list of the SKU descriptions as paginated response with PagedIterable.

Throws:

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<SkuDescription> list(com.azure.core.util.Context context)

Lists eligible SKUs for Kusto Pool resource.

Parameters:

context - The context to associate with this operation.

Returns:

the list of the SKU descriptions as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

checkNameAvailability

CheckNameResult checkNameAvailability(String location,
                                      KustoPoolCheckNameRequest kustoPoolName)

Checks that the kusto pool name is valid and is not already in use.

Parameters:

location - The name of Azure region.

kustoPoolName - The name of the cluster.

Returns:

the result returned from a check name availability request.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

checkNameAvailabilityWithResponse

com.azure.core.http.rest.Response<CheckNameResult> checkNameAvailabilityWithResponse(String location,
                                                                                     KustoPoolCheckNameRequest kustoPoolName,
                                                                                     com.azure.core.util.Context context)

Checks that the kusto pool name is valid and is not already in use.

Parameters:

location - The name of Azure region.

kustoPoolName - The name of the cluster.

context - The context to associate with this operation.

Returns:

the result returned from a check name availability request along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByWorkspace

KustoPoolListResult listByWorkspace(String resourceGroupName,
                                    String workspaceName)

List all Kusto pools.

Parameters:

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

workspaceName - The name of the workspace.

Returns:

the list Kusto pools operation response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByWorkspaceWithResponse

com.azure.core.http.rest.Response<KustoPoolListResult> listByWorkspaceWithResponse(String resourceGroupName,
                                                                                   String workspaceName,
                                                                                   com.azure.core.util.Context context)

List all Kusto pools.

Parameters:

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

workspaceName - The name of the workspace.

context - The context to associate with this operation.

Returns:

the list Kusto pools operation response along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

get

KustoPool get(String workspaceName,
              String kustoPoolName,
              String resourceGroupName)

Gets a Kusto pool.

Parameters:

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

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

Returns:

a Kusto pool.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getWithResponse

com.azure.core.http.rest.Response<KustoPool> getWithResponse(String workspaceName,
                                                             String kustoPoolName,
                                                             String resourceGroupName,
                                                             com.azure.core.util.Context context)

Gets a Kusto pool.

Parameters:

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

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

context - The context to associate with this operation.

Returns:

a Kusto pool along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String workspaceName,
            String resourceGroupName,
            String kustoPoolName)

Deletes a Kusto pool.

Parameters:

workspaceName - The name of the workspace.

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

kustoPoolName - The name of the Kusto pool.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String workspaceName,
            String resourceGroupName,
            String kustoPoolName,
            com.azure.core.util.Context context)

Deletes a Kusto pool.

Parameters:

workspaceName - The name of the workspace.

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

kustoPoolName - The name of the Kusto pool.

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

stop

void stop(String workspaceName,
          String kustoPoolName,
          String resourceGroupName)

Stops a Kusto pool.

Parameters:

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

stop

void stop(String workspaceName,
          String kustoPoolName,
          String resourceGroupName,
          com.azure.core.util.Context context)

Stops a Kusto pool.

Parameters:

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

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

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

start

void start(String workspaceName,
           String kustoPoolName,
           String resourceGroupName)

Starts a Kusto pool.

Parameters:

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

start

void start(String workspaceName,
           String kustoPoolName,
           String resourceGroupName,
           com.azure.core.util.Context context)

Starts a Kusto pool.

Parameters:

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

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

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listSkusByResource

com.azure.core.http.rest.PagedIterable<AzureResourceSku> listSkusByResource(String workspaceName,
                                                                            String kustoPoolName,
                                                                            String resourceGroupName)

Returns the SKUs available for the provided resource.

Parameters:

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

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

Returns:

list of available SKUs for a Kusto Pool as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listSkusByResource

com.azure.core.http.rest.PagedIterable<AzureResourceSku> listSkusByResource(String workspaceName,
                                                                            String kustoPoolName,
                                                                            String resourceGroupName,
                                                                            com.azure.core.util.Context context)

Returns the SKUs available for the provided resource.

Parameters:

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

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

context - The context to associate with this operation.

Returns:

list of available SKUs for a Kusto Pool as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listLanguageExtensions

com.azure.core.http.rest.PagedIterable<LanguageExtension> listLanguageExtensions(String workspaceName,
                                                                                 String kustoPoolName,
                                                                                 String resourceGroupName)

Returns a list of language extensions that can run within KQL queries.

Parameters:

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

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

Returns:

the list of language extension objects as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listLanguageExtensions

com.azure.core.http.rest.PagedIterable<LanguageExtension> listLanguageExtensions(String workspaceName,
                                                                                 String kustoPoolName,
                                                                                 String resourceGroupName,
                                                                                 com.azure.core.util.Context context)

Returns a list of language extensions that can run within KQL queries.

Parameters:

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

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

context - The context to associate with this operation.

Returns:

the list of language extension objects as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

addLanguageExtensions

void addLanguageExtensions(String workspaceName,
                           String kustoPoolName,
                           String resourceGroupName,
                           LanguageExtensionsList languageExtensionsToAdd)

Add a list of language extensions that can run within KQL queries.

Parameters:

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

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

languageExtensionsToAdd - The language extensions to add.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

addLanguageExtensions

void addLanguageExtensions(String workspaceName,
                           String kustoPoolName,
                           String resourceGroupName,
                           LanguageExtensionsList languageExtensionsToAdd,
                           com.azure.core.util.Context context)

Add a list of language extensions that can run within KQL queries.

Parameters:

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

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

languageExtensionsToAdd - The language extensions to add.

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

removeLanguageExtensions

void removeLanguageExtensions(String workspaceName,
                              String kustoPoolName,
                              String resourceGroupName,
                              LanguageExtensionsList languageExtensionsToRemove)

Remove a list of language extensions that can run within KQL queries.

Parameters:

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

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

languageExtensionsToRemove - The language extensions to remove.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

removeLanguageExtensions

void removeLanguageExtensions(String workspaceName,
                              String kustoPoolName,
                              String resourceGroupName,
                              LanguageExtensionsList languageExtensionsToRemove,
                              com.azure.core.util.Context context)

Remove a list of language extensions that can run within KQL queries.

Parameters:

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

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

languageExtensionsToRemove - The language extensions to remove.

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listFollowerDatabases

com.azure.core.http.rest.PagedIterable<FollowerDatabaseDefinition> listFollowerDatabases(String workspaceName,
                                                                                         String kustoPoolName,
                                                                                         String resourceGroupName)

Returns a list of databases that are owned by this Kusto Pool and were followed by another Kusto Pool.

Parameters:

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

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

Returns:

the list Kusto database principals operation response as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listFollowerDatabases

com.azure.core.http.rest.PagedIterable<FollowerDatabaseDefinition> listFollowerDatabases(String workspaceName,
                                                                                         String kustoPoolName,
                                                                                         String resourceGroupName,
                                                                                         com.azure.core.util.Context context)

Returns a list of databases that are owned by this Kusto Pool and were followed by another Kusto Pool.

Parameters:

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

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

context - The context to associate with this operation.

Returns:

the list Kusto database principals operation response as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

detachFollowerDatabases

void detachFollowerDatabases(String workspaceName,
                             String kustoPoolName,
                             String resourceGroupName,
                             FollowerDatabaseDefinitionInner followerDatabaseToRemove)

Detaches all followers of a database owned by this Kusto Pool.

Parameters:

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

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

followerDatabaseToRemove - The follower databases properties to remove.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

detachFollowerDatabases

void detachFollowerDatabases(String workspaceName,
                             String kustoPoolName,
                             String resourceGroupName,
                             FollowerDatabaseDefinitionInner followerDatabaseToRemove,
                             com.azure.core.util.Context context)

Detaches all followers of a database owned by this Kusto Pool.

Parameters:

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

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

followerDatabaseToRemove - The follower databases properties to remove.

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getById

KustoPool getById(String id)

Gets a Kusto pool.

Parameters:

id - the resource ID.

Returns:

a Kusto pool along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByIdWithResponse

com.azure.core.http.rest.Response<KustoPool> getByIdWithResponse(String id,
                                                                 com.azure.core.util.Context context)

Gets a Kusto pool.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

a Kusto pool along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteById

void deleteById(String id)

Deletes a Kusto pool.

Parameters:

id - the resource ID.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteByIdWithResponse

void deleteByIdWithResponse(String id,
                            com.azure.core.util.Context context)

Deletes a Kusto pool.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

define

KustoPool.DefinitionStages.Blank define(String name)

Begins definition for a new KustoPool resource.

Parameters:

name - resource name.

Returns:

the first stage of the new KustoPool definition.