Share via

Clusters interface

  • Reference
Package:
@azure/arm-networkcloud

Interface representing a Clusters.

Methods

beginCreateOrUpdate(string, string, Cluster, ClustersCreateOrUpdateOptionalParams)

Create a new cluster or update the properties of the cluster if it exists.
beginCreateOrUpdateAndWait(string, string, Cluster, ClustersCreateOrUpdateOptionalParams)

Create a new cluster or update the properties of the cluster if it exists.
beginDelete(string, string, ClustersDeleteOptionalParams)

Delete the provided cluster.
beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)

Delete the provided cluster.
beginDeploy(string, string, ClustersDeployOptionalParams)

Deploy the cluster to the provided rack.
beginDeployAndWait(string, string, ClustersDeployOptionalParams)

Deploy the cluster to the provided rack.
beginUpdate(string, string, ClustersUpdateOptionalParams)

Patch the properties of the provided cluster, or update the tags associated with the cluster. Properties and tag updates can be done independently.
beginUpdateAndWait(string, string, ClustersUpdateOptionalParams)

Patch the properties of the provided cluster, or update the tags associated with the cluster. Properties and tag updates can be done independently.
beginUpdateVersion(string, string, ClusterUpdateVersionParameters, ClustersUpdateVersionOptionalParams)

Update the version of the provided cluster to one of the available supported versions.
beginUpdateVersionAndWait(string, string, ClusterUpdateVersionParameters, ClustersUpdateVersionOptionalParams)

Update the version of the provided cluster to one of the available supported versions.
get(string, string, ClustersGetOptionalParams)

Get properties of the provided cluster.
listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)

Get a list of clusters in the provided resource group.
listBySubscription(ClustersListBySubscriptionOptionalParams)

Get a list of clusters in the provided subscription.

Method Details

beginCreateOrUpdate(string, string, Cluster, ClustersCreateOrUpdateOptionalParams)

Create a new cluster or update the properties of the cluster if it exists.

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

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

clusterParameters
Cluster

The request body.

options
ClustersCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Cluster>, Cluster>>

beginCreateOrUpdateAndWait(string, string, Cluster, ClustersCreateOrUpdateOptionalParams)

Create a new cluster or update the properties of the cluster if it exists.

function beginCreateOrUpdateAndWait(resourceGroupName: string, clusterName: string, clusterParameters: 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 cluster.

clusterParameters
Cluster

The request body.

options
ClustersCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Cluster>

beginDelete(string, string, ClustersDeleteOptionalParams)

Delete the provided cluster.

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

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

options
ClustersDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)

Delete the provided cluster.

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

The name of the cluster.

options
ClustersDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginDeploy(string, string, ClustersDeployOptionalParams)

Deploy the cluster to the provided rack.

function beginDeploy(resourceGroupName: string, clusterName: string, options?: ClustersDeployOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

options
ClustersDeployOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

beginDeployAndWait(string, string, ClustersDeployOptionalParams)

Deploy the cluster to the provided rack.

function beginDeployAndWait(resourceGroupName: string, clusterName: string, options?: ClustersDeployOptionalParams): Promise<OperationStatusResult>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

options
ClustersDeployOptionalParams

The options parameters.

Returns

Promise<OperationStatusResult>

beginUpdate(string, string, ClustersUpdateOptionalParams)

Patch the properties of the provided cluster, or update the tags associated with the cluster. Properties and tag updates can be done independently.

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

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

options
ClustersUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Cluster>, Cluster>>

beginUpdateAndWait(string, string, ClustersUpdateOptionalParams)

Patch the properties of the provided cluster, or update the tags associated with the cluster. Properties and tag updates can be done independently.

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

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

options
ClustersUpdateOptionalParams

The options parameters.

Returns

Promise<Cluster>

beginUpdateVersion(string, string, ClusterUpdateVersionParameters, ClustersUpdateVersionOptionalParams)

Update the version of the provided cluster to one of the available supported versions.

function beginUpdateVersion(resourceGroupName: string, clusterName: string, clusterUpdateVersionParameters: ClusterUpdateVersionParameters, options?: ClustersUpdateVersionOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

clusterUpdateVersionParameters
ClusterUpdateVersionParameters

The request body.

options
ClustersUpdateVersionOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

beginUpdateVersionAndWait(string, string, ClusterUpdateVersionParameters, ClustersUpdateVersionOptionalParams)

Update the version of the provided cluster to one of the available supported versions.

function beginUpdateVersionAndWait(resourceGroupName: string, clusterName: string, clusterUpdateVersionParameters: ClusterUpdateVersionParameters, options?: ClustersUpdateVersionOptionalParams): Promise<OperationStatusResult>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

clusterUpdateVersionParameters
ClusterUpdateVersionParameters

The request body.

options
ClustersUpdateVersionOptionalParams

The options parameters.

Returns

Promise<OperationStatusResult>

get(string, string, ClustersGetOptionalParams)

Get properties of the provided cluster.

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

The name of the cluster.

options
ClustersGetOptionalParams

The options parameters.

Returns

Promise<Cluster>

listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)

Get a list of clusters in the provided 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>

listBySubscription(ClustersListBySubscriptionOptionalParams)

Get a list of clusters in the provided subscription.

function listBySubscription(options?: ClustersListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

Parameters

options
ClustersListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>