AttachedDatabaseConfigurations interface

Package:

@azure/arm-kusto

Interface representing a AttachedDatabaseConfigurations.

Methods

beginCreateOrUpdate(string, string, string, AttachedDatabaseConfiguration, AttachedDatabaseConfigurationsCreateOrUpdateOptionalParams)	Creates or updates an attached database configuration.
beginCreateOrUpdateAndWait(string, string, string, AttachedDatabaseConfiguration, AttachedDatabaseConfigurationsCreateOrUpdateOptionalParams)	Creates or updates an attached database configuration.
beginDelete(string, string, string, AttachedDatabaseConfigurationsDeleteOptionalParams)	Deletes the attached database configuration with the given name.
beginDeleteAndWait(string, string, string, AttachedDatabaseConfigurationsDeleteOptionalParams)	Deletes the attached database configuration with the given name.
checkNameAvailability(string, string, AttachedDatabaseConfigurationsCheckNameRequest, AttachedDatabaseConfigurationsCheckNameAvailabilityOptionalParams)	Checks that the attached database configuration resource name is valid and is not already in use.
get(string, string, string, AttachedDatabaseConfigurationsGetOptionalParams)	Returns an attached database configuration.
listByCluster(string, string, AttachedDatabaseConfigurationsListByClusterOptionalParams)	Returns the list of attached database configurations of the given Kusto cluster.

Method Details

beginCreateOrUpdate(string, string, string, AttachedDatabaseConfiguration, AttachedDatabaseConfigurationsCreateOrUpdateOptionalParams)

Creates or updates an attached database configuration.

function beginCreateOrUpdate(resourceGroupName: string, clusterName: string, attachedDatabaseConfigurationName: string, parameters: AttachedDatabaseConfiguration, options?: AttachedDatabaseConfigurationsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<AttachedDatabaseConfiguration>, AttachedDatabaseConfiguration>>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

attachedDatabaseConfigurationName

string

The name of the attached database configuration.

parameters

AttachedDatabaseConfiguration

The database parameters supplied to the CreateOrUpdate operation.

options

AttachedDatabaseConfigurationsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, AttachedDatabaseConfiguration, AttachedDatabaseConfigurationsCreateOrUpdateOptionalParams)

Creates or updates an attached database configuration.

function beginCreateOrUpdateAndWait(resourceGroupName: string, clusterName: string, attachedDatabaseConfigurationName: string, parameters: AttachedDatabaseConfiguration, options?: AttachedDatabaseConfigurationsCreateOrUpdateOptionalParams): Promise<AttachedDatabaseConfiguration>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

attachedDatabaseConfigurationName

string

The name of the attached database configuration.

parameters

AttachedDatabaseConfiguration

The database parameters supplied to the CreateOrUpdate operation.

options

AttachedDatabaseConfigurationsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<AttachedDatabaseConfiguration>

beginDelete(string, string, string, AttachedDatabaseConfigurationsDeleteOptionalParams)

Deletes the attached database configuration with the given name.

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

attachedDatabaseConfigurationName

string

The name of the attached database configuration.

options

AttachedDatabaseConfigurationsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, AttachedDatabaseConfigurationsDeleteOptionalParams)

Deletes the attached database configuration with the given name.

function beginDeleteAndWait(resourceGroupName: string, clusterName: string, attachedDatabaseConfigurationName: string, options?: AttachedDatabaseConfigurationsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

attachedDatabaseConfigurationName

string

The name of the attached database configuration.

options

AttachedDatabaseConfigurationsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

checkNameAvailability(string, string, AttachedDatabaseConfigurationsCheckNameRequest, AttachedDatabaseConfigurationsCheckNameAvailabilityOptionalParams)

Checks that the attached database configuration resource name is valid and is not already in use.

function checkNameAvailability(resourceGroupName: string, clusterName: string, resourceName: AttachedDatabaseConfigurationsCheckNameRequest, options?: AttachedDatabaseConfigurationsCheckNameAvailabilityOptionalParams): 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

AttachedDatabaseConfigurationsCheckNameRequest

The name of the resource.

options

AttachedDatabaseConfigurationsCheckNameAvailabilityOptionalParams

The options parameters.

Returns

Promise<CheckNameResult>

get(string, string, string, AttachedDatabaseConfigurationsGetOptionalParams)

Returns an attached database configuration.

function get(resourceGroupName: string, clusterName: string, attachedDatabaseConfigurationName: string, options?: AttachedDatabaseConfigurationsGetOptionalParams): Promise<AttachedDatabaseConfiguration>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

attachedDatabaseConfigurationName

string

The name of the attached database configuration.

options

AttachedDatabaseConfigurationsGetOptionalParams

The options parameters.

Returns

Promise<AttachedDatabaseConfiguration>

listByCluster(string, string, AttachedDatabaseConfigurationsListByClusterOptionalParams)

Returns the list of attached database configurations of the given Kusto cluster.

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

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

options

AttachedDatabaseConfigurationsListByClusterOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<AttachedDatabaseConfiguration, AttachedDatabaseConfiguration[], PageSettings>