KustoPools interface
Interface representing a KustoPools.
Methods
Method Details
beginAddLanguageExtensions(string, string, string, LanguageExtensionsList, KustoPoolsAddLanguageExtensionsOptionalParams)
Add a list of language extensions that can run within KQL queries.
function beginAddLanguageExtensions(workspaceName: string, kustoPoolName: string, resourceGroupName: string, languageExtensionsToAdd: LanguageExtensionsList, options?: KustoPoolsAddLanguageExtensionsOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>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.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginAddLanguageExtensionsAndWait(string, string, string, LanguageExtensionsList, KustoPoolsAddLanguageExtensionsOptionalParams)
Add a list of language extensions that can run within KQL queries.
function beginAddLanguageExtensionsAndWait(workspaceName: string, kustoPoolName: string, resourceGroupName: string, languageExtensionsToAdd: LanguageExtensionsList, options?: KustoPoolsAddLanguageExtensionsOptionalParams): Promise<void>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.
The options parameters.
Returns
Promise<void>
beginCreateOrUpdate(string, string, string, KustoPool, KustoPoolsCreateOrUpdateOptionalParams)
Create or update a Kusto pool.
function beginCreateOrUpdate(workspaceName: string, resourceGroupName: string, kustoPoolName: string, parameters: KustoPool, options?: KustoPoolsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<KustoPool>, KustoPool>>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.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<KustoPool>, KustoPool>>
beginCreateOrUpdateAndWait(string, string, string, KustoPool, KustoPoolsCreateOrUpdateOptionalParams)
Create or update a Kusto pool.
function beginCreateOrUpdateAndWait(workspaceName: string, resourceGroupName: string, kustoPoolName: string, parameters: KustoPool, options?: KustoPoolsCreateOrUpdateOptionalParams): Promise<KustoPool>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.
The options parameters.
Returns
Promise<KustoPool>
beginDelete(string, string, string, KustoPoolsDeleteOptionalParams)
Deletes a Kusto pool.
function beginDelete(workspaceName: string, resourceGroupName: string, kustoPoolName: string, options?: KustoPoolsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>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.
- options
- KustoPoolsDeleteOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, string, KustoPoolsDeleteOptionalParams)
Deletes a Kusto pool.
function beginDeleteAndWait(workspaceName: string, resourceGroupName: string, kustoPoolName: string, options?: KustoPoolsDeleteOptionalParams): Promise<void>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.
- options
- KustoPoolsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginDetachFollowerDatabases(string, string, string, FollowerDatabaseDefinition, KustoPoolsDetachFollowerDatabasesOptionalParams)
Detaches all followers of a database owned by this Kusto Pool.
function beginDetachFollowerDatabases(workspaceName: string, kustoPoolName: string, resourceGroupName: string, followerDatabaseToRemove: FollowerDatabaseDefinition, options?: KustoPoolsDetachFollowerDatabasesOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>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.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDetachFollowerDatabasesAndWait(string, string, string, FollowerDatabaseDefinition, KustoPoolsDetachFollowerDatabasesOptionalParams)
Detaches all followers of a database owned by this Kusto Pool.
function beginDetachFollowerDatabasesAndWait(workspaceName: string, kustoPoolName: string, resourceGroupName: string, followerDatabaseToRemove: FollowerDatabaseDefinition, options?: KustoPoolsDetachFollowerDatabasesOptionalParams): Promise<void>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.
The options parameters.
Returns
Promise<void>
beginRemoveLanguageExtensions(string, string, string, LanguageExtensionsList, KustoPoolsRemoveLanguageExtensionsOptionalParams)
Remove a list of language extensions that can run within KQL queries.
function beginRemoveLanguageExtensions(workspaceName: string, kustoPoolName: string, resourceGroupName: string, languageExtensionsToRemove: LanguageExtensionsList, options?: KustoPoolsRemoveLanguageExtensionsOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>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.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginRemoveLanguageExtensionsAndWait(string, string, string, LanguageExtensionsList, KustoPoolsRemoveLanguageExtensionsOptionalParams)
Remove a list of language extensions that can run within KQL queries.
function beginRemoveLanguageExtensionsAndWait(workspaceName: string, kustoPoolName: string, resourceGroupName: string, languageExtensionsToRemove: LanguageExtensionsList, options?: KustoPoolsRemoveLanguageExtensionsOptionalParams): Promise<void>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.
The options parameters.
Returns
Promise<void>
beginStart(string, string, string, KustoPoolsStartOptionalParams)
Starts a Kusto pool.
function beginStart(workspaceName: string, kustoPoolName: string, resourceGroupName: string, options?: KustoPoolsStartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>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.
- options
- KustoPoolsStartOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginStartAndWait(string, string, string, KustoPoolsStartOptionalParams)
Starts a Kusto pool.
function beginStartAndWait(workspaceName: string, kustoPoolName: string, resourceGroupName: string, options?: KustoPoolsStartOptionalParams): Promise<void>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.
- options
- KustoPoolsStartOptionalParams
The options parameters.
Returns
Promise<void>
beginStop(string, string, string, KustoPoolsStopOptionalParams)
Stops a Kusto pool.
function beginStop(workspaceName: string, kustoPoolName: string, resourceGroupName: string, options?: KustoPoolsStopOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>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.
- options
- KustoPoolsStopOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginStopAndWait(string, string, string, KustoPoolsStopOptionalParams)
Stops a Kusto pool.
function beginStopAndWait(workspaceName: string, kustoPoolName: string, resourceGroupName: string, options?: KustoPoolsStopOptionalParams): Promise<void>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.
- options
- KustoPoolsStopOptionalParams
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, string, KustoPoolUpdate, KustoPoolsUpdateOptionalParams)
Update a Kusto Kusto Pool.
function beginUpdate(workspaceName: string, resourceGroupName: string, kustoPoolName: string, parameters: KustoPoolUpdate, options?: KustoPoolsUpdateOptionalParams): Promise<PollerLike<PollOperationState<KustoPool>, KustoPool>>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.
- options
- KustoPoolsUpdateOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<KustoPool>, KustoPool>>
beginUpdateAndWait(string, string, string, KustoPoolUpdate, KustoPoolsUpdateOptionalParams)
Update a Kusto Kusto Pool.
function beginUpdateAndWait(workspaceName: string, resourceGroupName: string, kustoPoolName: string, parameters: KustoPoolUpdate, options?: KustoPoolsUpdateOptionalParams): Promise<KustoPool>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.
- options
- KustoPoolsUpdateOptionalParams
The options parameters.
Returns
Promise<KustoPool>
checkNameAvailability(string, KustoPoolCheckNameRequest, KustoPoolsCheckNameAvailabilityOptionalParams)
Checks that the kusto pool name is valid and is not already in use.
function checkNameAvailability(location: string, kustoPoolName: KustoPoolCheckNameRequest, options?: KustoPoolsCheckNameAvailabilityOptionalParams): Promise<CheckNameResult>Parameters
- location
-
string
The name of Azure region.
- kustoPoolName
- KustoPoolCheckNameRequest
The name of the cluster.
The options parameters.
Returns
Promise<CheckNameResult>
get(string, string, string, KustoPoolsGetOptionalParams)
Gets a Kusto pool.
function get(workspaceName: string, kustoPoolName: string, resourceGroupName: string, options?: KustoPoolsGetOptionalParams): Promise<KustoPool>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.
- options
- KustoPoolsGetOptionalParams
The options parameters.
Returns
Promise<KustoPool>
listByWorkspace(string, string, KustoPoolsListByWorkspaceOptionalParams)
List all Kusto pools
function listByWorkspace(resourceGroupName: string, workspaceName: string, options?: KustoPoolsListByWorkspaceOptionalParams): Promise<KustoPoolListResult>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
The options parameters.
Returns
Promise<KustoPoolListResult>
listFollowerDatabases(string, string, string, KustoPoolsListFollowerDatabasesOptionalParams)
Returns a list of databases that are owned by this Kusto Pool and were followed by another Kusto Pool.
function listFollowerDatabases(workspaceName: string, kustoPoolName: string, resourceGroupName: string, options?: KustoPoolsListFollowerDatabasesOptionalParams): PagedAsyncIterableIterator<FollowerDatabaseDefinition, FollowerDatabaseDefinition[], PageSettings>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.
The options parameters.
Returns
listLanguageExtensions(string, string, string, KustoPoolsListLanguageExtensionsOptionalParams)
Returns a list of language extensions that can run within KQL queries.
function listLanguageExtensions(workspaceName: string, kustoPoolName: string, resourceGroupName: string, options?: KustoPoolsListLanguageExtensionsOptionalParams): PagedAsyncIterableIterator<LanguageExtension, LanguageExtension[], PageSettings>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.
The options parameters.
Returns
listSkus(KustoPoolsListSkusOptionalParams)
Lists eligible SKUs for Kusto Pool resource.
function listSkus(options?: KustoPoolsListSkusOptionalParams): PagedAsyncIterableIterator<SkuDescription, SkuDescription[], PageSettings>Parameters
- options
- KustoPoolsListSkusOptionalParams
The options parameters.
Returns
listSkusByResource(string, string, string, KustoPoolsListSkusByResourceOptionalParams)
Returns the SKUs available for the provided resource.
function listSkusByResource(workspaceName: string, kustoPoolName: string, resourceGroupName: string, options?: KustoPoolsListSkusByResourceOptionalParams): PagedAsyncIterableIterator<AzureResourceSku, AzureResourceSku[], PageSettings>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.
The options parameters.
Returns
Azure SDK for JavaScript