ClustersClient Interface

Package:
com.azure.resourcemanager.networkcloud.fluent
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-networkcloud:2.1.0

public interface ClustersClient

An instance of this class provides access to all the operations defined in ClustersClient.

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<OperationStatusResultInner>,OperationStatusResultInner> beginContinueUpdateVersion(String resourceGroupName, String clusterName, ClusterContinueUpdateVersionParameters clusterContinueUpdateVersionParameters)

Continue a paused update to the cluster version.
abstract SyncPoller<PollResult<OperationStatusResultInner>,OperationStatusResultInner> beginContinueUpdateVersion(String resourceGroupName, String clusterName, ClusterContinueUpdateVersionParameters clusterContinueUpdateVersionParameters, Context context)

Continue a paused update to the cluster version.
abstract SyncPoller<PollResult<ClusterInner>,ClusterInner> beginCreateOrUpdate(String resourceGroupName, String clusterName, ClusterInner clusterParameters)

Create or update the cluster.
abstract SyncPoller<PollResult<ClusterInner>,ClusterInner> beginCreateOrUpdate(String resourceGroupName, String clusterName, ClusterInner clusterParameters, String ifMatch, String ifNoneMatch, Context context)

Create or update the cluster.
abstract SyncPoller<PollResult<OperationStatusResultInner>,OperationStatusResultInner> beginDelete(String resourceGroupName, String clusterName)

Delete the cluster.
abstract SyncPoller<PollResult<OperationStatusResultInner>,OperationStatusResultInner> beginDelete(String resourceGroupName, String clusterName, String ifMatch, String ifNoneMatch, Context context)

Delete the cluster.
abstract SyncPoller<PollResult<OperationStatusResultInner>,OperationStatusResultInner> beginDeploy(String resourceGroupName, String clusterName)

Deploy the cluster.
abstract SyncPoller<PollResult<OperationStatusResultInner>,OperationStatusResultInner> beginDeploy(String resourceGroupName, String clusterName, ClusterDeployParameters clusterDeployParameters, Context context)

Deploy the cluster.
abstract SyncPoller<PollResult<OperationStatusResultInner>,OperationStatusResultInner> beginScanRuntime(String resourceGroupName, String clusterName)

Execute a runtime protection scan on the cluster.
abstract SyncPoller<PollResult<OperationStatusResultInner>,OperationStatusResultInner> beginScanRuntime(String resourceGroupName, String clusterName, ClusterScanRuntimeParameters clusterScanRuntimeParameters, Context context)

Execute a runtime protection scan on the cluster.
abstract SyncPoller<PollResult<ClusterInner>,ClusterInner> beginUpdate(String resourceGroupName, String clusterName)

Patch the cluster.
abstract SyncPoller<PollResult<ClusterInner>,ClusterInner> beginUpdate(String resourceGroupName, String clusterName, String ifMatch, String ifNoneMatch, ClusterPatchParameters clusterUpdateParameters, Context context)

Patch the cluster.
abstract SyncPoller<PollResult<OperationStatusResultInner>,OperationStatusResultInner> beginUpdateVersion(String resourceGroupName, String clusterName, ClusterUpdateVersionParameters clusterUpdateVersionParameters)

Update the cluster version.
abstract SyncPoller<PollResult<OperationStatusResultInner>,OperationStatusResultInner> beginUpdateVersion(String resourceGroupName, String clusterName, ClusterUpdateVersionParameters clusterUpdateVersionParameters, Context context)

Update the cluster version.
abstract OperationStatusResultInner continueUpdateVersion(String resourceGroupName, String clusterName, ClusterContinueUpdateVersionParameters clusterContinueUpdateVersionParameters)

Continue a paused update to the cluster version.
abstract OperationStatusResultInner continueUpdateVersion(String resourceGroupName, String clusterName, ClusterContinueUpdateVersionParameters clusterContinueUpdateVersionParameters, Context context)

Continue a paused update to the cluster version.
abstract ClusterInner createOrUpdate(String resourceGroupName, String clusterName, ClusterInner clusterParameters)

Create or update the cluster.
abstract ClusterInner createOrUpdate(String resourceGroupName, String clusterName, ClusterInner clusterParameters, String ifMatch, String ifNoneMatch, Context context)

Create or update the cluster.
abstract OperationStatusResultInner delete(String resourceGroupName, String clusterName)

Delete the cluster.
abstract OperationStatusResultInner delete(String resourceGroupName, String clusterName, String ifMatch, String ifNoneMatch, Context context)

Delete the cluster.
abstract OperationStatusResultInner deploy(String resourceGroupName, String clusterName)

Deploy the cluster.
abstract OperationStatusResultInner deploy(String resourceGroupName, String clusterName, ClusterDeployParameters clusterDeployParameters, Context context)

Deploy the cluster.
abstract ClusterInner getByResourceGroup(String resourceGroupName, String clusterName)

Retrieve the cluster.
abstract Response<ClusterInner> getByResourceGroupWithResponse(String resourceGroupName, String clusterName, Context context)

Retrieve the cluster.
abstract PagedIterable<ClusterInner> list()

List clusters in the subscription.
abstract PagedIterable<ClusterInner> list(Integer top, String skipToken, Context context)

List clusters in the subscription.
abstract PagedIterable<ClusterInner> listByResourceGroup(String resourceGroupName)

List clusters in the resource group.
abstract PagedIterable<ClusterInner> listByResourceGroup(String resourceGroupName, Integer top, String skipToken, Context context)

List clusters in the resource group.
abstract OperationStatusResultInner scanRuntime(String resourceGroupName, String clusterName)

Execute a runtime protection scan on the cluster.
abstract OperationStatusResultInner scanRuntime(String resourceGroupName, String clusterName, ClusterScanRuntimeParameters clusterScanRuntimeParameters, Context context)

Execute a runtime protection scan on the cluster.
abstract ClusterInner update(String resourceGroupName, String clusterName)

Patch the cluster.
abstract ClusterInner update(String resourceGroupName, String clusterName, String ifMatch, String ifNoneMatch, ClusterPatchParameters clusterUpdateParameters, Context context)

Patch the cluster.
abstract OperationStatusResultInner updateVersion(String resourceGroupName, String clusterName, ClusterUpdateVersionParameters clusterUpdateVersionParameters)

Update the cluster version.
abstract OperationStatusResultInner updateVersion(String resourceGroupName, String clusterName, ClusterUpdateVersionParameters clusterUpdateVersionParameters, Context context)

Update the cluster version.

Method Details

beginContinueUpdateVersion

public abstract SyncPoller<PollResult<OperationStatusResultInner>,OperationStatusResultInner> beginContinueUpdateVersion(String resourceGroupName, String clusterName, ClusterContinueUpdateVersionParameters clusterContinueUpdateVersionParameters)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
clusterContinueUpdateVersionParameters - The request body.

Returns:

the SyncPoller<T,U> for polling of the current status of an async operation.

beginContinueUpdateVersion

public abstract SyncPoller<PollResult<OperationStatusResultInner>,OperationStatusResultInner> beginContinueUpdateVersion(String resourceGroupName, String clusterName, ClusterContinueUpdateVersionParameters clusterContinueUpdateVersionParameters, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
clusterContinueUpdateVersionParameters - The request body.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of the current status of an async operation.

beginCreateOrUpdate

public abstract SyncPoller<PollResult<ClusterInner>,ClusterInner> beginCreateOrUpdate(String resourceGroupName, String clusterName, ClusterInner clusterParameters)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
clusterParameters - The request body.

Returns:

the SyncPoller<T,U> for polling of cluster represents the on-premises Network Cloud cluster.

beginCreateOrUpdate

public abstract SyncPoller<PollResult<ClusterInner>,ClusterInner> beginCreateOrUpdate(String resourceGroupName, String clusterName, ClusterInner clusterParameters, String ifMatch, String ifNoneMatch, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
clusterParameters - The request body.
ifMatch - The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
ifNoneMatch - Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of cluster represents the on-premises Network Cloud cluster.

beginDelete

public abstract SyncPoller<PollResult<OperationStatusResultInner>,OperationStatusResultInner> beginDelete(String resourceGroupName, String clusterName)

Delete the cluster. Delete the provided cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.

Returns:

the SyncPoller<T,U> for polling of the current status of an async operation.

beginDelete

public abstract SyncPoller<PollResult<OperationStatusResultInner>,OperationStatusResultInner> beginDelete(String resourceGroupName, String clusterName, String ifMatch, String ifNoneMatch, Context context)

Delete the cluster. Delete the provided cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
ifMatch - The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
ifNoneMatch - Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of the current status of an async operation.

beginDeploy

public abstract SyncPoller<PollResult<OperationStatusResultInner>,OperationStatusResultInner> beginDeploy(String resourceGroupName, String clusterName)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.

Returns:

the SyncPoller<T,U> for polling of the current status of an async operation.

beginDeploy

public abstract SyncPoller<PollResult<OperationStatusResultInner>,OperationStatusResultInner> beginDeploy(String resourceGroupName, String clusterName, ClusterDeployParameters clusterDeployParameters, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
clusterDeployParameters - The request body.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of the current status of an async operation.

beginScanRuntime

public abstract SyncPoller<PollResult<OperationStatusResultInner>,OperationStatusResultInner> beginScanRuntime(String resourceGroupName, String clusterName)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.

Returns:

the SyncPoller<T,U> for polling of the current status of an async operation.

beginScanRuntime

public abstract SyncPoller<PollResult<OperationStatusResultInner>,OperationStatusResultInner> beginScanRuntime(String resourceGroupName, String clusterName, ClusterScanRuntimeParameters clusterScanRuntimeParameters, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
clusterScanRuntimeParameters - The request body.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of the current status of an async operation.

beginUpdate

public abstract SyncPoller<PollResult<ClusterInner>,ClusterInner> beginUpdate(String resourceGroupName, String clusterName)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.

Returns:

the SyncPoller<T,U> for polling of cluster represents the on-premises Network Cloud cluster.

beginUpdate

public abstract SyncPoller<PollResult<ClusterInner>,ClusterInner> beginUpdate(String resourceGroupName, String clusterName, String ifMatch, String ifNoneMatch, ClusterPatchParameters clusterUpdateParameters, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
ifMatch - The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
ifNoneMatch - Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.
clusterUpdateParameters - The request body.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of cluster represents the on-premises Network Cloud cluster.

beginUpdateVersion

public abstract SyncPoller<PollResult<OperationStatusResultInner>,OperationStatusResultInner> beginUpdateVersion(String resourceGroupName, String clusterName, ClusterUpdateVersionParameters clusterUpdateVersionParameters)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
clusterUpdateVersionParameters - The request body.

Returns:

the SyncPoller<T,U> for polling of the current status of an async operation.

beginUpdateVersion

public abstract SyncPoller<PollResult<OperationStatusResultInner>,OperationStatusResultInner> beginUpdateVersion(String resourceGroupName, String clusterName, ClusterUpdateVersionParameters clusterUpdateVersionParameters, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
clusterUpdateVersionParameters - The request body.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of the current status of an async operation.

continueUpdateVersion

public abstract OperationStatusResultInner continueUpdateVersion(String resourceGroupName, String clusterName, ClusterContinueUpdateVersionParameters clusterContinueUpdateVersionParameters)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
clusterContinueUpdateVersionParameters - The request body.

Returns:

the current status of an async operation.

continueUpdateVersion

public abstract OperationStatusResultInner continueUpdateVersion(String resourceGroupName, String clusterName, ClusterContinueUpdateVersionParameters clusterContinueUpdateVersionParameters, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
clusterContinueUpdateVersionParameters - The request body.
context - The context to associate with this operation.

Returns:

the current status of an async operation.

createOrUpdate

public abstract ClusterInner createOrUpdate(String resourceGroupName, String clusterName, ClusterInner clusterParameters)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
clusterParameters - The request body.

Returns:

cluster represents the on-premises Network Cloud cluster.

createOrUpdate

public abstract ClusterInner createOrUpdate(String resourceGroupName, String clusterName, ClusterInner clusterParameters, String ifMatch, String ifNoneMatch, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
clusterParameters - The request body.
ifMatch - The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
ifNoneMatch - Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.
context - The context to associate with this operation.

Returns:

cluster represents the on-premises Network Cloud cluster.

delete

public abstract OperationStatusResultInner delete(String resourceGroupName, String clusterName)

Delete the cluster. Delete the provided cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.

Returns:

the current status of an async operation.

delete

public abstract OperationStatusResultInner delete(String resourceGroupName, String clusterName, String ifMatch, String ifNoneMatch, Context context)

Delete the cluster. Delete the provided cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
ifMatch - The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
ifNoneMatch - Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.
context - The context to associate with this operation.

Returns:

the current status of an async operation.

deploy

public abstract OperationStatusResultInner deploy(String resourceGroupName, String clusterName)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.

Returns:

the current status of an async operation.

deploy

public abstract OperationStatusResultInner deploy(String resourceGroupName, String clusterName, ClusterDeployParameters clusterDeployParameters, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
clusterDeployParameters - The request body.
context - The context to associate with this operation.

Returns:

the current status of an async operation.

getByResourceGroup

public abstract ClusterInner getByResourceGroup(String resourceGroupName, String clusterName)

Retrieve the cluster. Get properties of the provided cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.

Returns:

properties of the provided cluster.

getByResourceGroupWithResponse

public abstract Response<ClusterInner> getByResourceGroupWithResponse(String resourceGroupName, String clusterName, Context context)

Retrieve the cluster. Get properties of the provided cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
context - The context to associate with this operation.

Returns:

properties of the provided cluster along with Response<T>.

list

public abstract PagedIterable<ClusterInner> list()

List clusters in the subscription. Get a list of clusters in the provided subscription.

Returns:

a list of clusters in the provided subscription as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<ClusterInner> list(Integer top, String skipToken, Context context)

List clusters in the subscription. Get a list of clusters in the provided subscription.

Parameters:

top - The maximum number of resources to return from the operation. Example: '$top=10'.
skipToken - The opaque token that the server returns to indicate where to continue listing resources from. This is used for paging through large result sets.
context - The context to associate with this operation.

Returns:

a list of clusters in the provided subscription as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<ClusterInner> listByResourceGroup(String resourceGroupName)

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

Parameters:

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

Returns:

a list of clusters in the provided resource group as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<ClusterInner> listByResourceGroup(String resourceGroupName, Integer top, String skipToken, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
top - The maximum number of resources to return from the operation. Example: '$top=10'.
skipToken - The opaque token that the server returns to indicate where to continue listing resources from. This is used for paging through large result sets.
context - The context to associate with this operation.

Returns:

a list of clusters in the provided resource group as paginated response with PagedIterable<T>.

scanRuntime

public abstract OperationStatusResultInner scanRuntime(String resourceGroupName, String clusterName)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.

Returns:

the current status of an async operation.

scanRuntime

public abstract OperationStatusResultInner scanRuntime(String resourceGroupName, String clusterName, ClusterScanRuntimeParameters clusterScanRuntimeParameters, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
clusterScanRuntimeParameters - The request body.
context - The context to associate with this operation.

Returns:

the current status of an async operation.

update

public abstract ClusterInner update(String resourceGroupName, String clusterName)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.

Returns:

cluster represents the on-premises Network Cloud cluster.

update

public abstract ClusterInner update(String resourceGroupName, String clusterName, String ifMatch, String ifNoneMatch, ClusterPatchParameters clusterUpdateParameters, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
ifMatch - The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
ifNoneMatch - Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.
clusterUpdateParameters - The request body.
context - The context to associate with this operation.

Returns:

cluster represents the on-premises Network Cloud cluster.

updateVersion

public abstract OperationStatusResultInner updateVersion(String resourceGroupName, String clusterName, ClusterUpdateVersionParameters clusterUpdateVersionParameters)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
clusterUpdateVersionParameters - The request body.

Returns:

the current status of an async operation.

updateVersion

public abstract OperationStatusResultInner updateVersion(String resourceGroupName, String clusterName, ClusterUpdateVersionParameters clusterUpdateVersionParameters, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
clusterUpdateVersionParameters - The request body.
context - The context to associate with this operation.

Returns:

the current status of an async operation.

Applies to