DatabasesOperations interface

Package:

@azure/arm-kusto

Interface representing a Databases operations.

Properties

addPrincipals	Add Database principals permissions.
beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginUpdate
beginUpdateAndWait
checkNameAvailability	Checks that the databases resource name is valid and is not already in use.
createOrUpdate	Creates or updates a database.
delete	Deletes the database with the given name.
get	Returns a database.
listByCluster	Returns the list of databases of the given Kusto cluster.
listPrincipals	Returns a list of database principals of the given Kusto cluster and database.
removePrincipals	Remove Database principals permissions.
update	Updates a database.

Property Details

addPrincipals

Add Database principals permissions.

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

Property Value

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

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesDeleteOptionalParams) => Promise<void>

beginUpdate

Warning

This API is now deprecated.

use update instead

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

Property Value

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

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

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

Property Value

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

checkNameAvailability

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

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

Property Value

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

createOrUpdate

Creates or updates a database.

createOrUpdate: (resourceGroupName: string, clusterName: string, databaseName: string, parameters: DatabaseUnion, options?: DatabasesCreateOrUpdateOptionalParams) => PollerLike<OperationState<DatabaseUnion>, DatabaseUnion>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, parameters: DatabaseUnion, options?: DatabasesCreateOrUpdateOptionalParams) => PollerLike<OperationState<DatabaseUnion>, DatabaseUnion>

delete

Deletes the database with the given name.

delete: (resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Returns a database.

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

Property Value

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

listByCluster

Returns the list of databases of the given Kusto cluster.

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

Property Value

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

listPrincipals

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

listPrincipals: (resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesListPrincipalsOptionalParams) => PagedAsyncIterableIterator<DatabasePrincipal, DatabasePrincipal[], PageSettings>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesListPrincipalsOptionalParams) => PagedAsyncIterableIterator<DatabasePrincipal, DatabasePrincipal[], PageSettings>

removePrincipals

Remove Database principals permissions.

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

Property Value

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

update

Updates a database.

update: (resourceGroupName: string, clusterName: string, databaseName: string, parameters: DatabaseUnion, options?: DatabasesUpdateOptionalParams) => PollerLike<OperationState<DatabaseUnion>, DatabaseUnion>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, parameters: DatabaseUnion, options?: DatabasesUpdateOptionalParams) => PollerLike<OperationState<DatabaseUnion>, DatabaseUnion>