Scripts Interface

public interface Scripts

Resource collection API of Scripts.

Method Summary

Modifier and Type Method and Description
abstract CheckNameResult checkNameAvailability(String resourceGroupName, String clusterName, String databaseName, ScriptCheckNameRequest scriptName)

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

abstract Response<CheckNameResult> checkNameAvailabilityWithResponse(String resourceGroupName, String clusterName, String databaseName, ScriptCheckNameRequest scriptName, Context context)

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

abstract Blank define(String name)

Begins definition for a new Script resource.

abstract void delete(String resourceGroupName, String clusterName, String databaseName, String scriptName)

Deletes a Kusto database script.

abstract void delete(String resourceGroupName, String clusterName, String databaseName, String scriptName, Context context)

Deletes a Kusto database script.

abstract void deleteById(String id)

Deletes a Kusto database script.

abstract void deleteByIdWithResponse(String id, Context context)

Deletes a Kusto database script.

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

Gets a Kusto cluster database script.

abstract Script getById(String id)

Gets a Kusto cluster database script.

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

Gets a Kusto cluster database script.

abstract Response<Script> getWithResponse(String resourceGroupName, String clusterName, String databaseName, String scriptName, Context context)

Gets a Kusto cluster database script.

abstract PagedIterable<Script> listByDatabase(String resourceGroupName, String clusterName, String databaseName)

Returns the list of database scripts for given database.

abstract PagedIterable<Script> listByDatabase(String resourceGroupName, String clusterName, String databaseName, Context context)

Returns the list of database scripts for given database.

Method Details

checkNameAvailability

public abstract 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. The name is case insensitive.
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.

checkNameAvailabilityWithResponse

public abstract Response<CheckNameResult> checkNameAvailabilityWithResponse(String resourceGroupName, String clusterName, String databaseName, ScriptCheckNameRequest scriptName, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
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<T>.

define

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

delete

public abstract void delete(String resourceGroupName, String clusterName, String databaseName, String scriptName)

Deletes a Kusto database script.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
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.

delete

public abstract void delete(String resourceGroupName, String clusterName, String databaseName, String scriptName, Context context)

Deletes a Kusto database script.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
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.

deleteById

public abstract void deleteById(String id)

Deletes a Kusto database script.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Deletes a Kusto database script.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

get

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

Gets a Kusto cluster database script.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
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.

getById

public abstract Script getById(String id)

Gets a Kusto cluster database script.

Parameters:

id - the resource ID.

Returns:

a Kusto cluster database script along with Response<T>.

getByIdWithResponse

public abstract Response<Script> getByIdWithResponse(String id, 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<T>.

getWithResponse

public abstract Response<Script> getWithResponse(String resourceGroupName, String clusterName, String databaseName, String scriptName, Context context)

Gets a Kusto cluster database script.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
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<T>.

listByDatabase

public abstract 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. The name is case insensitive.
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<T>.

listByDatabase

public abstract PagedIterable<Script> listByDatabase(String resourceGroupName, String clusterName, String databaseName, Context context)

Returns the list of database scripts for given database.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
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<T>.

Applies to