ClustersClient Interface

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<ClusterInner>,ClusterInner> beginCreateOrUpdate(String resourceGroupName, String clusterName, ClusterInner parameters)

Creates or updates a Service Fabric cluster resource.

abstract SyncPoller<PollResult<ClusterInner>,ClusterInner> beginCreateOrUpdate(String resourceGroupName, String clusterName, ClusterInner parameters, Context context)

Creates or updates a Service Fabric cluster resource.

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

Updates the configuration of a Service Fabric cluster resource.

abstract SyncPoller<PollResult<ClusterInner>,ClusterInner> beginUpdate(String resourceGroupName, String clusterName, ClusterUpdateParameters parameters, Context context)

Updates the configuration of a Service Fabric cluster resource.

abstract ClusterInner createOrUpdate(String resourceGroupName, String clusterName, ClusterInner parameters)

Creates or updates a Service Fabric cluster resource.

abstract ClusterInner createOrUpdate(String resourceGroupName, String clusterName, ClusterInner parameters, Context context)

Creates or updates a Service Fabric cluster resource.

abstract void delete(String resourceGroupName, String clusterName)

Deletes a Service Fabric cluster resource.

abstract Response<Void> deleteWithResponse(String resourceGroupName, String clusterName, Context context)

Deletes a Service Fabric cluster resource.

abstract ClusterInner getByResourceGroup(String resourceGroupName, String clusterName)

Gets a Service Fabric cluster resource.

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

Gets a Service Fabric cluster resource.

abstract PagedIterable<ClusterInner> list()

Gets the list of Service Fabric cluster resources created in the specified subscription.

abstract PagedIterable<ClusterInner> list(Context context)

Gets the list of Service Fabric cluster resources created in the specified subscription.

abstract PagedIterable<ClusterInner> listByResourceGroup(String resourceGroupName)

Gets the list of Service Fabric cluster resources created in the specified resource group.

abstract PagedIterable<ClusterInner> listByResourceGroup(String resourceGroupName, Context context)

Gets the list of Service Fabric cluster resources created in the specified resource group.

abstract UpgradableVersionPathResultInner listUpgradableVersions(String resourceGroupName, String clusterName)

Operation to get the minimum and maximum upgradable version from the current cluster version, or the required path to get to the an specific target version.

abstract Response<UpgradableVersionPathResultInner> listUpgradableVersionsWithResponse(String resourceGroupName, String clusterName, UpgradableVersionsDescription versionsDescription, Context context)

Operation to get the minimum and maximum upgradable version from the current cluster version, or the required path to get to the an specific target version.

abstract ClusterInner update(String resourceGroupName, String clusterName, ClusterUpdateParameters parameters)

Updates the configuration of a Service Fabric cluster resource.

abstract ClusterInner update(String resourceGroupName, String clusterName, ClusterUpdateParameters parameters, Context context)

Updates the configuration of a Service Fabric cluster resource.

Method Details

beginCreateOrUpdate

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

Creates or updates a Service Fabric cluster resource. Create or update a Service Fabric cluster resource with the specified name.

Parameters:

resourceGroupName - The name of the resource group.
clusterName - The name of the cluster resource.
parameters - The cluster resource.

Returns:

the SyncPoller<T,U> for polling of the cluster resource.

beginCreateOrUpdate

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

Creates or updates a Service Fabric cluster resource. Create or update a Service Fabric cluster resource with the specified name.

Parameters:

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

Returns:

the SyncPoller<T,U> for polling of the cluster resource.

beginUpdate

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

Updates the configuration of a Service Fabric cluster resource. Update the configuration of a Service Fabric cluster resource with the specified name.

Parameters:

resourceGroupName - The name of the resource group.
clusterName - The name of the cluster resource.
parameters - The parameters which contains the property value and property name which used to update the cluster configuration.

Returns:

the SyncPoller<T,U> for polling of the cluster resource.

beginUpdate

public abstract SyncPoller<PollResult<ClusterInner>,ClusterInner> beginUpdate(String resourceGroupName, String clusterName, ClusterUpdateParameters parameters, Context context)

Updates the configuration of a Service Fabric cluster resource. Update the configuration of a Service Fabric cluster resource with the specified name.

Parameters:

resourceGroupName - The name of the resource group.
clusterName - The name of the cluster resource.
parameters - The parameters which contains the property value and property name which used to update the cluster configuration.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of the cluster resource.

createOrUpdate

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

Creates or updates a Service Fabric cluster resource. Create or update a Service Fabric cluster resource with the specified name.

Parameters:

resourceGroupName - The name of the resource group.
clusterName - The name of the cluster resource.
parameters - The cluster resource.

Returns:

the cluster resource.

createOrUpdate

public abstract ClusterInner createOrUpdate(String resourceGroupName, String clusterName, ClusterInner parameters, Context context)

Creates or updates a Service Fabric cluster resource. Create or update a Service Fabric cluster resource with the specified name.

Parameters:

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

Returns:

the cluster resource.

delete

public abstract void delete(String resourceGroupName, String clusterName)

Deletes a Service Fabric cluster resource. Delete a Service Fabric cluster resource with the specified name.

Parameters:

resourceGroupName - The name of the resource group.
clusterName - The name of the cluster resource.

deleteWithResponse

public abstract Response<Void> deleteWithResponse(String resourceGroupName, String clusterName, Context context)

Deletes a Service Fabric cluster resource. Delete a Service Fabric cluster resource with the specified name.

Parameters:

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

Returns:

getByResourceGroup

public abstract ClusterInner getByResourceGroup(String resourceGroupName, String clusterName)

Gets a Service Fabric cluster resource. Get a Service Fabric cluster resource created or in the process of being created in the specified resource group.

Parameters:

resourceGroupName - The name of the resource group.
clusterName - The name of the cluster resource.

Returns:

a Service Fabric cluster resource created or in the process of being created in the specified resource group.

getByResourceGroupWithResponse

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

Gets a Service Fabric cluster resource. Get a Service Fabric cluster resource created or in the process of being created in the specified resource group.

Parameters:

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

Returns:

a Service Fabric cluster resource created or in the process of being created in the specified resource group along with Response<T>.

list

public abstract PagedIterable<ClusterInner> list()

Gets the list of Service Fabric cluster resources created in the specified subscription. Gets all Service Fabric cluster resources created or in the process of being created in the subscription.

Returns:

all Service Fabric cluster resources created or in the process of being created in the subscription as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<ClusterInner> list(Context context)

Gets the list of Service Fabric cluster resources created in the specified subscription. Gets all Service Fabric cluster resources created or in the process of being created in the subscription.

Parameters:

context - The context to associate with this operation.

Returns:

all Service Fabric cluster resources created or in the process of being created in the subscription as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<ClusterInner> listByResourceGroup(String resourceGroupName)

Gets the list of Service Fabric cluster resources created in the specified resource group. Gets all Service Fabric cluster resources created or in the process of being created in the resource group.

Parameters:

resourceGroupName - The name of the resource group.

Returns:

all Service Fabric cluster resources created or in the process of being created in the resource group as paginated response with PagedIterable<T>.

listByResourceGroup

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

Gets the list of Service Fabric cluster resources created in the specified resource group. Gets all Service Fabric cluster resources created or in the process of being created in the resource group.

Parameters:

resourceGroupName - The name of the resource group.
context - The context to associate with this operation.

Returns:

all Service Fabric cluster resources created or in the process of being created in the resource group as paginated response with PagedIterable<T>.

listUpgradableVersions

public abstract UpgradableVersionPathResultInner listUpgradableVersions(String resourceGroupName, String clusterName)

Operation to get the minimum and maximum upgradable version from the current cluster version, or the required path to get to the an specific target version. If a target is not provided, it will get the minimum and maximum versions available from the current cluster version. If a target is given, it will provide the required path to get from the current cluster version to the target version.

Parameters:

resourceGroupName - The name of the resource group.
clusterName - The name of the cluster resource.

Returns:

the list of intermediate cluster code versions for an upgrade or downgrade.

listUpgradableVersionsWithResponse

public abstract Response<UpgradableVersionPathResultInner> listUpgradableVersionsWithResponse(String resourceGroupName, String clusterName, UpgradableVersionsDescription versionsDescription, Context context)

Operation to get the minimum and maximum upgradable version from the current cluster version, or the required path to get to the an specific target version. If a target is not provided, it will get the minimum and maximum versions available from the current cluster version. If a target is given, it will provide the required path to get from the current cluster version to the target version.

Parameters:

resourceGroupName - The name of the resource group.
clusterName - The name of the cluster resource.
versionsDescription - The upgrade path description with target version.
context - The context to associate with this operation.

Returns:

the list of intermediate cluster code versions for an upgrade or downgrade along with Response<T>.

update

public abstract ClusterInner update(String resourceGroupName, String clusterName, ClusterUpdateParameters parameters)

Updates the configuration of a Service Fabric cluster resource. Update the configuration of a Service Fabric cluster resource with the specified name.

Parameters:

resourceGroupName - The name of the resource group.
clusterName - The name of the cluster resource.
parameters - The parameters which contains the property value and property name which used to update the cluster configuration.

Returns:

the cluster resource.

update

public abstract ClusterInner update(String resourceGroupName, String clusterName, ClusterUpdateParameters parameters, Context context)

Updates the configuration of a Service Fabric cluster resource. Update the configuration of a Service Fabric cluster resource with the specified name.

Parameters:

resourceGroupName - The name of the resource group.
clusterName - The name of the cluster resource.
parameters - The parameters which contains the property value and property name which used to update the cluster configuration.
context - The context to associate with this operation.

Returns:

the cluster resource.

Applies to