Package com.azure.resourcemanager.kusto.models

Interface Scripts

public interface Scripts

Resource collection API of Scripts.

Method Summary

Modifier and Type	Method	Description
CheckNameResult	checkNameAvailability(String resourceGroupName, String clusterName, String databaseName, ScriptCheckNameRequest scriptName)	Checks that the script name is valid and is not already in use.
com.azure.core.http.rest.Response<CheckNameResult>	checkNameAvailabilityWithResponse(String resourceGroupName, String clusterName, String databaseName, ScriptCheckNameRequest scriptName, com.azure.core.util.Context context)	Checks that the script name is valid and is not already in use.
Script.DefinitionStages.Blank	define(String name)	Begins definition for a new Script resource.
void	delete(String resourceGroupName, String clusterName, String databaseName, String scriptName)	Deletes a Kusto principalAssignment.
void	delete(String resourceGroupName, String clusterName, String databaseName, String scriptName, com.azure.core.util.Context context)	Deletes a Kusto principalAssignment.
void	deleteById(String id)	Deletes a Kusto principalAssignment.
void	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Deletes a Kusto principalAssignment.
Script	get(String resourceGroupName, String clusterName, String databaseName, String scriptName)	Gets a Kusto cluster database script.
Script	getById(String id)	Gets a Kusto cluster database script.
com.azure.core.http.rest.Response<Script>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Gets a Kusto cluster database script.
com.azure.core.http.rest.Response<Script>	getWithResponse(String resourceGroupName, String clusterName, String databaseName, String scriptName, com.azure.core.util.Context context)	Gets a Kusto cluster database script.
com.azure.core.http.rest.PagedIterable<Script>	listByDatabase(String resourceGroupName, String clusterName, String databaseName)	Returns the list of database scripts for given database.
com.azure.core.http.rest.PagedIterable<Script>	listByDatabase(String resourceGroupName, String clusterName, String databaseName, com.azure.core.util.Context context)	Returns the list of database scripts for given database.

Method Detail

listByDatabase

com.azure.core.http.rest.PagedIterable<Script> listByDatabase(String resourceGroupName,
                                                              String clusterName,
                                                              String databaseName)

Returns the list of database scripts for given database.

Parameters:

resourceGroupName - The name of the resource group containing the Kusto cluster.

clusterName - The name of the Kusto cluster.

databaseName - The name of the database in the Kusto cluster.

Returns:

the list Kusto database script 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.

listByDatabase

com.azure.core.http.rest.PagedIterable<Script> listByDatabase(String resourceGroupName,
                                                              String clusterName,
                                                              String databaseName,
                                                              com.azure.core.util.Context context)

Returns the list of database scripts for given database.

Parameters:

resourceGroupName - The name of the resource group containing the Kusto cluster.

clusterName - The name of the Kusto cluster.

databaseName - The name of the database in the Kusto cluster.

context - The context to associate with this operation.

Returns:

the list Kusto database script 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.

get

Script get(String resourceGroupName,
           String clusterName,
           String databaseName,
           String scriptName)

Gets a Kusto cluster database script.

Parameters:

resourceGroupName - The name of the resource group containing the Kusto cluster.

clusterName - The name of the Kusto cluster.

databaseName - The name of the database in the Kusto cluster.

scriptName - The name of the Kusto database script.

Returns:

a Kusto cluster database script.

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<Script> getWithResponse(String resourceGroupName,
                                                          String clusterName,
                                                          String databaseName,
                                                          String scriptName,
                                                          com.azure.core.util.Context context)

Gets a Kusto cluster database script.

Parameters:

resourceGroupName - The name of the resource group containing the Kusto cluster.

clusterName - The name of the Kusto cluster.

databaseName - The name of the database in the Kusto cluster.

scriptName - The name of the Kusto database script.

context - The context to associate with this operation.

Returns:

a Kusto cluster database script 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 resourceGroupName,
            String clusterName,
            String databaseName,
            String scriptName)

Deletes a Kusto principalAssignment.

Parameters:

resourceGroupName - The name of the resource group containing the Kusto cluster.

clusterName - The name of the Kusto cluster.

databaseName - The name of the database in the Kusto cluster.

scriptName - The name of the Kusto database script.

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 resourceGroupName,
            String clusterName,
            String databaseName,
            String scriptName,
            com.azure.core.util.Context context)

Deletes a Kusto principalAssignment.

Parameters:

resourceGroupName - The name of the resource group containing the Kusto cluster.

clusterName - The name of the Kusto cluster.

databaseName - The name of the database in the Kusto cluster.

scriptName - The name of the Kusto database script.

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.

checkNameAvailability

CheckNameResult checkNameAvailability(String resourceGroupName,
                                      String clusterName,
                                      String databaseName,
                                      ScriptCheckNameRequest scriptName)

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

Parameters:

resourceGroupName - The name of the resource group containing the Kusto cluster.

clusterName - The name of the Kusto cluster.

databaseName - The name of the database in the Kusto cluster.

scriptName - The name of the script.

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 resourceGroupName,
                                                                                     String clusterName,
                                                                                     String databaseName,
                                                                                     ScriptCheckNameRequest scriptName,
                                                                                     com.azure.core.util.Context context)

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

Parameters:

resourceGroupName - The name of the resource group containing the Kusto cluster.

clusterName - The name of the Kusto cluster.

databaseName - The name of the database in the Kusto cluster.

scriptName - The name of the script.

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.

getById

Script getById(String id)

Gets a Kusto cluster database script.

Parameters:

id - the resource ID.

Returns:

a Kusto cluster database script 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<Script> getByIdWithResponse(String id,
                                                              com.azure.core.util.Context context)

Gets a Kusto cluster database script.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

a Kusto cluster database script 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 principalAssignment.

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

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

Script.DefinitionStages.Blank define(String name)

Begins definition for a new Script resource.

Parameters:

name - resource name.

Returns:

the first stage of the new Script definition.