Share via

Scripts interface

  • Reference
Package:
@azure/arm-kusto

Interface representing a Scripts.

Methods

beginCreateOrUpdate(string, string, string, string, Script, ScriptsCreateOrUpdateOptionalParams)

Creates a Kusto database script.
beginCreateOrUpdateAndWait(string, string, string, string, Script, ScriptsCreateOrUpdateOptionalParams)

Creates a Kusto database script.
beginDelete(string, string, string, string, ScriptsDeleteOptionalParams)

Deletes a Kusto database script.
beginDeleteAndWait(string, string, string, string, ScriptsDeleteOptionalParams)

Deletes a Kusto database script.
beginUpdate(string, string, string, string, Script, ScriptsUpdateOptionalParams)

Updates a database script.
beginUpdateAndWait(string, string, string, string, Script, ScriptsUpdateOptionalParams)

Updates a database script.
checkNameAvailability(string, string, string, ScriptCheckNameRequest, ScriptsCheckNameAvailabilityOptionalParams)

Checks that the script name is valid and is not already in use.
get(string, string, string, string, ScriptsGetOptionalParams)

Gets a Kusto cluster database script.
listByDatabase(string, string, string, ScriptsListByDatabaseOptionalParams)

Returns the list of database scripts for given database.

Method Details

beginCreateOrUpdate(string, string, string, string, Script, ScriptsCreateOrUpdateOptionalParams)

Creates a Kusto database script.

function beginCreateOrUpdate(resourceGroupName: string, clusterName: string, databaseName: string, scriptName: string, parameters: Script, options?: ScriptsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Script>, Script>>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

databaseName

string

The name of the database in the Kusto cluster.

scriptName

string

The name of the Kusto database script.

parameters
Script

The Kusto Script parameters contains the KQL to run.

options
ScriptsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Script>, Script>>

beginCreateOrUpdateAndWait(string, string, string, string, Script, ScriptsCreateOrUpdateOptionalParams)

Creates a Kusto database script.

function beginCreateOrUpdateAndWait(resourceGroupName: string, clusterName: string, databaseName: string, scriptName: string, parameters: Script, options?: ScriptsCreateOrUpdateOptionalParams): Promise<Script>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

databaseName

string

The name of the database in the Kusto cluster.

scriptName

string

The name of the Kusto database script.

parameters
Script

The Kusto Script parameters contains the KQL to run.

options
ScriptsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Script>

beginDelete(string, string, string, string, ScriptsDeleteOptionalParams)

Deletes a Kusto database script.

function beginDelete(resourceGroupName: string, clusterName: string, databaseName: string, scriptName: string, options?: ScriptsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

databaseName

string

The name of the database in the Kusto cluster.

scriptName

string

The name of the Kusto database script.

options
ScriptsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, string, ScriptsDeleteOptionalParams)

Deletes a Kusto database script.

function beginDeleteAndWait(resourceGroupName: string, clusterName: string, databaseName: string, scriptName: string, options?: ScriptsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

databaseName

string

The name of the database in the Kusto cluster.

scriptName

string

The name of the Kusto database script.

options
ScriptsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, string, Script, ScriptsUpdateOptionalParams)

Updates a database script.

function beginUpdate(resourceGroupName: string, clusterName: string, databaseName: string, scriptName: string, parameters: Script, options?: ScriptsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Script>, Script>>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

databaseName

string

The name of the database in the Kusto cluster.

scriptName

string

The name of the Kusto database script.

parameters
Script

The Kusto Script parameters contains to the KQL to run.

options
ScriptsUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Script>, Script>>

beginUpdateAndWait(string, string, string, string, Script, ScriptsUpdateOptionalParams)

Updates a database script.

function beginUpdateAndWait(resourceGroupName: string, clusterName: string, databaseName: string, scriptName: string, parameters: Script, options?: ScriptsUpdateOptionalParams): Promise<Script>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

databaseName

string

The name of the database in the Kusto cluster.

scriptName

string

The name of the Kusto database script.

parameters
Script

The Kusto Script parameters contains to the KQL to run.

options
ScriptsUpdateOptionalParams

The options parameters.

Returns

Promise<Script>

checkNameAvailability(string, string, string, ScriptCheckNameRequest, ScriptsCheckNameAvailabilityOptionalParams)

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

function checkNameAvailability(resourceGroupName: string, clusterName: string, databaseName: string, scriptName: ScriptCheckNameRequest, options?: ScriptsCheckNameAvailabilityOptionalParams): Promise<CheckNameResult>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

databaseName

string

The name of the database in the Kusto cluster.

scriptName
ScriptCheckNameRequest

The name of the script.

options
ScriptsCheckNameAvailabilityOptionalParams

The options parameters.

Returns

Promise<CheckNameResult>

get(string, string, string, string, ScriptsGetOptionalParams)

Gets a Kusto cluster database script.

function get(resourceGroupName: string, clusterName: string, databaseName: string, scriptName: string, options?: ScriptsGetOptionalParams): Promise<Script>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

databaseName

string

The name of the database in the Kusto cluster.

scriptName

string

The name of the Kusto database script.

options
ScriptsGetOptionalParams

The options parameters.

Returns

Promise<Script>

listByDatabase(string, string, string, ScriptsListByDatabaseOptionalParams)

Returns the list of database scripts for given database.

function listByDatabase(resourceGroupName: string, clusterName: string, databaseName: string, options?: ScriptsListByDatabaseOptionalParams): PagedAsyncIterableIterator<Script, Script[], PageSettings>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

databaseName

string

The name of the database in the Kusto cluster.

options
ScriptsListByDatabaseOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Script, Script[], PageSettings>