Class ClustersImpl

Package version

Class containing Clusters operations.

Hierarchy

ClustersImpl

Implements

Clusters

Index

Constructors

constructor

Methods

Constructors

constructor

new ClustersImpl(client: AzureArcVMwareManagementServiceAPI): ClustersImpl

- Defined in operations/clusters.ts:39
Initialize a new instance of the class Clusters class.

Parameters
- client: AzureArcVMwareManagementServiceAPI
  
  Reference to the service client
Returns ClustersImpl

Methods

beginCreate

beginCreate(resourceGroupName: string, clusterName: string, options?: ClustersCreateOptionalParams): Promise<PollerLike<PollOperationState<ClustersCreateResponse>, ClustersCreateResponse>>

Implementation of Clusters.beginCreate
- Defined in operations/clusters.ts:150
Create Or Update cluster.

Parameters
- resourceGroupName: string
  
  The Resource Group Name.
- clusterName: string
  
  Name of the cluster.
- Optional options: ClustersCreateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ClustersCreateResponse>, ClustersCreateResponse>>

beginCreateAndWait

beginCreateAndWait(resourceGroupName: string, clusterName: string, options?: ClustersCreateOptionalParams): Promise<ClustersCreateResponse>

Implementation of Clusters.beginCreateAndWait
- Defined in operations/clusters.ts:219
Create Or Update cluster.

Parameters
- resourceGroupName: string
  
  The Resource Group Name.
- clusterName: string
  
  Name of the cluster.
- Optional options: ClustersCreateOptionalParams
  
  The options parameters.
Returns Promise<ClustersCreateResponse>

beginDelete

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

Implementation of Clusters.beginDelete
- Defined in operations/clusters.ts:272
Implements cluster DELETE method.

Parameters
- resourceGroupName: string
  
  The Resource Group Name.
- clusterName: string
  
  Name of the cluster.
- Optional options: ClustersDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

Implementation of Clusters.beginDeleteAndWait
- Defined in operations/clusters.ts:335
Implements cluster DELETE method.

Parameters
- resourceGroupName: string
  
  The Resource Group Name.
- clusterName: string
  
  Name of the cluster.
- Optional options: ClustersDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

Implementation of Clusters.get
- Defined in operations/clusters.ts:238
Implements cluster GET method.

Parameters
- resourceGroupName: string
  
  The Resource Group Name.
- clusterName: string
  
  Name of the cluster.
- Optional options: ClustersGetOptionalParams
  
  The options parameters.
Returns Promise<ClustersGetResponse>

list

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

Implementation of Clusters.list
- Defined in operations/clusters.ts:53
List of clusters in a subscription.

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

listByResourceGroup

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

Implementation of Clusters.listByResourceGroup
- Defined in operations/clusters.ts:96
List of clusters in a resource group.

Parameters
- resourceGroupName: string
  
  The Resource Group Name.
- Optional options: ClustersListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Cluster>

update

update(resourceGroupName: string, clusterName: string, options?: ClustersUpdateOptionalParams): Promise<ClustersUpdateResponse>

Implementation of Clusters.update
- Defined in operations/clusters.ts:255
API to update certain properties of the cluster resource.

Parameters
- resourceGroupName: string
  
  The Resource Group Name.
- clusterName: string
  
  Name of the cluster.
- Optional options: ClustersUpdateOptionalParams
  
  The options parameters.
Returns Promise<ClustersUpdateResponse>

Generated using TypeDoc