Package com.azure.resourcemanager.kusto.fluent

Interface ScriptsClient

public interface ScriptsClient

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

Method Summary

Modifier and Type	Method	Description
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ScriptInner>,ScriptInner>	beginCreateOrUpdate(String resourceGroupName, String clusterName, String databaseName, String scriptName, ScriptInner parameters)	Creates a Kusto database script.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ScriptInner>,ScriptInner>	beginCreateOrUpdate(String resourceGroupName, String clusterName, String databaseName, String scriptName, ScriptInner parameters, com.azure.core.util.Context context)	Creates a Kusto database script.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginDelete(String resourceGroupName, String clusterName, String databaseName, String scriptName)	Deletes a Kusto principalAssignment.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginDelete(String resourceGroupName, String clusterName, String databaseName, String scriptName, com.azure.core.util.Context context)	Deletes a Kusto principalAssignment.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ScriptInner>,ScriptInner>	beginUpdate(String resourceGroupName, String clusterName, String databaseName, String scriptName, ScriptInner parameters)	Updates a database script.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ScriptInner>,ScriptInner>	beginUpdate(String resourceGroupName, String clusterName, String databaseName, String scriptName, ScriptInner parameters, com.azure.core.util.Context context)	Updates a database script.
CheckNameResultInner	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<CheckNameResultInner>	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.
ScriptInner	createOrUpdate(String resourceGroupName, String clusterName, String databaseName, String scriptName, ScriptInner parameters)	Creates a Kusto database script.
ScriptInner	createOrUpdate(String resourceGroupName, String clusterName, String databaseName, String scriptName, ScriptInner parameters, com.azure.core.util.Context context)	Creates a Kusto database script.
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.
ScriptInner	get(String resourceGroupName, String clusterName, String databaseName, String scriptName)	Gets a Kusto cluster database script.
com.azure.core.http.rest.Response<ScriptInner>	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<ScriptInner>	listByDatabase(String resourceGroupName, String clusterName, String databaseName)	Returns the list of database scripts for given database.
com.azure.core.http.rest.PagedIterable<ScriptInner>	listByDatabase(String resourceGroupName, String clusterName, String databaseName, com.azure.core.util.Context context)	Returns the list of database scripts for given database.
ScriptInner	update(String resourceGroupName, String clusterName, String databaseName, String scriptName, ScriptInner parameters)	Updates a database script.
ScriptInner	update(String resourceGroupName, String clusterName, String databaseName, String scriptName, ScriptInner parameters, com.azure.core.util.Context context)	Updates a database script.

Method Detail

listByDatabase

com.azure.core.http.rest.PagedIterable<ScriptInner> 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<ScriptInner> 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

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

beginCreateOrUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ScriptInner>,ScriptInner> beginCreateOrUpdate(String resourceGroupName,
                                                                                                                                        String clusterName,
                                                                                                                                        String databaseName,
                                                                                                                                        String scriptName,
                                                                                                                                        ScriptInner parameters)

Creates a Kusto 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.

parameters - The Kusto Script parameters contains the KQL to run.

Returns:

the SyncPoller for polling of class representing a 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.

beginCreateOrUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ScriptInner>,ScriptInner> beginCreateOrUpdate(String resourceGroupName,
                                                                                                                                        String clusterName,
                                                                                                                                        String databaseName,
                                                                                                                                        String scriptName,
                                                                                                                                        ScriptInner parameters,
                                                                                                                                        com.azure.core.util.Context context)

Creates a Kusto 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.

parameters - The Kusto Script parameters contains the KQL to run.

context - The context to associate with this operation.

Returns:

the SyncPoller for polling of class representing a 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.

createOrUpdate

ScriptInner createOrUpdate(String resourceGroupName,
                           String clusterName,
                           String databaseName,
                           String scriptName,
                           ScriptInner parameters)

Creates a Kusto 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.

parameters - The Kusto Script parameters contains the KQL to run.

Returns:

class representing a 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.

createOrUpdate

ScriptInner createOrUpdate(String resourceGroupName,
                           String clusterName,
                           String databaseName,
                           String scriptName,
                           ScriptInner parameters,
                           com.azure.core.util.Context context)

Creates a Kusto 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.

parameters - The Kusto Script parameters contains the KQL to run.

context - The context to associate with this operation.

Returns:

class representing a 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.

beginUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ScriptInner>,ScriptInner> beginUpdate(String resourceGroupName,
                                                                                                                                String clusterName,
                                                                                                                                String databaseName,
                                                                                                                                String scriptName,
                                                                                                                                ScriptInner parameters)

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

parameters - The Kusto Script parameters contains to the KQL to run.

Returns:

the SyncPoller for polling of class representing a 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.

beginUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ScriptInner>,ScriptInner> beginUpdate(String resourceGroupName,
                                                                                                                                String clusterName,
                                                                                                                                String databaseName,
                                                                                                                                String scriptName,
                                                                                                                                ScriptInner parameters,
                                                                                                                                com.azure.core.util.Context context)

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

parameters - The Kusto Script parameters contains to the KQL to run.

context - The context to associate with this operation.

Returns:

the SyncPoller for polling of class representing a 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.

update

ScriptInner update(String resourceGroupName,
                   String clusterName,
                   String databaseName,
                   String scriptName,
                   ScriptInner parameters)

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

parameters - The Kusto Script parameters contains to the KQL to run.

Returns:

class representing a 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.

update

ScriptInner update(String resourceGroupName,
                   String clusterName,
                   String databaseName,
                   String scriptName,
                   ScriptInner parameters,
                   com.azure.core.util.Context context)

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

parameters - The Kusto Script parameters contains to the KQL to run.

context - The context to associate with this operation.

Returns:

class representing a 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.

beginDelete

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(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.

Returns:

the SyncPoller for polling of long-running 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.

beginDelete

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(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.

Returns:

the SyncPoller for polling of long-running 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.

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

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