Package version:

Interface Clusters

Interface representing a Clusters.

Hierarchy

Clusters

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait beginUpdate beginUpdateAndWait get list listByResourceGroup

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, clusterName: string, parameters: Cluster, options?: ClustersCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<Cluster>, Cluster>>
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<Cluster>, Cluster>>
- Defined in operationsInterfaces/clusters.ts:51

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, clusterName: string, parameters: Cluster, options?: ClustersCreateOrUpdateOptionalParams): Promise<Cluster>
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<Cluster>
- Defined in operationsInterfaces/clusters.ts:69

beginDelete

beginDelete(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
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>>
- Defined in operationsInterfaces/clusters.ts:81

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams): Promise<void>
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>
- Defined in operationsInterfaces/clusters.ts:92

beginUpdate

beginUpdate(resourceGroupName: string, clusterName: string, parameters: ClusterPatch, options?: ClustersUpdateOptionalParams): Promise<PollerLike<PollOperationState<Cluster>, Cluster>>
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<Cluster>, Cluster>>
- Defined in operationsInterfaces/clusters.ts:115

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, clusterName: string, parameters: ClusterPatch, options?: ClustersUpdateOptionalParams): Promise<Cluster>
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<Cluster>
- Defined in operationsInterfaces/clusters.ts:133

get

get(resourceGroupName: string, clusterName: string, options?: ClustersGetOptionalParams): Promise<Cluster>
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<Cluster>
- Defined in operationsInterfaces/clusters.ts:103

list

list(options?: ClustersListOptionalParams): PagedAsyncIterableIterator<Cluster>
Gets the Log Analytics clusters in a subscription.
Parameters
- Optional options: ClustersListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Cluster>
- Defined in operationsInterfaces/clusters.ts:41

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: ClustersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Cluster>
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>
- Defined in operationsInterfaces/clusters.ts:33

Interface Clusters

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

clusterName: string

parameters: Cluster

Optional options: ClustersCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<Cluster>, Cluster>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

clusterName: string

parameters: Cluster

Optional options: ClustersCreateOrUpdateOptionalParams

Returns Promise<Cluster>

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<Cluster>, Cluster>>

beginUpdateAndWait

Parameters

resourceGroupName: string

clusterName: string

parameters: ClusterPatch

Optional options: ClustersUpdateOptionalParams

Returns Promise<Cluster>

get

Parameters

resourceGroupName: string

clusterName: string

Optional options: ClustersGetOptionalParams

Returns Promise<Cluster>

list

Parameters

Optional options: ClustersListOptionalParams

Returns PagedAsyncIterableIterator<Cluster>

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: ClustersListByResourceGroupOptionalParams

Returns PagedAsyncIterableIterator<Cluster>

Settings

Member Visibility

Theme

`Optional` options: ClustersCreateOrUpdateOptionalParams

`Optional` options: ClustersCreateOrUpdateOptionalParams

`Optional` options: ClustersDeleteOptionalParams

`Optional` options: ClustersDeleteOptionalParams

`Optional` options: ClustersUpdateOptionalParams

`Optional` options: ClustersUpdateOptionalParams

`Optional` options: ClustersGetOptionalParams

`Optional` options: ClustersListOptionalParams

`Optional` options: ClustersListByResourceGroupOptionalParams