ClustersOperations interface

Package:

@azure/arm-kusto

Interface representing a Clusters operations.

Properties

addCalloutPolicies	Adds a list of callout policies for engine services.
addLanguageExtensions	Add a list of language extensions that can run within KQL queries.
beginAddCalloutPolicies
beginAddCalloutPoliciesAndWait
beginAddLanguageExtensions
beginAddLanguageExtensionsAndWait
beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginDetachFollowerDatabases
beginDetachFollowerDatabasesAndWait
beginDiagnoseVirtualNetwork
beginDiagnoseVirtualNetworkAndWait
beginMigrate
beginMigrateAndWait
beginRemoveCalloutPolicy
beginRemoveCalloutPolicyAndWait
beginRemoveLanguageExtensions
beginRemoveLanguageExtensionsAndWait
beginStart
beginStartAndWait
beginStop
beginStopAndWait
beginUpdate
beginUpdateAndWait
checkNameAvailability	Checks that the cluster name is valid and is not already in use.
createOrUpdate	Create or update a Kusto cluster.
delete	Deletes a Kusto cluster.
detachFollowerDatabases	Detaches all followers of a database owned by this cluster.
diagnoseVirtualNetwork	Diagnoses network connectivity status for external resources on which the service is dependent on.
get	Gets a Kusto cluster.
list	Lists all Kusto clusters within a subscription.
listByResourceGroup	Lists all Kusto clusters within a resource group.
listCalloutPolicies	Returns the allowed callout policies for the specified service.
listFollowerDatabases	Returns a list of databases that are owned by this cluster and were followed by another cluster.
listFollowerDatabasesGet	Returns a list of databases that are owned by this cluster and were followed by another cluster.
listLanguageExtensions	Returns a list of language extensions that can run within KQL queries.
listOutboundNetworkDependenciesEndpoints	Gets the network endpoints of all outbound dependencies of a Kusto cluster
listSkus	Lists eligible SKUs for Kusto resource provider.
listSkusByResource	Returns the SKUs available for the provided resource.
migrate	Migrate data from a Kusto cluster to another cluster.
removeCalloutPolicy	Removes callout policy for engine services.
removeLanguageExtensions	Remove a list of language extensions that can run within KQL queries.
start	Starts a Kusto cluster.
stop	Stops a Kusto cluster.
update	Update a Kusto cluster.

Property Details

addCalloutPolicies

Adds a list of callout policies for engine services.

addCalloutPolicies: (resourceGroupName: string, clusterName: string, calloutPolicies: _CalloutPoliciesList, options?: ClustersAddCalloutPoliciesOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, calloutPolicies: _CalloutPoliciesList, options?: ClustersAddCalloutPoliciesOptionalParams) => PollerLike<OperationState<void>, void>

addLanguageExtensions

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

addLanguageExtensions: (resourceGroupName: string, clusterName: string, languageExtensionsToAdd: LanguageExtensionsList, options?: ClustersAddLanguageExtensionsOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, languageExtensionsToAdd: LanguageExtensionsList, options?: ClustersAddLanguageExtensionsOptionalParams) => PollerLike<OperationState<void>, void>

beginAddCalloutPolicies

Warning

This API is now deprecated.

use addCalloutPolicies instead

beginAddCalloutPolicies: (resourceGroupName: string, clusterName: string, calloutPolicies: _CalloutPoliciesList, options?: ClustersAddCalloutPoliciesOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, clusterName: string, calloutPolicies: _CalloutPoliciesList, options?: ClustersAddCalloutPoliciesOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginAddCalloutPoliciesAndWait

Warning

This API is now deprecated.

use addCalloutPolicies instead

beginAddCalloutPoliciesAndWait: (resourceGroupName: string, clusterName: string, calloutPolicies: _CalloutPoliciesList, options?: ClustersAddCalloutPoliciesOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, clusterName: string, calloutPolicies: _CalloutPoliciesList, options?: ClustersAddCalloutPoliciesOptionalParams) => Promise<void>

beginAddLanguageExtensions

Warning

This API is now deprecated.

use addLanguageExtensions instead

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

Property Value

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

beginAddLanguageExtensionsAndWait

Warning

This API is now deprecated.

use addLanguageExtensions instead

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

Property Value

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

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDetachFollowerDatabases

Warning

This API is now deprecated.

use detachFollowerDatabases instead

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

Property Value

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

beginDetachFollowerDatabasesAndWait

Warning

This API is now deprecated.

use detachFollowerDatabases instead

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

Property Value

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

beginDiagnoseVirtualNetwork

Warning

This API is now deprecated.

use diagnoseVirtualNetwork instead

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

Property Value

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

beginDiagnoseVirtualNetworkAndWait

Warning

This API is now deprecated.

use diagnoseVirtualNetwork instead

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

Property Value

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

beginMigrate

Warning

This API is now deprecated.

use migrate instead

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

Property Value

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

beginMigrateAndWait

Warning

This API is now deprecated.

use migrate instead

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

Property Value

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

beginRemoveCalloutPolicy

Warning

This API is now deprecated.

use removeCalloutPolicy instead

beginRemoveCalloutPolicy: (resourceGroupName: string, clusterName: string, calloutPolicy: CalloutPolicyToRemove, options?: ClustersRemoveCalloutPolicyOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, clusterName: string, calloutPolicy: CalloutPolicyToRemove, options?: ClustersRemoveCalloutPolicyOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginRemoveCalloutPolicyAndWait

Warning

This API is now deprecated.

use removeCalloutPolicy instead

beginRemoveCalloutPolicyAndWait: (resourceGroupName: string, clusterName: string, calloutPolicy: CalloutPolicyToRemove, options?: ClustersRemoveCalloutPolicyOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, clusterName: string, calloutPolicy: CalloutPolicyToRemove, options?: ClustersRemoveCalloutPolicyOptionalParams) => Promise<void>

beginRemoveLanguageExtensions

Warning

This API is now deprecated.

use removeLanguageExtensions instead

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

Property Value

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

beginRemoveLanguageExtensionsAndWait

Warning

This API is now deprecated.

use removeLanguageExtensions instead

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

Property Value

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

beginStart

Warning

This API is now deprecated.

use start instead

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

Property Value

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

beginStartAndWait

Warning

This API is now deprecated.

use start instead

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

Property Value

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

beginStop

Warning

This API is now deprecated.

use stop instead

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

Property Value

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

beginStopAndWait

Warning

This API is now deprecated.

use stop instead

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

Property Value

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

beginUpdate

Warning

This API is now deprecated.

use update instead

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

Property Value

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

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

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

Property Value

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

checkNameAvailability

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

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

Property Value

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

createOrUpdate

Create or update a Kusto cluster.

createOrUpdate: (resourceGroupName: string, clusterName: string, parameters: Cluster, options?: ClustersCreateOrUpdateOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>

Property Value

(resourceGroupName: string, clusterName: string, parameters: Cluster, options?: ClustersCreateOrUpdateOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>

delete

Deletes a Kusto cluster.

delete: (resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

detachFollowerDatabases

Detaches all followers of a database owned by this cluster.

detachFollowerDatabases: (resourceGroupName: string, clusterName: string, followerDatabaseToRemove: FollowerDatabaseDefinition, options?: ClustersDetachFollowerDatabasesOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, followerDatabaseToRemove: FollowerDatabaseDefinition, options?: ClustersDetachFollowerDatabasesOptionalParams) => PollerLike<OperationState<void>, void>

diagnoseVirtualNetwork

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

diagnoseVirtualNetwork: (resourceGroupName: string, clusterName: string, options?: ClustersDiagnoseVirtualNetworkOptionalParams) => PollerLike<OperationState<DiagnoseVirtualNetworkResult>, DiagnoseVirtualNetworkResult>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersDiagnoseVirtualNetworkOptionalParams) => PollerLike<OperationState<DiagnoseVirtualNetworkResult>, DiagnoseVirtualNetworkResult>

get

Gets a Kusto cluster.

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

Property Value

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

list

Lists all Kusto clusters within a subscription.

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

Property Value

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

listByResourceGroup

Lists all Kusto clusters within a resource group.

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

Property Value

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

listCalloutPolicies

Returns the allowed callout policies for the specified service.

listCalloutPolicies: (resourceGroupName: string, clusterName: string, options?: ClustersListCalloutPoliciesOptionalParams) => PagedAsyncIterableIterator<CalloutPolicy, CalloutPolicy[], PageSettings>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersListCalloutPoliciesOptionalParams) => PagedAsyncIterableIterator<CalloutPolicy, CalloutPolicy[], PageSettings>

listFollowerDatabases

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

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

Property Value

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

listFollowerDatabasesGet

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

listFollowerDatabasesGet: (resourceGroupName: string, clusterName: string, options?: ClustersListFollowerDatabasesGetOptionalParams) => PagedAsyncIterableIterator<FollowerDatabaseDefinitionGet, FollowerDatabaseDefinitionGet[], PageSettings>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersListFollowerDatabasesGetOptionalParams) => PagedAsyncIterableIterator<FollowerDatabaseDefinitionGet, FollowerDatabaseDefinitionGet[], PageSettings>

listLanguageExtensions

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

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

Property Value

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

listOutboundNetworkDependenciesEndpoints

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

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

Property Value

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

listSkus

Lists eligible SKUs for Kusto resource provider.

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

Property Value

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

listSkusByResource

Returns the SKUs available for the provided resource.

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

Property Value

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

migrate

Migrate data from a Kusto cluster to another cluster.

migrate: (resourceGroupName: string, clusterName: string, clusterMigrateRequest: ClusterMigrateRequest, options?: ClustersMigrateOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, clusterMigrateRequest: ClusterMigrateRequest, options?: ClustersMigrateOptionalParams) => PollerLike<OperationState<void>, void>

removeCalloutPolicy

Removes callout policy for engine services.

removeCalloutPolicy: (resourceGroupName: string, clusterName: string, calloutPolicy: CalloutPolicyToRemove, options?: ClustersRemoveCalloutPolicyOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, calloutPolicy: CalloutPolicyToRemove, options?: ClustersRemoveCalloutPolicyOptionalParams) => PollerLike<OperationState<void>, void>

removeLanguageExtensions

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

removeLanguageExtensions: (resourceGroupName: string, clusterName: string, languageExtensionsToRemove: LanguageExtensionsList, options?: ClustersRemoveLanguageExtensionsOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, languageExtensionsToRemove: LanguageExtensionsList, options?: ClustersRemoveLanguageExtensionsOptionalParams) => PollerLike<OperationState<void>, void>

start

Starts a Kusto cluster.

start: (resourceGroupName: string, clusterName: string, options?: ClustersStartOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersStartOptionalParams) => PollerLike<OperationState<void>, void>

stop

Stops a Kusto cluster.

stop: (resourceGroupName: string, clusterName: string, options?: ClustersStopOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersStopOptionalParams) => PollerLike<OperationState<void>, void>

update

Update a Kusto cluster.

update: (resourceGroupName: string, clusterName: string, parameters: ClusterUpdate, options?: ClustersUpdateOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>

Property Value

(resourceGroupName: string, clusterName: string, parameters: ClusterUpdate, options?: ClustersUpdateOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>