Databases interface

Package:

@azure/arm-kusto

Interface representing a Databases.

Methods

addPrincipals(string, string, string, DatabasePrincipalListRequest, DatabasesAddPrincipalsOptionalParams)	Add Database principals permissions.
beginCreateOrUpdate(string, string, string, DatabaseUnion, DatabasesCreateOrUpdateOptionalParams)	Creates or updates a database.
beginCreateOrUpdateAndWait(string, string, string, DatabaseUnion, DatabasesCreateOrUpdateOptionalParams)	Creates or updates a database.
beginDelete(string, string, string, DatabasesDeleteOptionalParams)	Deletes the database with the given name.
beginDeleteAndWait(string, string, string, DatabasesDeleteOptionalParams)	Deletes the database with the given name.
beginUpdate(string, string, string, DatabaseUnion, DatabasesUpdateOptionalParams)	Updates a database.
beginUpdateAndWait(string, string, string, DatabaseUnion, DatabasesUpdateOptionalParams)	Updates a database.
checkNameAvailability(string, string, CheckNameRequest, DatabasesCheckNameAvailabilityOptionalParams)	Checks that the databases resource name is valid and is not already in use.
get(string, string, string, DatabasesGetOptionalParams)	Returns a database.
listByCluster(string, string, DatabasesListByClusterOptionalParams)	Returns the list of databases of the given Kusto cluster.
listPrincipals(string, string, string, DatabasesListPrincipalsOptionalParams)	Returns a list of database principals of the given Kusto cluster and database.
removePrincipals(string, string, string, DatabasePrincipalListRequest, DatabasesRemovePrincipalsOptionalParams)	Remove Database principals permissions.

Method Details

addPrincipals(string, string, string, DatabasePrincipalListRequest, DatabasesAddPrincipalsOptionalParams)

Add Database principals permissions.

function addPrincipals(resourceGroupName: string, clusterName: string, databaseName: string, databasePrincipalsToAdd: DatabasePrincipalListRequest, options?: DatabasesAddPrincipalsOptionalParams): Promise<DatabasePrincipalListResult>

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.

databasePrincipalsToAdd

DatabasePrincipalListRequest

List of database principals to add.

options

DatabasesAddPrincipalsOptionalParams

The options parameters.

Returns

Promise<DatabasePrincipalListResult>

beginCreateOrUpdate(string, string, string, DatabaseUnion, DatabasesCreateOrUpdateOptionalParams)

Creates or updates a database.

function beginCreateOrUpdate(resourceGroupName: string, clusterName: string, databaseName: string, parameters: DatabaseUnion, options?: DatabasesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DatabaseUnion>, DatabaseUnion>>

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.

parameters

DatabaseUnion

The database parameters supplied to the CreateOrUpdate operation.

options

DatabasesCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, DatabaseUnion, DatabasesCreateOrUpdateOptionalParams)

Creates or updates a database.

function beginCreateOrUpdateAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: DatabaseUnion, options?: DatabasesCreateOrUpdateOptionalParams): Promise<DatabaseUnion>

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.

parameters

DatabaseUnion

The database parameters supplied to the CreateOrUpdate operation.

options

DatabasesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<DatabaseUnion>

beginDelete(string, string, string, DatabasesDeleteOptionalParams)

Deletes the database with the given name.

function beginDelete(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesDeleteOptionalParams): 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.

options

DatabasesDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, DatabasesDeleteOptionalParams)

Deletes the database with the given name.

function beginDeleteAndWait(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesDeleteOptionalParams): 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.

options

DatabasesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, DatabaseUnion, DatabasesUpdateOptionalParams)

Updates a database.

function beginUpdate(resourceGroupName: string, clusterName: string, databaseName: string, parameters: DatabaseUnion, options?: DatabasesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DatabaseUnion>, DatabaseUnion>>

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.

parameters

DatabaseUnion

The database parameters supplied to the Update operation.

options

DatabasesUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, string, DatabaseUnion, DatabasesUpdateOptionalParams)

Updates a database.

function beginUpdateAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: DatabaseUnion, options?: DatabasesUpdateOptionalParams): Promise<DatabaseUnion>

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.

parameters

DatabaseUnion

The database parameters supplied to the Update operation.

options

DatabasesUpdateOptionalParams

The options parameters.

Returns

Promise<DatabaseUnion>

checkNameAvailability(string, string, CheckNameRequest, DatabasesCheckNameAvailabilityOptionalParams)

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

function checkNameAvailability(resourceGroupName: string, clusterName: string, resourceName: CheckNameRequest, options?: DatabasesCheckNameAvailabilityOptionalParams): Promise<CheckNameResult>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

resourceName

CheckNameRequest

The name of the resource.

options

DatabasesCheckNameAvailabilityOptionalParams

The options parameters.

Returns

Promise<CheckNameResult>

get(string, string, string, DatabasesGetOptionalParams)

Returns a database.

function get(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesGetOptionalParams): Promise<DatabaseUnion>

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

DatabasesGetOptionalParams

The options parameters.

Returns

Promise<DatabaseUnion>

listByCluster(string, string, DatabasesListByClusterOptionalParams)

Returns the list of databases of the given Kusto cluster.

function listByCluster(resourceGroupName: string, clusterName: string, options?: DatabasesListByClusterOptionalParams): PagedAsyncIterableIterator<DatabaseUnion, DatabaseUnion[], PageSettings>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

options

DatabasesListByClusterOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DatabaseUnion, DatabaseUnion[], PageSettings>

listPrincipals(string, string, string, DatabasesListPrincipalsOptionalParams)

Returns a list of database principals of the given Kusto cluster and database.

function listPrincipals(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesListPrincipalsOptionalParams): PagedAsyncIterableIterator<DatabasePrincipal, DatabasePrincipal[], 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

DatabasesListPrincipalsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DatabasePrincipal, DatabasePrincipal[], PageSettings>

removePrincipals(string, string, string, DatabasePrincipalListRequest, DatabasesRemovePrincipalsOptionalParams)

Remove Database principals permissions.

function removePrincipals(resourceGroupName: string, clusterName: string, databaseName: string, databasePrincipalsToRemove: DatabasePrincipalListRequest, options?: DatabasesRemovePrincipalsOptionalParams): Promise<DatabasePrincipalListResult>

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.

databasePrincipalsToRemove

DatabasePrincipalListRequest

List of database principals to remove.

options

DatabasesRemovePrincipalsOptionalParams

The options parameters.

Returns

Promise<DatabasePrincipalListResult>