Clusters Interface

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

public interface Clusters

Resource collection API of Clusters.

Method Summary

Modifier and Type Method and Description
abstract OperationStatusResult continueUpdateVersion(String resourceGroupName, String clusterName, ClusterContinueUpdateVersionParameters clusterContinueUpdateVersionParameters)

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

Continue a paused update to the cluster version.
abstract Blank define(String name)

Begins definition for a new Cluster resource.
abstract OperationStatusResult delete(String resourceGroupName, String clusterName, String ifMatch, String ifNoneMatch, Context context)

Delete the cluster.
abstract OperationStatusResult deleteById(String id)

Delete the cluster.
abstract OperationStatusResult deleteByIdWithResponse(String id, String ifMatch, String ifNoneMatch, Context context)

Delete the cluster.
abstract OperationStatusResult deleteByResourceGroup(String resourceGroupName, String clusterName)

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

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

Deploy the cluster.
abstract Cluster getById(String id)

Retrieve the cluster.
abstract Response<Cluster> getByIdWithResponse(String id, Context context)

Retrieve the cluster.
abstract Cluster getByResourceGroup(String resourceGroupName, String clusterName)

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

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

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

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

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

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

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

Execute a runtime protection scan on the cluster.
abstract OperationStatusResult updateVersion(String resourceGroupName, String clusterName, ClusterUpdateVersionParameters clusterUpdateVersionParameters)

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

Update the cluster version.

Method Details

continueUpdateVersion

public abstract OperationStatusResult 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 OperationStatusResult 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.

define

public abstract Cluster.DefinitionStages.Blank define(String name)

Begins definition for a new Cluster resource.

Parameters:

name - resource name.

Returns:

the first stage of the new Cluster definition.

delete

public abstract OperationStatusResult 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.

deleteById

public abstract OperationStatusResult deleteById(String id)

Delete the cluster. Delete the provided cluster.

Parameters:

id - the resource ID.

Returns:

the current status of an async operation.

deleteByIdWithResponse

public abstract OperationStatusResult deleteByIdWithResponse(String id, String ifMatch, String ifNoneMatch, Context context)

Delete the cluster. Delete the provided cluster.

Parameters:

id - the resource ID.
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.

deleteByResourceGroup

public abstract OperationStatusResult deleteByResourceGroup(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.

deploy

public abstract OperationStatusResult 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 OperationStatusResult 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.

getById

public abstract Cluster getById(String id)

Retrieve the cluster. Get properties of the provided cluster.

Parameters:

id - the resource ID.

Returns:

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

getByIdWithResponse

public abstract Response<Cluster> getByIdWithResponse(String id, Context context)

Retrieve the cluster. Get properties of the provided cluster.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

Returns:

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

getByResourceGroup

public abstract Cluster 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<Cluster> 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<Cluster> 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<Cluster> 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<Cluster> 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<Cluster> 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 OperationStatusResult 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 OperationStatusResult 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.

updateVersion

public abstract OperationStatusResult 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 OperationStatusResult 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