KustoPoolDatabasesImpl | @azure/arm-synapse

Class containing KustoPoolDatabases operations.

Hierarchy

KustoPoolDatabasesImpl

Implements

KustoPoolDatabases

Index

Constructors

constructor

Methods

Constructors

constructor

new KustoPoolDatabasesImpl(client: SynapseManagementClient): KustoPoolDatabasesImpl

- Defined in operations/kustoPoolDatabases.ts:33
Initialize a new instance of the class KustoPoolDatabases class.

Parameters
- client: SynapseManagementClient
  
  Reference to the service client
Returns KustoPoolDatabasesImpl

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, kustoPoolName: string, databaseName: string, parameters: DatabaseUnion, options?: KustoPoolDatabasesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<KustoPoolDatabasesCreateOrUpdateResponse>, KustoPoolDatabasesCreateOrUpdateResponse>>

Implementation of KustoPoolDatabases.beginCreateOrUpdate
- Defined in operations/kustoPoolDatabases.ts:166
Creates or updates a 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.
- parameters: DatabaseUnion
  
  The database parameters supplied to the CreateOrUpdate operation.
- Optional options: KustoPoolDatabasesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<KustoPoolDatabasesCreateOrUpdateResponse>, KustoPoolDatabasesCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, workspaceName: string, kustoPoolName: string, databaseName: string, parameters: DatabaseUnion, options?: KustoPoolDatabasesCreateOrUpdateOptionalParams): Promise<KustoPoolDatabasesCreateOrUpdateResponse>

Implementation of KustoPoolDatabases.beginCreateOrUpdateAndWait
- Defined in operations/kustoPoolDatabases.ts:247
Creates or updates a 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.
- parameters: DatabaseUnion
  
  The database parameters supplied to the CreateOrUpdate operation.
- Optional options: KustoPoolDatabasesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<KustoPoolDatabasesCreateOrUpdateResponse>

beginDelete

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

Implementation of KustoPoolDatabases.beginDelete
- Defined in operations/kustoPoolDatabases.ts:383
Deletes the database 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.
- Optional options: KustoPoolDatabasesDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

Implementation of KustoPoolDatabases.beginDeleteAndWait
- Defined in operations/kustoPoolDatabases.ts:456
Deletes the database 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.
- Optional options: KustoPoolDatabasesDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdate

beginUpdate(resourceGroupName: string, workspaceName: string, kustoPoolName: string, databaseName: string, parameters: DatabaseUnion, options?: KustoPoolDatabasesUpdateOptionalParams): Promise<PollerLike<PollOperationState<KustoPoolDatabasesUpdateResponse>, KustoPoolDatabasesUpdateResponse>>

Implementation of KustoPoolDatabases.beginUpdate
- Defined in operations/kustoPoolDatabases.ts:275
Updates a 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.
- parameters: DatabaseUnion
  
  The database parameters supplied to the Update operation.
- Optional options: KustoPoolDatabasesUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<KustoPoolDatabasesUpdateResponse>, KustoPoolDatabasesUpdateResponse>>

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, workspaceName: string, kustoPoolName: string, databaseName: string, parameters: DatabaseUnion, options?: KustoPoolDatabasesUpdateOptionalParams): Promise<KustoPoolDatabasesUpdateResponse>

Implementation of KustoPoolDatabases.beginUpdateAndWait
- Defined in operations/kustoPoolDatabases.ts:356
Updates a 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.
- parameters: DatabaseUnion
  
  The database parameters supplied to the Update operation.
- Optional options: KustoPoolDatabasesUpdateOptionalParams
  
  The options parameters.
Returns Promise<KustoPoolDatabasesUpdateResponse>

get

get(resourceGroupName: string, workspaceName: string, kustoPoolName: string, databaseName: string, options?: KustoPoolDatabasesGetOptionalParams): Promise<KustoPoolDatabasesGetResponse>

Implementation of KustoPoolDatabases.get
- Defined in operations/kustoPoolDatabases.ts:138
Returns a 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: KustoPoolDatabasesGetOptionalParams
  
  The options parameters.
Returns Promise<KustoPoolDatabasesGetResponse>

listByKustoPool

listByKustoPool(resourceGroupName: string, workspaceName: string, kustoPoolName: string, options?: KustoPoolDatabasesListByKustoPoolOptionalParams): PagedAsyncIterableIterator<DatabaseUnion>

Implementation of KustoPoolDatabases.listByKustoPool
- Defined in operations/kustoPoolDatabases.ts:50
Returns the list of databases of the given Kusto pool.

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

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: SynapseManagementClient

Returns KustoPoolDatabasesImpl

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

workspaceName: string

kustoPoolName: string

databaseName: string

parameters: DatabaseUnion

Optional options: KustoPoolDatabasesCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<KustoPoolDatabasesCreateOrUpdateResponse>, KustoPoolDatabasesCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

workspaceName: string

kustoPoolName: string

databaseName: string

parameters: DatabaseUnion

Optional options: KustoPoolDatabasesCreateOrUpdateOptionalParams

Returns Promise<KustoPoolDatabasesCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

workspaceName: string

kustoPoolName: string

databaseName: string

Optional options: KustoPoolDatabasesDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

workspaceName: string

kustoPoolName: string

databaseName: string

Optional options: KustoPoolDatabasesDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

workspaceName: string

kustoPoolName: string

databaseName: string

parameters: DatabaseUnion

Optional options: KustoPoolDatabasesUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<KustoPoolDatabasesUpdateResponse>, KustoPoolDatabasesUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

workspaceName: string

kustoPoolName: string

databaseName: string

parameters: DatabaseUnion

Optional options: KustoPoolDatabasesUpdateOptionalParams

Returns Promise<KustoPoolDatabasesUpdateResponse>

get

Parameters

resourceGroupName: string

workspaceName: string

kustoPoolName: string

databaseName: string

Optional options: KustoPoolDatabasesGetOptionalParams

Returns Promise<KustoPoolDatabasesGetResponse>

listByKustoPool

Parameters

resourceGroupName: string

workspaceName: string

kustoPoolName: string

Optional options: KustoPoolDatabasesListByKustoPoolOptionalParams

Returns PagedAsyncIterableIterator<DatabaseUnion>