KustoPoolAttachedDatabaseConfigurations interface

Package:

@azure/arm-synapse

Interface representing a KustoPoolAttachedDatabaseConfigurations.

Methods

beginCreateOrUpdate(string, string, string, string, AttachedDatabaseConfiguration, KustoPoolAttachedDatabaseConfigurationsCreateOrUpdateOptionalParams)	Creates or updates an attached database configuration.
beginCreateOrUpdateAndWait(string, string, string, string, AttachedDatabaseConfiguration, KustoPoolAttachedDatabaseConfigurationsCreateOrUpdateOptionalParams)	Creates or updates an attached database configuration.
beginDelete(string, string, string, string, KustoPoolAttachedDatabaseConfigurationsDeleteOptionalParams)	Deletes the attached database configuration with the given name.
beginDeleteAndWait(string, string, string, string, KustoPoolAttachedDatabaseConfigurationsDeleteOptionalParams)	Deletes the attached database configuration with the given name.
get(string, string, string, string, KustoPoolAttachedDatabaseConfigurationsGetOptionalParams)	Returns an attached database configuration.
listByKustoPool(string, string, string, KustoPoolAttachedDatabaseConfigurationsListByKustoPoolOptionalParams)	Returns the list of attached database configurations of the given Kusto Pool.

Method Details

beginCreateOrUpdate(string, string, string, string, AttachedDatabaseConfiguration, KustoPoolAttachedDatabaseConfigurationsCreateOrUpdateOptionalParams)

Creates or updates an attached database configuration.

function beginCreateOrUpdate(workspaceName: string, kustoPoolName: string, attachedDatabaseConfigurationName: string, resourceGroupName: string, parameters: AttachedDatabaseConfiguration, options?: KustoPoolAttachedDatabaseConfigurationsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<AttachedDatabaseConfiguration>, AttachedDatabaseConfiguration>>

Parameters

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

attachedDatabaseConfigurationName

string

The name of the attached database configuration.

resourceGroupName

string

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

parameters

AttachedDatabaseConfiguration

The database parameters supplied to the CreateOrUpdate operation.

options

KustoPoolAttachedDatabaseConfigurationsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<AttachedDatabaseConfiguration>, AttachedDatabaseConfiguration>>

beginCreateOrUpdateAndWait(string, string, string, string, AttachedDatabaseConfiguration, KustoPoolAttachedDatabaseConfigurationsCreateOrUpdateOptionalParams)

Creates or updates an attached database configuration.

function beginCreateOrUpdateAndWait(workspaceName: string, kustoPoolName: string, attachedDatabaseConfigurationName: string, resourceGroupName: string, parameters: AttachedDatabaseConfiguration, options?: KustoPoolAttachedDatabaseConfigurationsCreateOrUpdateOptionalParams): Promise<AttachedDatabaseConfiguration>

Parameters

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

attachedDatabaseConfigurationName

string

The name of the attached database configuration.

resourceGroupName

string

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

parameters

AttachedDatabaseConfiguration

The database parameters supplied to the CreateOrUpdate operation.

options

KustoPoolAttachedDatabaseConfigurationsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<AttachedDatabaseConfiguration>

beginDelete(string, string, string, string, KustoPoolAttachedDatabaseConfigurationsDeleteOptionalParams)

Deletes the attached database configuration with the given name.

function beginDelete(workspaceName: string, kustoPoolName: string, attachedDatabaseConfigurationName: string, resourceGroupName: string, options?: KustoPoolAttachedDatabaseConfigurationsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

attachedDatabaseConfigurationName

string

The name of the attached database configuration.

resourceGroupName

string

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

options

KustoPoolAttachedDatabaseConfigurationsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, string, string, KustoPoolAttachedDatabaseConfigurationsDeleteOptionalParams)

Deletes the attached database configuration with the given name.

function beginDeleteAndWait(workspaceName: string, kustoPoolName: string, attachedDatabaseConfigurationName: string, resourceGroupName: string, options?: KustoPoolAttachedDatabaseConfigurationsDeleteOptionalParams): Promise<void>

Parameters

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

attachedDatabaseConfigurationName

string

The name of the attached database configuration.

resourceGroupName

string

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

options

KustoPoolAttachedDatabaseConfigurationsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, KustoPoolAttachedDatabaseConfigurationsGetOptionalParams)

Returns an attached database configuration.

function get(workspaceName: string, kustoPoolName: string, attachedDatabaseConfigurationName: string, resourceGroupName: string, options?: KustoPoolAttachedDatabaseConfigurationsGetOptionalParams): Promise<AttachedDatabaseConfiguration>

Parameters

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

attachedDatabaseConfigurationName

string

The name of the attached database configuration.

resourceGroupName

string

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

options

KustoPoolAttachedDatabaseConfigurationsGetOptionalParams

The options parameters.

Returns

Promise<AttachedDatabaseConfiguration>

listByKustoPool(string, string, string, KustoPoolAttachedDatabaseConfigurationsListByKustoPoolOptionalParams)

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

function listByKustoPool(workspaceName: string, kustoPoolName: string, resourceGroupName: string, options?: KustoPoolAttachedDatabaseConfigurationsListByKustoPoolOptionalParams): PagedAsyncIterableIterator<AttachedDatabaseConfiguration, AttachedDatabaseConfiguration[], PageSettings>

Parameters

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

resourceGroupName

string

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

options

KustoPoolAttachedDatabaseConfigurationsListByKustoPoolOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<AttachedDatabaseConfiguration, AttachedDatabaseConfiguration[], PageSettings>