Clusters interface

Package:

@azure/arm-operationalinsights

Interface representing a Clusters.

Methods

beginCreateOrUpdate(string, string, Cluster, ClustersCreateOrUpdateOptionalParams)	Create or update a Log Analytics cluster.
beginCreateOrUpdateAndWait(string, string, Cluster, ClustersCreateOrUpdateOptionalParams)	Create or update a Log Analytics cluster.
beginDelete(string, string, ClustersDeleteOptionalParams)	Deletes a cluster instance.
beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)	Deletes a cluster instance.
beginUpdate(string, string, ClusterPatch, ClustersUpdateOptionalParams)	Updates a Log Analytics cluster.
beginUpdateAndWait(string, string, ClusterPatch, ClustersUpdateOptionalParams)	Updates a Log Analytics cluster.
get(string, string, ClustersGetOptionalParams)	Gets a Log Analytics cluster instance.
list(ClustersListOptionalParams)	Gets the Log Analytics clusters in a subscription.
listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)	Gets Log Analytics clusters in a resource group.

Method Details

beginCreateOrUpdate(string, string, Cluster, ClustersCreateOrUpdateOptionalParams)

Create or update a Log Analytics cluster.

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

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Log Analytics cluster.

parameters

Cluster

The parameters required to create or update a Log Analytics cluster.

options

ClustersCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<Cluster>, Cluster>>

beginCreateOrUpdateAndWait(string, string, Cluster, ClustersCreateOrUpdateOptionalParams)

Create or update a Log Analytics 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 Log Analytics cluster.

parameters

Cluster

The parameters required to create or update a Log Analytics cluster.

options

ClustersCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Cluster>

beginDelete(string, string, ClustersDeleteOptionalParams)

Deletes a cluster instance.

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

Parameters

resourceGroupName

string

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

clusterName

string

Name of the Log Analytics Cluster.

options

ClustersDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)

Deletes a cluster instance.

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

Name of the Log Analytics Cluster.

options

ClustersDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, ClusterPatch, ClustersUpdateOptionalParams)

Updates a Log Analytics cluster.

function beginUpdate(resourceGroupName: string, clusterName: string, parameters: ClusterPatch, options?: ClustersUpdateOptionalParams): Promise<PollerLike<PollOperationState<Cluster>, Cluster>>

Parameters

resourceGroupName

string

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

clusterName

string

Name of the Log Analytics Cluster.

parameters

ClusterPatch

The parameters required to patch a Log Analytics cluster.

options

ClustersUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<Cluster>, Cluster>>

beginUpdateAndWait(string, string, ClusterPatch, ClustersUpdateOptionalParams)

Updates a Log Analytics cluster.

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

Parameters

resourceGroupName

string

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

clusterName

string

Name of the Log Analytics Cluster.

parameters

ClusterPatch

The parameters required to patch a Log Analytics cluster.

options

ClustersUpdateOptionalParams

The options parameters.

Returns

Promise<Cluster>

get(string, string, ClustersGetOptionalParams)

Gets a Log Analytics cluster instance.

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

Name of the Log Analytics Cluster.

options

ClustersGetOptionalParams

The options parameters.

Returns

Promise<Cluster>

list(ClustersListOptionalParams)

Gets the Log Analytics clusters in a subscription.

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

Parameters

options

ClustersListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)

Gets Log Analytics clusters in 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

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>