KustoPoolDataConnections | @azure/arm-synapse

Interface representing a KustoPoolDataConnections.

Hierarchy

KustoPoolDataConnections

Implemented by

KustoPoolDataConnectionsImpl

Index

Methods

beginCreateOrUpdate

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

- Defined in operationsInterfaces/kustoPoolDataConnections.ts:132
Creates or updates a data connection.

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.
- Optional options: KustoPoolDataConnectionsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<KustoPoolDataConnectionsCreateOrUpdateResponse>, KustoPoolDataConnectionsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

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

- Defined in operationsInterfaces/kustoPoolDataConnections.ts:156
Creates or updates a data connection.

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.
- Optional options: KustoPoolDataConnectionsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<KustoPoolDataConnectionsCreateOrUpdateResponse>

beginDataConnectionValidation

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

- Defined in operationsInterfaces/kustoPoolDataConnections.ts:73
Checks that the data connection parameters are valid.

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.
- Optional options: KustoPoolDataConnectionsDataConnectionValidationOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<KustoPoolDataConnectionsDataConnectionValidationResponse>, KustoPoolDataConnectionsDataConnectionValidationResponse>>

beginDataConnectionValidationAndWait

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

- Defined in operationsInterfaces/kustoPoolDataConnections.ts:97
Checks that the data connection parameters are valid.

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.
- Optional options: KustoPoolDataConnectionsDataConnectionValidationOptionalParams
  
  The options parameters.
Returns Promise<KustoPoolDataConnectionsDataConnectionValidationResponse>

beginDelete

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

- Defined in operationsInterfaces/kustoPoolDataConnections.ts:217
Deletes the data connection with the given name.

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.
- Optional options: KustoPoolDataConnectionsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

- Defined in operationsInterfaces/kustoPoolDataConnections.ts:234
Deletes the data connection with the given name.

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.
- Optional options: KustoPoolDataConnectionsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdate

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

- Defined in operationsInterfaces/kustoPoolDataConnections.ts:175
Updates a data connection.

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.
- Optional options: KustoPoolDataConnectionsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<KustoPoolDataConnectionsUpdateResponse>, KustoPoolDataConnectionsUpdateResponse>>

beginUpdateAndWait

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

- Defined in operationsInterfaces/kustoPoolDataConnections.ts:199
Updates a data connection.

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.
- Optional options: KustoPoolDataConnectionsUpdateOptionalParams
  
  The options parameters.
Returns Promise<KustoPoolDataConnectionsUpdateResponse>

checkNameAvailability

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

- Defined in operationsInterfaces/kustoPoolDataConnections.ts:56
Checks that the data connection name is valid and is not already in use.

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.
- Optional options: KustoPoolDataConnectionsCheckNameAvailabilityOptionalParams
  
  The options parameters.
Returns Promise<KustoPoolDataConnectionsCheckNameAvailabilityResponse>

get

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

- Defined in operationsInterfaces/kustoPoolDataConnections.ts:114
Returns a data connection.

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.
- Optional options: KustoPoolDataConnectionsGetOptionalParams
  
  The options parameters.
Returns Promise<KustoPoolDataConnectionsGetResponse>

listByDatabase

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

- Defined in operationsInterfaces/kustoPoolDataConnections.ts:40
Returns the list of data connections of the given Kusto pool database.

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.
- Optional options: KustoPoolDataConnectionsListByDatabaseOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<DataConnectionUnion>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

workspaceName: string

kustoPoolName: string

databaseName: string

dataConnectionName: string

parameters: DataConnectionUnion

Optional options: KustoPoolDataConnectionsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<KustoPoolDataConnectionsCreateOrUpdateResponse>, KustoPoolDataConnectionsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

workspaceName: string

kustoPoolName: string

databaseName: string

dataConnectionName: string

parameters: DataConnectionUnion

Optional options: KustoPoolDataConnectionsCreateOrUpdateOptionalParams

Returns Promise<KustoPoolDataConnectionsCreateOrUpdateResponse>

beginDataConnectionValidation

Parameters

resourceGroupName: string

workspaceName: string

kustoPoolName: string

databaseName: string

parameters: DataConnectionValidation

Optional options: KustoPoolDataConnectionsDataConnectionValidationOptionalParams

Returns Promise<PollerLike<PollOperationState<KustoPoolDataConnectionsDataConnectionValidationResponse>, KustoPoolDataConnectionsDataConnectionValidationResponse>>

beginDataConnectionValidationAndWait

Parameters

resourceGroupName: string

workspaceName: string

kustoPoolName: string

databaseName: string

parameters: DataConnectionValidation

Optional options: KustoPoolDataConnectionsDataConnectionValidationOptionalParams

Returns Promise<KustoPoolDataConnectionsDataConnectionValidationResponse>

beginDelete

Parameters

resourceGroupName: string

workspaceName: string

kustoPoolName: string

databaseName: string

dataConnectionName: string

Optional options: KustoPoolDataConnectionsDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

workspaceName: string

kustoPoolName: string

databaseName: string

dataConnectionName: string

Optional options: KustoPoolDataConnectionsDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

workspaceName: string

kustoPoolName: string

databaseName: string

dataConnectionName: string

parameters: DataConnectionUnion

Optional options: KustoPoolDataConnectionsUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<KustoPoolDataConnectionsUpdateResponse>, KustoPoolDataConnectionsUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

workspaceName: string

kustoPoolName: string

databaseName: string

dataConnectionName: string

parameters: DataConnectionUnion

Optional options: KustoPoolDataConnectionsUpdateOptionalParams