Interface Clusters
public interface Clusters
Resource collection API of Clusters.
-
Method Summary
Modifier and TypeMethodDescriptionBegins definition for a new Cluster resource.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.void
deleteById
(String id) Deletes an cluster.void
deleteByIdWithResponse
(String id, Boolean force, com.azure.core.util.Context context) Deletes an cluster.Gets a cluster.com.azure.core.http.rest.Response<Cluster>
getByIdWithResponse
(String id, com.azure.core.util.Context context) Gets a cluster.getByResourceGroup
(String resourceGroupName, String clusterName) Gets a cluster.com.azure.core.http.rest.Response<Cluster>
getByResourceGroupWithResponse
(String resourceGroupName, String clusterName, com.azure.core.util.Context context) Gets a cluster.com.azure.core.http.rest.PagedIterable<Cluster>
list()
Implements GET clusters in a subscription.com.azure.core.http.rest.PagedIterable<Cluster>
list
(com.azure.core.util.Context context) Implements GET clusters in a subscription.com.azure.core.http.rest.PagedIterable<Cluster>
listByResourceGroup
(String resourceGroupName) Implements GET clusters in a resource group.com.azure.core.http.rest.PagedIterable<Cluster>
listByResourceGroup
(String resourceGroupName, com.azure.core.util.Context context) Implements GET clusters in a resource group.
-
Method Details
-
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<Cluster> 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.
-
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<Cluster> 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<Cluster> 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.
-
getById
Gets a cluster.Implements cluster GET method.
- Parameters:
id
- the resource ID.- 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.
-
getByIdWithResponse
com.azure.core.http.rest.Response<Cluster> getByIdWithResponse(String id, com.azure.core.util.Context context) Gets a cluster.Implements cluster GET method.
- Parameters:
id
- the resource ID.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.
-
deleteById
Deletes an cluster.Implements cluster DELETE method.
- Parameters:
id
- the resource ID.- 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.
-
deleteByIdWithResponse
Deletes an cluster.Implements cluster DELETE method.
- Parameters:
id
- the resource ID.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.
-
define
Begins definition for a new Cluster resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new Cluster definition.
-