Clusters interface

Interface representing a Clusters.

Methods

beginAddLanguageExtensions(string, string, LanguageExtensionsList, ClustersAddLanguageExtensionsOptionalParams)

Add a list of language extensions that can run within KQL queries.

beginAddLanguageExtensionsAndWait(string, string, LanguageExtensionsList, ClustersAddLanguageExtensionsOptionalParams)

Add a list of language extensions that can run within KQL queries.

beginCreateOrUpdate(string, string, Cluster, ClustersCreateOrUpdateOptionalParams)

Create or update a Kusto cluster.

beginCreateOrUpdateAndWait(string, string, Cluster, ClustersCreateOrUpdateOptionalParams)

Create or update a Kusto cluster.

beginDelete(string, string, ClustersDeleteOptionalParams)

Deletes a Kusto cluster.

beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)

Deletes a Kusto cluster.

beginDetachFollowerDatabases(string, string, FollowerDatabaseDefinition, ClustersDetachFollowerDatabasesOptionalParams)

Detaches all followers of a database owned by this cluster.

beginDetachFollowerDatabasesAndWait(string, string, FollowerDatabaseDefinition, ClustersDetachFollowerDatabasesOptionalParams)

Detaches all followers of a database owned by this cluster.

beginDiagnoseVirtualNetwork(string, string, ClustersDiagnoseVirtualNetworkOptionalParams)

Diagnoses network connectivity status for external resources on which the service is dependent on.

beginDiagnoseVirtualNetworkAndWait(string, string, ClustersDiagnoseVirtualNetworkOptionalParams)

Diagnoses network connectivity status for external resources on which the service is dependent on.

beginMigrate(string, string, ClusterMigrateRequest, ClustersMigrateOptionalParams)

Migrate data from a Kusto cluster to another cluster.

beginMigrateAndWait(string, string, ClusterMigrateRequest, ClustersMigrateOptionalParams)

Migrate data from a Kusto cluster to another cluster.

beginRemoveLanguageExtensions(string, string, LanguageExtensionsList, ClustersRemoveLanguageExtensionsOptionalParams)

Remove a list of language extensions that can run within KQL queries.

beginRemoveLanguageExtensionsAndWait(string, string, LanguageExtensionsList, ClustersRemoveLanguageExtensionsOptionalParams)

Remove a list of language extensions that can run within KQL queries.

beginStart(string, string, ClustersStartOptionalParams)

Starts a Kusto cluster.

beginStartAndWait(string, string, ClustersStartOptionalParams)

Starts a Kusto cluster.

beginStop(string, string, ClustersStopOptionalParams)

Stops a Kusto cluster.

beginStopAndWait(string, string, ClustersStopOptionalParams)

Stops a Kusto cluster.

beginUpdate(string, string, ClusterUpdate, ClustersUpdateOptionalParams)

Update a Kusto cluster.

beginUpdateAndWait(string, string, ClusterUpdate, ClustersUpdateOptionalParams)

Update a Kusto cluster.

checkNameAvailability(string, ClusterCheckNameRequest, ClustersCheckNameAvailabilityOptionalParams)

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

get(string, string, ClustersGetOptionalParams)

Gets a Kusto cluster.

list(ClustersListOptionalParams)

Lists all Kusto clusters within a subscription.

listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)

Lists all Kusto clusters within a resource group.

listFollowerDatabases(string, string, ClustersListFollowerDatabasesOptionalParams)

Returns a list of databases that are owned by this cluster and were followed by another cluster.

listLanguageExtensions(string, string, ClustersListLanguageExtensionsOptionalParams)

Returns a list of language extensions that can run within KQL queries.

listOutboundNetworkDependenciesEndpoints(string, string, ClustersListOutboundNetworkDependenciesEndpointsOptionalParams)

Gets the network endpoints of all outbound dependencies of a Kusto cluster

listSkus(ClustersListSkusOptionalParams)

Lists eligible SKUs for Kusto resource provider.

listSkusByResource(string, string, ClustersListSkusByResourceOptionalParams)

Returns the SKUs available for the provided resource.

Method Details

beginAddLanguageExtensions(string, string, LanguageExtensionsList, ClustersAddLanguageExtensionsOptionalParams)

Add a list of language extensions that can run within KQL queries.

function beginAddLanguageExtensions(resourceGroupName: string, clusterName: string, languageExtensionsToAdd: LanguageExtensionsList, options?: ClustersAddLanguageExtensionsOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

languageExtensionsToAdd
LanguageExtensionsList

The language extensions to add.

options
ClustersAddLanguageExtensionsOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginAddLanguageExtensionsAndWait(string, string, LanguageExtensionsList, ClustersAddLanguageExtensionsOptionalParams)

Add a list of language extensions that can run within KQL queries.

function beginAddLanguageExtensionsAndWait(resourceGroupName: string, clusterName: string, languageExtensionsToAdd: LanguageExtensionsList, options?: ClustersAddLanguageExtensionsOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

languageExtensionsToAdd
LanguageExtensionsList

The language extensions to add.

options
ClustersAddLanguageExtensionsOptionalParams

The options parameters.

Returns

Promise<void>

beginCreateOrUpdate(string, string, Cluster, ClustersCreateOrUpdateOptionalParams)

Create or update a Kusto cluster.

function beginCreateOrUpdate(resourceGroupName: string, clusterName: string, parameters: Cluster, options?: ClustersCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

parameters
Cluster

The Kusto cluster parameters supplied to the CreateOrUpdate operation.

options
ClustersCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Cluster>, Cluster>>

beginCreateOrUpdateAndWait(string, string, Cluster, ClustersCreateOrUpdateOptionalParams)

Create or update a Kusto cluster.

function beginCreateOrUpdateAndWait(resourceGroupName: string, clusterName: string, parameters: Cluster, options?: ClustersCreateOrUpdateOptionalParams): Promise<Cluster>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

parameters
Cluster

The Kusto cluster parameters supplied to the CreateOrUpdate operation.

options
ClustersCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Cluster>

beginDelete(string, string, ClustersDeleteOptionalParams)

Deletes a Kusto cluster.

function beginDelete(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

options
ClustersDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)

Deletes a Kusto cluster.

function beginDeleteAndWait(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

options
ClustersDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginDetachFollowerDatabases(string, string, FollowerDatabaseDefinition, ClustersDetachFollowerDatabasesOptionalParams)

Detaches all followers of a database owned by this cluster.

function beginDetachFollowerDatabases(resourceGroupName: string, clusterName: string, followerDatabaseToRemove: FollowerDatabaseDefinition, options?: ClustersDetachFollowerDatabasesOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

followerDatabaseToRemove
FollowerDatabaseDefinition

The follower databases properties to remove.

options
ClustersDetachFollowerDatabasesOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDetachFollowerDatabasesAndWait(string, string, FollowerDatabaseDefinition, ClustersDetachFollowerDatabasesOptionalParams)

Detaches all followers of a database owned by this cluster.

function beginDetachFollowerDatabasesAndWait(resourceGroupName: string, clusterName: string, followerDatabaseToRemove: FollowerDatabaseDefinition, options?: ClustersDetachFollowerDatabasesOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

followerDatabaseToRemove
FollowerDatabaseDefinition

The follower databases properties to remove.

options
ClustersDetachFollowerDatabasesOptionalParams

The options parameters.

Returns

Promise<void>

beginDiagnoseVirtualNetwork(string, string, ClustersDiagnoseVirtualNetworkOptionalParams)

Diagnoses network connectivity status for external resources on which the service is dependent on.

function beginDiagnoseVirtualNetwork(resourceGroupName: string, clusterName: string, options?: ClustersDiagnoseVirtualNetworkOptionalParams): Promise<SimplePollerLike<OperationState<DiagnoseVirtualNetworkResult>, DiagnoseVirtualNetworkResult>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

options
ClustersDiagnoseVirtualNetworkOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<DiagnoseVirtualNetworkResult>, DiagnoseVirtualNetworkResult>>

beginDiagnoseVirtualNetworkAndWait(string, string, ClustersDiagnoseVirtualNetworkOptionalParams)

Diagnoses network connectivity status for external resources on which the service is dependent on.

function beginDiagnoseVirtualNetworkAndWait(resourceGroupName: string, clusterName: string, options?: ClustersDiagnoseVirtualNetworkOptionalParams): Promise<DiagnoseVirtualNetworkResult>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

options
ClustersDiagnoseVirtualNetworkOptionalParams

The options parameters.

Returns

beginMigrate(string, string, ClusterMigrateRequest, ClustersMigrateOptionalParams)

Migrate data from a Kusto cluster to another cluster.

function beginMigrate(resourceGroupName: string, clusterName: string, clusterMigrateRequest: ClusterMigrateRequest, options?: ClustersMigrateOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

clusterMigrateRequest
ClusterMigrateRequest

The cluster migrate request parameters.

options
ClustersMigrateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginMigrateAndWait(string, string, ClusterMigrateRequest, ClustersMigrateOptionalParams)

Migrate data from a Kusto cluster to another cluster.

function beginMigrateAndWait(resourceGroupName: string, clusterName: string, clusterMigrateRequest: ClusterMigrateRequest, options?: ClustersMigrateOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

clusterMigrateRequest
ClusterMigrateRequest

The cluster migrate request parameters.

options
ClustersMigrateOptionalParams

The options parameters.

Returns

Promise<void>

beginRemoveLanguageExtensions(string, string, LanguageExtensionsList, ClustersRemoveLanguageExtensionsOptionalParams)

Remove a list of language extensions that can run within KQL queries.

function beginRemoveLanguageExtensions(resourceGroupName: string, clusterName: string, languageExtensionsToRemove: LanguageExtensionsList, options?: ClustersRemoveLanguageExtensionsOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

languageExtensionsToRemove
LanguageExtensionsList

The language extensions to remove.

options
ClustersRemoveLanguageExtensionsOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginRemoveLanguageExtensionsAndWait(string, string, LanguageExtensionsList, ClustersRemoveLanguageExtensionsOptionalParams)

Remove a list of language extensions that can run within KQL queries.

function beginRemoveLanguageExtensionsAndWait(resourceGroupName: string, clusterName: string, languageExtensionsToRemove: LanguageExtensionsList, options?: ClustersRemoveLanguageExtensionsOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

languageExtensionsToRemove
LanguageExtensionsList

The language extensions to remove.

options
ClustersRemoveLanguageExtensionsOptionalParams

The options parameters.

Returns

Promise<void>

beginStart(string, string, ClustersStartOptionalParams)

Starts a Kusto cluster.

function beginStart(resourceGroupName: string, clusterName: string, options?: ClustersStartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

options
ClustersStartOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginStartAndWait(string, string, ClustersStartOptionalParams)

Starts a Kusto cluster.

function beginStartAndWait(resourceGroupName: string, clusterName: string, options?: ClustersStartOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

options
ClustersStartOptionalParams

The options parameters.

Returns

Promise<void>

beginStop(string, string, ClustersStopOptionalParams)

Stops a Kusto cluster.

function beginStop(resourceGroupName: string, clusterName: string, options?: ClustersStopOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

options
ClustersStopOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginStopAndWait(string, string, ClustersStopOptionalParams)

Stops a Kusto cluster.

function beginStopAndWait(resourceGroupName: string, clusterName: string, options?: ClustersStopOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

options
ClustersStopOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, ClusterUpdate, ClustersUpdateOptionalParams)

Update a Kusto cluster.

function beginUpdate(resourceGroupName: string, clusterName: string, parameters: ClusterUpdate, options?: ClustersUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

parameters
ClusterUpdate

The Kusto cluster parameters supplied to the Update operation.

options
ClustersUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Cluster>, Cluster>>

beginUpdateAndWait(string, string, ClusterUpdate, ClustersUpdateOptionalParams)

Update a Kusto cluster.

function beginUpdateAndWait(resourceGroupName: string, clusterName: string, parameters: ClusterUpdate, options?: ClustersUpdateOptionalParams): Promise<Cluster>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

parameters
ClusterUpdate

The Kusto cluster parameters supplied to the Update operation.

options
ClustersUpdateOptionalParams

The options parameters.

Returns

Promise<Cluster>

checkNameAvailability(string, ClusterCheckNameRequest, ClustersCheckNameAvailabilityOptionalParams)

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

function checkNameAvailability(location: string, clusterName: ClusterCheckNameRequest, options?: ClustersCheckNameAvailabilityOptionalParams): Promise<CheckNameResult>

Parameters

location

string

The name of Azure region.

clusterName
ClusterCheckNameRequest

The name of the cluster.

options
ClustersCheckNameAvailabilityOptionalParams

The options parameters.

Returns

Promise<CheckNameResult>

get(string, string, ClustersGetOptionalParams)

Gets a Kusto cluster.

function get(resourceGroupName: string, clusterName: string, options?: ClustersGetOptionalParams): Promise<Cluster>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

options
ClustersGetOptionalParams

The options parameters.

Returns

Promise<Cluster>

list(ClustersListOptionalParams)

Lists all Kusto clusters within a subscription.

function list(options?: ClustersListOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

Parameters

options
ClustersListOptionalParams

The options parameters.

Returns

listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)

Lists all Kusto clusters within a resource group.

function listByResourceGroup(resourceGroupName: string, options?: ClustersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options
ClustersListByResourceGroupOptionalParams

The options parameters.

Returns

listFollowerDatabases(string, string, ClustersListFollowerDatabasesOptionalParams)

Returns a list of databases that are owned by this cluster and were followed by another cluster.

function listFollowerDatabases(resourceGroupName: string, clusterName: string, options?: ClustersListFollowerDatabasesOptionalParams): PagedAsyncIterableIterator<FollowerDatabaseDefinition, FollowerDatabaseDefinition[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

options
ClustersListFollowerDatabasesOptionalParams

The options parameters.

Returns

listLanguageExtensions(string, string, ClustersListLanguageExtensionsOptionalParams)

Returns a list of language extensions that can run within KQL queries.

function listLanguageExtensions(resourceGroupName: string, clusterName: string, options?: ClustersListLanguageExtensionsOptionalParams): PagedAsyncIterableIterator<LanguageExtension, LanguageExtension[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

options
ClustersListLanguageExtensionsOptionalParams

The options parameters.

Returns

listOutboundNetworkDependenciesEndpoints(string, string, ClustersListOutboundNetworkDependenciesEndpointsOptionalParams)

Gets the network endpoints of all outbound dependencies of a Kusto cluster

function listOutboundNetworkDependenciesEndpoints(resourceGroupName: string, clusterName: string, options?: ClustersListOutboundNetworkDependenciesEndpointsOptionalParams): PagedAsyncIterableIterator<OutboundNetworkDependenciesEndpoint, OutboundNetworkDependenciesEndpoint[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

Returns

listSkus(ClustersListSkusOptionalParams)

Lists eligible SKUs for Kusto resource provider.

function listSkus(options?: ClustersListSkusOptionalParams): PagedAsyncIterableIterator<SkuDescription, SkuDescription[], PageSettings>

Parameters

options
ClustersListSkusOptionalParams

The options parameters.

Returns

listSkusByResource(string, string, ClustersListSkusByResourceOptionalParams)

Returns the SKUs available for the provided resource.

function listSkusByResource(resourceGroupName: string, clusterName: string, options?: ClustersListSkusByResourceOptionalParams): PagedAsyncIterableIterator<AzureResourceSku, AzureResourceSku[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

options
ClustersListSkusByResourceOptionalParams

The options parameters.

Returns