ClustersOperations interface

Package:
@azure/arm-networkcloud

Interface representing a Clusters operations.

Properties

beginContinueUpdateVersion
beginContinueUpdateVersionAndWait
beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginDeploy
beginDeployAndWait
beginInspect
beginInspectAndWait
beginRotateCredential
beginRotateCredentialAndWait
beginScanRuntime
beginScanRuntimeAndWait
beginUpdate
beginUpdateAndWait
beginUpdateVersion
beginUpdateVersionAndWait
continueUpdateVersion

Trigger the continuation of an update for a cluster with a matching update strategy that has paused after completing a segment of the update.
createOrUpdate

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

Delete the provided cluster.
deploy

Deploy the cluster using the rack configuration provided during creation.
get

Get properties of the provided cluster.
inspect

Trigger an inspection of the cluster to perform validation and optional corrective actions based on the supplied additional actions and filters.
listByResourceGroup

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

Get a list of clusters in the provided subscription.
rotateCredential

Rotate the specified cluster credential.
scanRuntime

Triggers the execution of a runtime protection scan to detect and remediate detected issues, in accordance with the cluster configuration.
update

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

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

Property Details

beginContinueUpdateVersion

Warning

This API is now deprecated.

use continueUpdateVersion instead

beginContinueUpdateVersion: (resourceGroupName: string, clusterName: string, clusterContinueUpdateVersionParameters: ClusterContinueUpdateVersionParameters, options?: ClustersContinueUpdateVersionOptionalParams) => Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

Property Value

(resourceGroupName: string, clusterName: string, clusterContinueUpdateVersionParameters: ClusterContinueUpdateVersionParameters, options?: ClustersContinueUpdateVersionOptionalParams) => Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

beginContinueUpdateVersionAndWait

Warning

This API is now deprecated.

use continueUpdateVersion instead

beginContinueUpdateVersionAndWait: (resourceGroupName: string, clusterName: string, clusterContinueUpdateVersionParameters: ClusterContinueUpdateVersionParameters, options?: ClustersContinueUpdateVersionOptionalParams) => Promise<OperationStatusResult>

Property Value

(resourceGroupName: string, clusterName: string, clusterContinueUpdateVersionParameters: ClusterContinueUpdateVersionParameters, options?: ClustersContinueUpdateVersionOptionalParams) => Promise<OperationStatusResult>

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, clusterName: string, clusterParameters: Cluster, options?: ClustersCreateOrUpdateOptionalParams) => Promise<Cluster>

Property Value

(resourceGroupName: string, clusterName: string, clusterParameters: Cluster, options?: ClustersCreateOrUpdateOptionalParams) => Promise<Cluster>

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams) => Promise<OperationStatusResult>

beginDeploy

Warning

This API is now deprecated.

use deploy instead

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

Property Value

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

beginDeployAndWait

Warning

This API is now deprecated.

use deploy instead

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

Property Value

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

beginInspect

Warning

This API is now deprecated.

use inspect instead

beginInspect: (resourceGroupName: string, clusterName: string, options?: ClustersInspectOptionalParams) => Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersInspectOptionalParams) => Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

beginInspectAndWait

Warning

This API is now deprecated.

use inspect instead

beginInspectAndWait: (resourceGroupName: string, clusterName: string, options?: ClustersInspectOptionalParams) => Promise<OperationStatusResult>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersInspectOptionalParams) => Promise<OperationStatusResult>

beginRotateCredential

Warning

This API is now deprecated.

use rotateCredential instead

beginRotateCredential: (resourceGroupName: string, clusterName: string, body: ClusterRotateCredentialParameters, options?: ClustersRotateCredentialOptionalParams) => Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

Property Value

(resourceGroupName: string, clusterName: string, body: ClusterRotateCredentialParameters, options?: ClustersRotateCredentialOptionalParams) => Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

beginRotateCredentialAndWait

Warning

This API is now deprecated.

use rotateCredential instead

beginRotateCredentialAndWait: (resourceGroupName: string, clusterName: string, body: ClusterRotateCredentialParameters, options?: ClustersRotateCredentialOptionalParams) => Promise<OperationStatusResult>

Property Value

(resourceGroupName: string, clusterName: string, body: ClusterRotateCredentialParameters, options?: ClustersRotateCredentialOptionalParams) => Promise<OperationStatusResult>

beginScanRuntime

Warning

This API is now deprecated.

use scanRuntime instead

beginScanRuntime: (resourceGroupName: string, clusterName: string, options?: ClustersScanRuntimeOptionalParams) => Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersScanRuntimeOptionalParams) => Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

beginScanRuntimeAndWait

Warning

This API is now deprecated.

use scanRuntime instead

beginScanRuntimeAndWait: (resourceGroupName: string, clusterName: string, options?: ClustersScanRuntimeOptionalParams) => Promise<OperationStatusResult>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersScanRuntimeOptionalParams) => Promise<OperationStatusResult>

beginUpdate

Warning

This API is now deprecated.

use update instead

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

Property Value

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

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

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

Property Value

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

beginUpdateVersion

Warning

This API is now deprecated.

use updateVersion instead

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

Property Value

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

beginUpdateVersionAndWait

Warning

This API is now deprecated.

use updateVersion instead

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

Property Value

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

continueUpdateVersion

Trigger the continuation of an update for a cluster with a matching update strategy that has paused after completing a segment of the update.

continueUpdateVersion: (resourceGroupName: string, clusterName: string, clusterContinueUpdateVersionParameters: ClusterContinueUpdateVersionParameters, options?: ClustersContinueUpdateVersionOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

Property Value

(resourceGroupName: string, clusterName: string, clusterContinueUpdateVersionParameters: ClusterContinueUpdateVersionParameters, options?: ClustersContinueUpdateVersionOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

createOrUpdate

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

createOrUpdate: (resourceGroupName: string, clusterName: string, clusterParameters: Cluster, options?: ClustersCreateOrUpdateOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>

Property Value

(resourceGroupName: string, clusterName: string, clusterParameters: Cluster, options?: ClustersCreateOrUpdateOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>

delete

Delete the provided cluster.

delete: (resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

deploy

Deploy the cluster using the rack configuration provided during creation.

deploy: (resourceGroupName: string, clusterName: string, options?: ClustersDeployOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersDeployOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

get

Get properties of the provided cluster.

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

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersGetOptionalParams) => Promise<Cluster>

inspect

Trigger an inspection of the cluster to perform validation and optional corrective actions based on the supplied additional actions and filters.

inspect: (resourceGroupName: string, clusterName: string, options?: ClustersInspectOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersInspectOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

listByResourceGroup

Get a list of clusters in the provided resource group.

listByResourceGroup: (resourceGroupName: string, options?: ClustersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

Property Value

(resourceGroupName: string, options?: ClustersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

listBySubscription

Get a list of clusters in the provided subscription.

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

Property Value

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

rotateCredential

Rotate the specified cluster credential.

rotateCredential: (resourceGroupName: string, clusterName: string, body: ClusterRotateCredentialParameters, options?: ClustersRotateCredentialOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

Property Value

(resourceGroupName: string, clusterName: string, body: ClusterRotateCredentialParameters, options?: ClustersRotateCredentialOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

scanRuntime

Triggers the execution of a runtime protection scan to detect and remediate detected issues, in accordance with the cluster configuration.

scanRuntime: (resourceGroupName: string, clusterName: string, options?: ClustersScanRuntimeOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersScanRuntimeOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

update

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

update: (resourceGroupName: string, clusterName: string, options?: ClustersUpdateOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersUpdateOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>

updateVersion

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

updateVersion: (resourceGroupName: string, clusterName: string, clusterUpdateVersionParameters: ClusterUpdateVersionParameters, options?: ClustersUpdateVersionOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

Property Value

(resourceGroupName: string, clusterName: string, clusterUpdateVersionParameters: ClusterUpdateVersionParameters, options?: ClustersUpdateVersionOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>