Clusters | @azure/arm-operationalinsights

Interface representing a Clusters.

Hierarchy

Clusters

Implemented by

ClustersImpl

Index

Methods

beginCreateOrUpdate

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

- Defined in operationsInterfaces/clusters.ts:51
Create or update a Log Analytics 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.
- Optional options: ClustersCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ClustersCreateOrUpdateResponse>, ClustersCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

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

- Defined in operationsInterfaces/clusters.ts:69
Create or update a Log Analytics 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.
- Optional options: ClustersCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ClustersCreateOrUpdateResponse>

beginDelete

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

- Defined in operationsInterfaces/clusters.ts:81
Deletes a cluster instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- clusterName: string
  
  Name of the Log Analytics Cluster.
- Optional options: ClustersDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

- Defined in operationsInterfaces/clusters.ts:92
Deletes a cluster instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- clusterName: string
  
  Name of the Log Analytics Cluster.
- Optional options: ClustersDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdate

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

- Defined in operationsInterfaces/clusters.ts:115
Updates a Log Analytics 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.
- Optional options: ClustersUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ClustersUpdateResponse>, ClustersUpdateResponse>>

beginUpdateAndWait

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

- Defined in operationsInterfaces/clusters.ts:133
Updates a Log Analytics 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.
- Optional options: ClustersUpdateOptionalParams
  
  The options parameters.
Returns Promise<ClustersUpdateResponse>

get

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

- Defined in operationsInterfaces/clusters.ts:103
Gets a Log Analytics cluster instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- clusterName: string
  
  Name of the Log Analytics Cluster.
- Optional options: ClustersGetOptionalParams
  
  The options parameters.
Returns Promise<ClustersGetResponse>

list

list(options?: ClustersListOptionalParams): PagedAsyncIterableIterator<Cluster>

- Defined in operationsInterfaces/clusters.ts:41
Gets the Log Analytics clusters in a subscription.

Parameters
- Optional options: ClustersListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Cluster>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: ClustersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Cluster>

- Defined in operationsInterfaces/clusters.ts:33
Gets Log Analytics clusters in a resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- Optional options: ClustersListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Cluster>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

clusterName: string

parameters: Cluster

Optional options: ClustersCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<ClustersCreateOrUpdateResponse>, ClustersCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

clusterName: string

parameters: Cluster

Optional options: ClustersCreateOrUpdateOptionalParams

Returns Promise<ClustersCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

clusterName: string

Optional options: ClustersDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

clusterName: string

Optional options: ClustersDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

clusterName: string

parameters: ClusterPatch

Optional options: ClustersUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<ClustersUpdateResponse>, ClustersUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

clusterName: string

parameters: ClusterPatch

Optional options: ClustersUpdateOptionalParams

Returns Promise<ClustersUpdateResponse>

get

Parameters

resourceGroupName: string

clusterName: string

Optional options: ClustersGetOptionalParams

Returns Promise<ClustersGetResponse>

list

Parameters

Optional options: ClustersListOptionalParams

Returns PagedAsyncIterableIterator<Cluster>

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: ClustersListByResourceGroupOptionalParams

Returns PagedAsyncIterableIterator<Cluster>