Share via

KustoPoolDataConnections interface

  • Reference
Package:
@azure/arm-synapse

Interface representing a KustoPoolDataConnections.

Methods

beginCreateOrUpdate(string, string, string, string, string, DataConnectionUnion, KustoPoolDataConnectionsCreateOrUpdateOptionalParams)

Creates or updates a data connection.
beginCreateOrUpdateAndWait(string, string, string, string, string, DataConnectionUnion, KustoPoolDataConnectionsCreateOrUpdateOptionalParams)

Creates or updates a data connection.
beginDataConnectionValidation(string, string, string, string, DataConnectionValidation, KustoPoolDataConnectionsDataConnectionValidationOptionalParams)

Checks that the data connection parameters are valid.
beginDataConnectionValidationAndWait(string, string, string, string, DataConnectionValidation, KustoPoolDataConnectionsDataConnectionValidationOptionalParams)

Checks that the data connection parameters are valid.
beginDelete(string, string, string, string, string, KustoPoolDataConnectionsDeleteOptionalParams)

Deletes the data connection with the given name.
beginDeleteAndWait(string, string, string, string, string, KustoPoolDataConnectionsDeleteOptionalParams)

Deletes the data connection with the given name.
beginUpdate(string, string, string, string, string, DataConnectionUnion, KustoPoolDataConnectionsUpdateOptionalParams)

Updates a data connection.
beginUpdateAndWait(string, string, string, string, string, DataConnectionUnion, KustoPoolDataConnectionsUpdateOptionalParams)

Updates a data connection.
checkNameAvailability(string, string, string, string, DataConnectionCheckNameRequest, KustoPoolDataConnectionsCheckNameAvailabilityOptionalParams)

Checks that the data connection name is valid and is not already in use.
get(string, string, string, string, string, KustoPoolDataConnectionsGetOptionalParams)

Returns a data connection.
listByDatabase(string, string, string, string, KustoPoolDataConnectionsListByDatabaseOptionalParams)

Returns the list of data connections of the given Kusto pool database.

Method Details

beginCreateOrUpdate(string, string, string, string, string, DataConnectionUnion, KustoPoolDataConnectionsCreateOrUpdateOptionalParams)

Creates or updates a data connection.

function beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, kustoPoolName: string, databaseName: string, dataConnectionName: string, parameters: DataConnectionUnion, options?: KustoPoolDataConnectionsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<DataConnectionUnion>, DataConnectionUnion>>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

databaseName

string

The name of the database in the Kusto pool.

dataConnectionName

string

The name of the data connection.

parameters
DataConnectionUnion

The data connection parameters supplied to the CreateOrUpdate operation.

options
KustoPoolDataConnectionsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, string, string, DataConnectionUnion, KustoPoolDataConnectionsCreateOrUpdateOptionalParams)

Creates or updates a data connection.

function beginCreateOrUpdateAndWait(resourceGroupName: string, workspaceName: string, kustoPoolName: string, databaseName: string, dataConnectionName: string, parameters: DataConnectionUnion, options?: KustoPoolDataConnectionsCreateOrUpdateOptionalParams): Promise<DataConnectionUnion>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

databaseName

string

The name of the database in the Kusto pool.

dataConnectionName

string

The name of the data connection.

parameters
DataConnectionUnion

The data connection parameters supplied to the CreateOrUpdate operation.

options
KustoPoolDataConnectionsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<DataConnectionUnion>

beginDataConnectionValidation(string, string, string, string, DataConnectionValidation, KustoPoolDataConnectionsDataConnectionValidationOptionalParams)

Checks that the data connection parameters are valid.

function beginDataConnectionValidation(resourceGroupName: string, workspaceName: string, kustoPoolName: string, databaseName: string, parameters: DataConnectionValidation, options?: KustoPoolDataConnectionsDataConnectionValidationOptionalParams): Promise<PollerLike<PollOperationState<DataConnectionValidationListResult>, DataConnectionValidationListResult>>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

databaseName

string

The name of the database in the Kusto pool.

parameters
DataConnectionValidation

The data connection parameters supplied to the CreateOrUpdate operation.

options
KustoPoolDataConnectionsDataConnectionValidationOptionalParams

The options parameters.

Returns

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

beginDataConnectionValidationAndWait(string, string, string, string, DataConnectionValidation, KustoPoolDataConnectionsDataConnectionValidationOptionalParams)

Checks that the data connection parameters are valid.

function beginDataConnectionValidationAndWait(resourceGroupName: string, workspaceName: string, kustoPoolName: string, databaseName: string, parameters: DataConnectionValidation, options?: KustoPoolDataConnectionsDataConnectionValidationOptionalParams): Promise<DataConnectionValidationListResult>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

databaseName

string

The name of the database in the Kusto pool.

parameters
DataConnectionValidation

The data connection parameters supplied to the CreateOrUpdate operation.

options
KustoPoolDataConnectionsDataConnectionValidationOptionalParams

The options parameters.

Returns

Promise<DataConnectionValidationListResult>

beginDelete(string, string, string, string, string, KustoPoolDataConnectionsDeleteOptionalParams)

Deletes the data connection with the given name.

function beginDelete(resourceGroupName: string, workspaceName: string, kustoPoolName: string, databaseName: string, dataConnectionName: string, options?: KustoPoolDataConnectionsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

databaseName

string

The name of the database in the Kusto pool.

dataConnectionName

string

The name of the data connection.

options
KustoPoolDataConnectionsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, string, string, KustoPoolDataConnectionsDeleteOptionalParams)

Deletes the data connection with the given name.

function beginDeleteAndWait(resourceGroupName: string, workspaceName: string, kustoPoolName: string, databaseName: string, dataConnectionName: string, options?: KustoPoolDataConnectionsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

databaseName

string

The name of the database in the Kusto pool.

dataConnectionName

string

The name of the data connection.

options
KustoPoolDataConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, string, string, DataConnectionUnion, KustoPoolDataConnectionsUpdateOptionalParams)

Updates a data connection.

function beginUpdate(resourceGroupName: string, workspaceName: string, kustoPoolName: string, databaseName: string, dataConnectionName: string, parameters: DataConnectionUnion, options?: KustoPoolDataConnectionsUpdateOptionalParams): Promise<PollerLike<PollOperationState<DataConnectionUnion>, DataConnectionUnion>>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

databaseName

string

The name of the database in the Kusto pool.

dataConnectionName

string

The name of the data connection.

parameters
DataConnectionUnion

The data connection parameters supplied to the Update operation.

options
KustoPoolDataConnectionsUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, string, string, string, DataConnectionUnion, KustoPoolDataConnectionsUpdateOptionalParams)

Updates a data connection.

function beginUpdateAndWait(resourceGroupName: string, workspaceName: string, kustoPoolName: string, databaseName: string, dataConnectionName: string, parameters: DataConnectionUnion, options?: KustoPoolDataConnectionsUpdateOptionalParams): Promise<DataConnectionUnion>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

databaseName

string

The name of the database in the Kusto pool.

dataConnectionName

string

The name of the data connection.

parameters
DataConnectionUnion

The data connection parameters supplied to the Update operation.

options
KustoPoolDataConnectionsUpdateOptionalParams

The options parameters.

Returns

Promise<DataConnectionUnion>

checkNameAvailability(string, string, string, string, DataConnectionCheckNameRequest, KustoPoolDataConnectionsCheckNameAvailabilityOptionalParams)

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

function checkNameAvailability(resourceGroupName: string, workspaceName: string, kustoPoolName: string, databaseName: string, dataConnectionName: DataConnectionCheckNameRequest, options?: KustoPoolDataConnectionsCheckNameAvailabilityOptionalParams): Promise<CheckNameResult>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

databaseName

string

The name of the database in the Kusto pool.

dataConnectionName
DataConnectionCheckNameRequest

The name of the data connection.

options
KustoPoolDataConnectionsCheckNameAvailabilityOptionalParams

The options parameters.

Returns

Promise<CheckNameResult>

get(string, string, string, string, string, KustoPoolDataConnectionsGetOptionalParams)

Returns a data connection.

function get(resourceGroupName: string, workspaceName: string, kustoPoolName: string, databaseName: string, dataConnectionName: string, options?: KustoPoolDataConnectionsGetOptionalParams): Promise<DataConnectionUnion>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

databaseName

string

The name of the database in the Kusto pool.

dataConnectionName

string

The name of the data connection.

options
KustoPoolDataConnectionsGetOptionalParams

The options parameters.

Returns

Promise<DataConnectionUnion>

listByDatabase(string, string, string, string, KustoPoolDataConnectionsListByDatabaseOptionalParams)

Returns the list of data connections of the given Kusto pool database.

function listByDatabase(resourceGroupName: string, workspaceName: string, kustoPoolName: string, databaseName: string, options?: KustoPoolDataConnectionsListByDatabaseOptionalParams): PagedAsyncIterableIterator<DataConnectionUnion, DataConnectionUnion[], PageSettings>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

databaseName

string

The name of the database in the Kusto pool.

options
KustoPoolDataConnectionsListByDatabaseOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DataConnectionUnion, DataConnectionUnion[], PageSettings>