DataConnectionsOperations interface

Package:

@azure/arm-kusto

Interface representing a DataConnections operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDataConnectionValidation
beginDataConnectionValidationAndWait
beginDelete
beginDeleteAndWait
beginUpdate
beginUpdateAndWait
checkNameAvailability	Checks that the data connection name is valid and is not already in use.
createOrUpdate	Creates or updates a data connection.
dataConnectionValidation	Checks that the data connection parameters are valid.
delete	Deletes the data connection with the given name.
get	Returns a data connection.
listByDatabase	Returns the list of data connections of the given Kusto database.
update	Updates a data connection.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, clusterName: string, databaseName: string, dataConnectionName: string, parameters: DataConnectionUnion, options?: DataConnectionsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<DataConnectionUnion>, DataConnectionUnion>>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, dataConnectionName: string, parameters: DataConnectionUnion, options?: DataConnectionsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<DataConnectionUnion>, DataConnectionUnion>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, clusterName: string, databaseName: string, dataConnectionName: string, parameters: DataConnectionUnion, options?: DataConnectionsCreateOrUpdateOptionalParams) => Promise<DataConnectionUnion>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, dataConnectionName: string, parameters: DataConnectionUnion, options?: DataConnectionsCreateOrUpdateOptionalParams) => Promise<DataConnectionUnion>

beginDataConnectionValidation

Warning

This API is now deprecated.

use dataConnectionValidation instead

beginDataConnectionValidation: (resourceGroupName: string, clusterName: string, databaseName: string, parameters: DataConnectionValidation, options?: DataConnectionsDataConnectionValidationOptionalParams) => Promise<SimplePollerLike<OperationState<DataConnectionValidationListResult>, DataConnectionValidationListResult>>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, parameters: DataConnectionValidation, options?: DataConnectionsDataConnectionValidationOptionalParams) => Promise<SimplePollerLike<OperationState<DataConnectionValidationListResult>, DataConnectionValidationListResult>>

beginDataConnectionValidationAndWait

Warning

This API is now deprecated.

use dataConnectionValidation instead

beginDataConnectionValidationAndWait: (resourceGroupName: string, clusterName: string, databaseName: string, parameters: DataConnectionValidation, options?: DataConnectionsDataConnectionValidationOptionalParams) => Promise<DataConnectionValidationListResult>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, parameters: DataConnectionValidation, options?: DataConnectionsDataConnectionValidationOptionalParams) => Promise<DataConnectionValidationListResult>

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, clusterName: string, databaseName: string, dataConnectionName: string, parameters: DataConnectionUnion, options?: DataConnectionsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<DataConnectionUnion>, DataConnectionUnion>>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, dataConnectionName: string, parameters: DataConnectionUnion, options?: DataConnectionsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<DataConnectionUnion>, DataConnectionUnion>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, clusterName: string, databaseName: string, dataConnectionName: string, parameters: DataConnectionUnion, options?: DataConnectionsUpdateOptionalParams) => Promise<DataConnectionUnion>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, dataConnectionName: string, parameters: DataConnectionUnion, options?: DataConnectionsUpdateOptionalParams) => Promise<DataConnectionUnion>

checkNameAvailability

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

checkNameAvailability: (resourceGroupName: string, clusterName: string, databaseName: string, dataConnectionName: DataConnectionCheckNameRequest, options?: DataConnectionsCheckNameAvailabilityOptionalParams) => Promise<CheckNameResult>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, dataConnectionName: DataConnectionCheckNameRequest, options?: DataConnectionsCheckNameAvailabilityOptionalParams) => Promise<CheckNameResult>

createOrUpdate

Creates or updates a data connection.

createOrUpdate: (resourceGroupName: string, clusterName: string, databaseName: string, dataConnectionName: string, parameters: DataConnectionUnion, options?: DataConnectionsCreateOrUpdateOptionalParams) => PollerLike<OperationState<DataConnectionUnion>, DataConnectionUnion>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, dataConnectionName: string, parameters: DataConnectionUnion, options?: DataConnectionsCreateOrUpdateOptionalParams) => PollerLike<OperationState<DataConnectionUnion>, DataConnectionUnion>

dataConnectionValidation

Checks that the data connection parameters are valid.

dataConnectionValidation: (resourceGroupName: string, clusterName: string, databaseName: string, parameters: DataConnectionValidation, options?: DataConnectionsDataConnectionValidationOptionalParams) => PollerLike<OperationState<DataConnectionValidationListResult>, DataConnectionValidationListResult>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, parameters: DataConnectionValidation, options?: DataConnectionsDataConnectionValidationOptionalParams) => PollerLike<OperationState<DataConnectionValidationListResult>, DataConnectionValidationListResult>

delete

Deletes the data connection with the given name.

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

Property Value

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

get

Returns a data connection.

get: (resourceGroupName: string, clusterName: string, databaseName: string, dataConnectionName: string, options?: DataConnectionsGetOptionalParams) => Promise<DataConnectionUnion>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, dataConnectionName: string, options?: DataConnectionsGetOptionalParams) => Promise<DataConnectionUnion>

listByDatabase

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

listByDatabase: (resourceGroupName: string, clusterName: string, databaseName: string, options?: DataConnectionsListByDatabaseOptionalParams) => PagedAsyncIterableIterator<DataConnectionUnion, DataConnectionUnion[], PageSettings>

Property Value

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

update

Updates a data connection.

update: (resourceGroupName: string, clusterName: string, databaseName: string, dataConnectionName: string, parameters: DataConnectionUnion, options?: DataConnectionsUpdateOptionalParams) => PollerLike<OperationState<DataConnectionUnion>, DataConnectionUnion>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, dataConnectionName: string, parameters: DataConnectionUnion, options?: DataConnectionsUpdateOptionalParams) => PollerLike<OperationState<DataConnectionUnion>, DataConnectionUnion>