KustoPools | @azure/arm-synapse

Interface representing a KustoPools.

Hierarchy

KustoPools

Implemented by

KustoPoolsImpl

Methods

beginAddLanguageExtensions

beginAddLanguageExtensions(workspaceName: string, kustoPoolName: string, resourceGroupName: string, languageExtensionsToAdd: LanguageExtensionsList, options?: KustoPoolsAddLanguageExtensionsOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/kustoPools.ts:283
Add a list of language extensions that can run within KQL queries.

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.
- languageExtensionsToAdd: LanguageExtensionsList
  
  The language extensions to add.
- Optional options: KustoPoolsAddLanguageExtensionsOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginAddLanguageExtensionsAndWait

beginAddLanguageExtensionsAndWait(workspaceName: string, kustoPoolName: string, resourceGroupName: string, languageExtensionsToAdd: LanguageExtensionsList, options?: KustoPoolsAddLanguageExtensionsOptionalParams): Promise<void>

- Defined in operationsInterfaces/kustoPools.ts:298
Add a list of language extensions that can run within KQL queries.

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.
- languageExtensionsToAdd: LanguageExtensionsList
  
  The language extensions to add.
- Optional options: KustoPoolsAddLanguageExtensionsOptionalParams
  
  The options parameters.
Returns Promise<void>

beginCreateOrUpdate

beginCreateOrUpdate(workspaceName: string, resourceGroupName: string, kustoPoolName: string, parameters: KustoPool, options?: KustoPoolsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<KustoPoolsCreateOrUpdateResponse>, KustoPoolsCreateOrUpdateResponse>>

- Defined in operationsInterfaces/kustoPools.ts:135
Create or update a Kusto pool.

Parameters
- workspaceName: string
  
  The name of the workspace.
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- kustoPoolName: string
  
  The name of the Kusto pool.
- parameters: KustoPool
  
  The Kusto pool parameters supplied to the CreateOrUpdate operation.
- Optional options: KustoPoolsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<KustoPoolsCreateOrUpdateResponse>, KustoPoolsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(workspaceName: string, resourceGroupName: string, kustoPoolName: string, parameters: KustoPool, options?: KustoPoolsCreateOrUpdateOptionalParams): Promise<KustoPoolsCreateOrUpdateResponse>

- Defined in operationsInterfaces/kustoPools.ts:155
Create or update a Kusto pool.

Parameters
- workspaceName: string
  
  The name of the workspace.
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- kustoPoolName: string
  
  The name of the Kusto pool.
- parameters: KustoPool
  
  The Kusto pool parameters supplied to the CreateOrUpdate operation.
- Optional options: KustoPoolsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<KustoPoolsCreateOrUpdateResponse>

beginDelete

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

- Defined in operationsInterfaces/kustoPools.ts:204
Deletes a Kusto pool.

Parameters
- workspaceName: string
  
  The name of the workspace.
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- kustoPoolName: string
  
  The name of the Kusto pool.
- Optional options: KustoPoolsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

- Defined in operationsInterfaces/kustoPools.ts:217
Deletes a Kusto pool.

Parameters
- workspaceName: string
  
  The name of the workspace.
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- kustoPoolName: string
  
  The name of the Kusto pool.
- Optional options: KustoPoolsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginDetachFollowerDatabases

beginDetachFollowerDatabases(workspaceName: string, kustoPoolName: string, resourceGroupName: string, followerDatabaseToRemove: FollowerDatabaseDefinition, options?: KustoPoolsDetachFollowerDatabasesOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/kustoPools.ts:343
Detaches all followers of a database owned by this Kusto Pool.

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.
- followerDatabaseToRemove: FollowerDatabaseDefinition
  
  The follower databases properties to remove.
- Optional options: KustoPoolsDetachFollowerDatabasesOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDetachFollowerDatabasesAndWait

beginDetachFollowerDatabasesAndWait(workspaceName: string, kustoPoolName: string, resourceGroupName: string, followerDatabaseToRemove: FollowerDatabaseDefinition, options?: KustoPoolsDetachFollowerDatabasesOptionalParams): Promise<void>

- Defined in operationsInterfaces/kustoPools.ts:358
Detaches all followers of a database owned by this Kusto Pool.

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.
- followerDatabaseToRemove: FollowerDatabaseDefinition
  
  The follower databases properties to remove.
- Optional options: KustoPoolsDetachFollowerDatabasesOptionalParams
  
  The options parameters.
Returns Promise<void>

beginRemoveLanguageExtensions

beginRemoveLanguageExtensions(workspaceName: string, kustoPoolName: string, resourceGroupName: string, languageExtensionsToRemove: LanguageExtensionsList, options?: KustoPoolsRemoveLanguageExtensionsOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/kustoPools.ts:313
Remove a list of language extensions that can run within KQL queries.

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.
- languageExtensionsToRemove: LanguageExtensionsList
  
  The language extensions to remove.
- Optional options: KustoPoolsRemoveLanguageExtensionsOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRemoveLanguageExtensionsAndWait

beginRemoveLanguageExtensionsAndWait(workspaceName: string, kustoPoolName: string, resourceGroupName: string, languageExtensionsToRemove: LanguageExtensionsList, options?: KustoPoolsRemoveLanguageExtensionsOptionalParams): Promise<void>

- Defined in operationsInterfaces/kustoPools.ts:328
Remove a list of language extensions that can run within KQL queries.

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.
- languageExtensionsToRemove: LanguageExtensionsList
  
  The language extensions to remove.
- Optional options: KustoPoolsRemoveLanguageExtensionsOptionalParams
  
  The options parameters.
Returns Promise<void>

beginStart

beginStart(workspaceName: string, kustoPoolName: string, resourceGroupName: string, options?: KustoPoolsStartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/kustoPools.ts:256
Starts a Kusto pool.

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

beginStartAndWait

beginStartAndWait(workspaceName: string, kustoPoolName: string, resourceGroupName: string, options?: KustoPoolsStartOptionalParams): Promise<void>

- Defined in operationsInterfaces/kustoPools.ts:269
Starts a Kusto pool.

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

beginStop

beginStop(workspaceName: string, kustoPoolName: string, resourceGroupName: string, options?: KustoPoolsStopOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/kustoPools.ts:230
Stops a Kusto pool.

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

beginStopAndWait

beginStopAndWait(workspaceName: string, kustoPoolName: string, resourceGroupName: string, options?: KustoPoolsStopOptionalParams): Promise<void>

- Defined in operationsInterfaces/kustoPools.ts:243
Stops a Kusto pool.

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

beginUpdate

beginUpdate(workspaceName: string, resourceGroupName: string, kustoPoolName: string, parameters: KustoPoolUpdate, options?: KustoPoolsUpdateOptionalParams): Promise<PollerLike<PollOperationState<KustoPoolsUpdateResponse>, KustoPoolsUpdateResponse>>

- Defined in operationsInterfaces/kustoPools.ts:170
Update a Kusto Kusto Pool.

Parameters
- workspaceName: string
  
  The name of the workspace.
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- kustoPoolName: string
  
  The name of the Kusto pool.
- parameters: KustoPoolUpdate
  
  The Kusto pool parameters supplied to the Update operation.
- Optional options: KustoPoolsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<KustoPoolsUpdateResponse>, KustoPoolsUpdateResponse>>

beginUpdateAndWait

beginUpdateAndWait(workspaceName: string, resourceGroupName: string, kustoPoolName: string, parameters: KustoPoolUpdate, options?: KustoPoolsUpdateOptionalParams): Promise<KustoPoolsUpdateResponse>

- Defined in operationsInterfaces/kustoPools.ts:190
Update a Kusto Kusto Pool.

Parameters
- workspaceName: string
  
  The name of the workspace.
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- kustoPoolName: string
  
  The name of the Kusto pool.
- parameters: KustoPoolUpdate
  
  The Kusto pool parameters supplied to the Update operation.
- Optional options: KustoPoolsUpdateOptionalParams
  
  The options parameters.
Returns Promise<KustoPoolsUpdateResponse>

checkNameAvailability

checkNameAvailability(location: string, kustoPoolName: KustoPoolCheckNameRequest, options?: KustoPoolsCheckNameAvailabilityOptionalParams): Promise<KustoPoolsCheckNameAvailabilityResponse>

- Defined in operationsInterfaces/kustoPools.ts:98
Checks that the kusto pool name is valid and is not already in use.

Parameters
- location: string
  
  The name of Azure region.
- kustoPoolName: KustoPoolCheckNameRequest
  
  The name of the cluster.
- Optional options: KustoPoolsCheckNameAvailabilityOptionalParams
  
  The options parameters.
Returns Promise<KustoPoolsCheckNameAvailabilityResponse>

get

get(workspaceName: string, kustoPoolName: string, resourceGroupName: string, options?: KustoPoolsGetOptionalParams): Promise<KustoPoolsGetResponse>

- Defined in operationsInterfaces/kustoPools.ts:121
Gets a Kusto pool.

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

listByWorkspace

listByWorkspace(resourceGroupName: string, workspaceName: string, options?: KustoPoolsListByWorkspaceOptionalParams): Promise<KustoPoolsListByWorkspaceResponse>

- Defined in operationsInterfaces/kustoPools.ts:109
List all Kusto pools

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- Optional options: KustoPoolsListByWorkspaceOptionalParams
  
  The options parameters.
Returns Promise<KustoPoolsListByWorkspaceResponse>

listFollowerDatabases

listFollowerDatabases(workspaceName: string, kustoPoolName: string, resourceGroupName: string, options?: KustoPoolsListFollowerDatabasesOptionalParams): PagedAsyncIterableIterator<FollowerDatabaseDefinition>

- Defined in operationsInterfaces/kustoPools.ts:86
Returns a list of databases that are owned by this Kusto Pool and were followed by another Kusto Pool.

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

listLanguageExtensions

listLanguageExtensions(workspaceName: string, kustoPoolName: string, resourceGroupName: string, options?: KustoPoolsListLanguageExtensionsOptionalParams): PagedAsyncIterableIterator<LanguageExtension>

- Defined in operationsInterfaces/kustoPools.ts:72
Returns a list of language extensions that can run within KQL queries.

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

listSkus

listSkus(options?: KustoPoolsListSkusOptionalParams): PagedAsyncIterableIterator<SkuDescription>

- Defined in operationsInterfaces/kustoPools.ts:49
Lists eligible SKUs for Kusto Pool resource.

Parameters
- Optional options: KustoPoolsListSkusOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<SkuDescription>

listSkusByResource

listSkusByResource(workspaceName: string, kustoPoolName: string, resourceGroupName: string, options?: KustoPoolsListSkusByResourceOptionalParams): PagedAsyncIterableIterator<AzureResourceSku>

- Defined in operationsInterfaces/kustoPools.ts:59
Returns the SKUs available for the provided resource.

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

Hierarchy

Implemented by

Index

Methods

Methods

beginAddLanguageExtensions

Parameters

workspaceName: string

kustoPoolName: string

resourceGroupName: string

languageExtensionsToAdd: LanguageExtensionsList

Optional options: KustoPoolsAddLanguageExtensionsOptionalParams

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

beginAddLanguageExtensionsAndWait

Parameters

workspaceName: string

kustoPoolName: string

resourceGroupName: string

languageExtensionsToAdd: LanguageExtensionsList

Optional options: KustoPoolsAddLanguageExtensionsOptionalParams

Returns Promise<void>

beginCreateOrUpdate

Parameters

workspaceName: string

resourceGroupName: string

kustoPoolName: string

parameters: KustoPool

Optional options: KustoPoolsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<KustoPoolsCreateOrUpdateResponse>, KustoPoolsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

workspaceName: string

resourceGroupName: string

kustoPoolName: string

parameters: KustoPool

Optional options: KustoPoolsCreateOrUpdateOptionalParams

Returns Promise<KustoPoolsCreateOrUpdateResponse>

beginDelete

Parameters

workspaceName: string

resourceGroupName: string

kustoPoolName: string

Optional options: KustoPoolsDeleteOptionalParams

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

beginDeleteAndWait

Parameters

workspaceName: string

resourceGroupName: string

kustoPoolName: string

Optional options: KustoPoolsDeleteOptionalParams

Returns Promise<void>

beginDetachFollowerDatabases

Parameters

workspaceName: string

kustoPoolName: string

resourceGroupName: string

followerDatabaseToRemove: FollowerDatabaseDefinition

Optional options: KustoPoolsDetachFollowerDatabasesOptionalParams

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

beginDetachFollowerDatabasesAndWait

Parameters

workspaceName: string

kustoPoolName: string

resourceGroupName: string

followerDatabaseToRemove: FollowerDatabaseDefinition

Optional options: KustoPoolsDetachFollowerDatabasesOptionalParams

Returns Promise<void>

beginRemoveLanguageExtensions

Parameters

workspaceName: string

kustoPoolName: string

resourceGroupName: string

languageExtensionsToRemove: LanguageExtensionsList

Optional options: KustoPoolsRemoveLanguageExtensionsOptionalParams

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

beginRemoveLanguageExtensionsAndWait

Parameters

workspaceName: string

kustoPoolName: string

resourceGroupName: string