Interface ClustersClient
public interface ClustersClient
An instance of this class provides access to all the operations defined in ClustersClient.
-
Method Summary
Modifier and TypeMethodDescriptioncom.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ClusterInner>,
ClusterInner> beginCreate
(String resourceGroupName, String clusterName, ClusterInner body) Implements cluster PUT method.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ClusterInner>,
ClusterInner> beginCreate
(String resourceGroupName, String clusterName, ClusterInner body, com.azure.core.util.Context context) Implements cluster PUT method.beginDelete
(String resourceGroupName, String clusterName, Boolean force) Deletes an cluster.beginDelete
(String resourceGroupName, String clusterName, Boolean force, com.azure.core.util.Context context) Deletes an cluster.Implements cluster PUT method.create
(String resourceGroupName, String clusterName, ClusterInner body) Implements cluster PUT method.create
(String resourceGroupName, String clusterName, ClusterInner body, com.azure.core.util.Context context) Implements cluster PUT method.void
Deletes an cluster.void
Deletes an cluster.void
delete
(String resourceGroupName, String clusterName, Boolean force, com.azure.core.util.Context context) Deletes an cluster.getByResourceGroup
(String resourceGroupName, String clusterName) Gets a cluster.com.azure.core.http.rest.Response<ClusterInner>
getByResourceGroupWithResponse
(String resourceGroupName, String clusterName, com.azure.core.util.Context context) Gets a cluster.com.azure.core.http.rest.PagedIterable<ClusterInner>
list()
Implements GET clusters in a subscription.com.azure.core.http.rest.PagedIterable<ClusterInner>
list
(com.azure.core.util.Context context) Implements GET clusters in a subscription.com.azure.core.http.rest.PagedIterable<ClusterInner>
listByResourceGroup
(String resourceGroupName) Implements GET clusters in a resource group.com.azure.core.http.rest.PagedIterable<ClusterInner>
listByResourceGroup
(String resourceGroupName, com.azure.core.util.Context context) Implements GET clusters in a resource group.Updates a cluster.com.azure.core.http.rest.Response<ClusterInner>
updateWithResponse
(String resourceGroupName, String clusterName, ResourcePatch body, com.azure.core.util.Context context) Updates a cluster.
-
Method Details
-
beginCreate
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ClusterInner>,ClusterInner> beginCreate(String resourceGroupName, String clusterName, ClusterInner body) Implements cluster PUT method.Create Or Update cluster.
- Parameters:
resourceGroupName
- The Resource Group Name.clusterName
- Name of the cluster.body
- Request payload.- Returns:
- the
SyncPoller
for polling of define the cluster. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
beginCreate
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ClusterInner>,ClusterInner> beginCreate(String resourceGroupName, String clusterName, ClusterInner body, com.azure.core.util.Context context) Implements cluster PUT method.Create Or Update cluster.
- Parameters:
resourceGroupName
- The Resource Group Name.clusterName
- Name of the cluster.body
- Request payload.context
- The context to associate with this operation.- Returns:
- the
SyncPoller
for polling of define the cluster. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
create
Implements cluster PUT method.Create Or Update cluster.
- Parameters:
resourceGroupName
- The Resource Group Name.clusterName
- Name of the cluster.body
- Request payload.- Returns:
- define the cluster.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
create
Implements cluster PUT method.Create Or Update cluster.
- Parameters:
resourceGroupName
- The Resource Group Name.clusterName
- Name of the cluster.- Returns:
- define the cluster.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
create
ClusterInner create(String resourceGroupName, String clusterName, ClusterInner body, com.azure.core.util.Context context) Implements cluster PUT method.Create Or Update cluster.
- Parameters:
resourceGroupName
- The Resource Group Name.clusterName
- Name of the cluster.body
- Request payload.context
- The context to associate with this operation.- Returns:
- define the cluster.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getByResourceGroup
Gets a cluster.Implements cluster GET method.
- Parameters:
resourceGroupName
- The Resource Group Name.clusterName
- Name of the cluster.- Returns:
- define the cluster.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getByResourceGroupWithResponse
com.azure.core.http.rest.Response<ClusterInner> getByResourceGroupWithResponse(String resourceGroupName, String clusterName, com.azure.core.util.Context context) Gets a cluster.Implements cluster GET method.
- Parameters:
resourceGroupName
- The Resource Group Name.clusterName
- Name of the cluster.context
- The context to associate with this operation.- Returns:
- define the cluster along with
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
update
Updates a cluster.API to update certain properties of the cluster resource.
- Parameters:
resourceGroupName
- The Resource Group Name.clusterName
- Name of the cluster.- Returns:
- define the cluster.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
updateWithResponse
com.azure.core.http.rest.Response<ClusterInner> updateWithResponse(String resourceGroupName, String clusterName, ResourcePatch body, com.azure.core.util.Context context) Updates a cluster.API to update certain properties of the cluster resource.
- Parameters:
resourceGroupName
- The Resource Group Name.clusterName
- Name of the cluster.body
- Resource properties to update.context
- The context to associate with this operation.- Returns:
- define the cluster along with
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
beginDelete
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String clusterName, Boolean force) Deletes an cluster.Implements cluster DELETE method.
- Parameters:
resourceGroupName
- The Resource Group Name.clusterName
- Name of the cluster.force
- Whether force delete was specified.- Returns:
- the
SyncPoller
for polling of long-running operation. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
beginDelete
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String clusterName, Boolean force, com.azure.core.util.Context context) Deletes an cluster.Implements cluster DELETE method.
- Parameters:
resourceGroupName
- The Resource Group Name.clusterName
- Name of the cluster.force
- Whether force delete was specified.context
- The context to associate with this operation.- Returns:
- the
SyncPoller
for polling of long-running operation. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
delete
Deletes an cluster.Implements cluster DELETE method.
- Parameters:
resourceGroupName
- The Resource Group Name.clusterName
- Name of the cluster.force
- Whether force delete was specified.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
delete
Deletes an cluster.Implements cluster DELETE method.
- Parameters:
resourceGroupName
- The Resource Group Name.clusterName
- Name of the cluster.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
delete
void delete(String resourceGroupName, String clusterName, Boolean force, com.azure.core.util.Context context) Deletes an cluster.Implements cluster DELETE method.
- Parameters:
resourceGroupName
- The Resource Group Name.clusterName
- Name of the cluster.force
- Whether force delete was specified.context
- The context to associate with this operation.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
list
com.azure.core.http.rest.PagedIterable<ClusterInner> list()Implements GET clusters in a subscription.List of clusters in a subscription.
- Returns:
- list of Clusters as paginated response with
PagedIterable
. - Throws:
com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
list
Implements GET clusters in a subscription.List of clusters in a subscription.
- Parameters:
context
- The context to associate with this operation.- Returns:
- list of Clusters as paginated response with
PagedIterable
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
listByResourceGroup
Implements GET clusters in a resource group.List of clusters in a resource group.
- Parameters:
resourceGroupName
- The Resource Group Name.- Returns:
- list of Clusters as paginated response with
PagedIterable
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
listByResourceGroup
com.azure.core.http.rest.PagedIterable<ClusterInner> listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context) Implements GET clusters in a resource group.List of clusters in a resource group.
- Parameters:
resourceGroupName
- The Resource Group Name.context
- The context to associate with this operation.- Returns:
- list of Clusters as paginated response with
PagedIterable
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-