Interface RedisEnterprises
public interface RedisEnterprises
Resource collection API of RedisEnterprises.
-
Method Summary
Modifier and TypeMethodDescriptionBegins definition for a new Cluster resource.void
Deletes a RedisEnterprise cache cluster.void
deleteById
(String id) Deletes a RedisEnterprise cache cluster.void
deleteByIdWithResponse
(String id, com.azure.core.util.Context context) Deletes a RedisEnterprise cache cluster.void
deleteByResourceGroup
(String resourceGroupName, String clusterName) Deletes a RedisEnterprise cache cluster.Gets information about a RedisEnterprise cluster.com.azure.core.http.rest.Response<Cluster>
getByIdWithResponse
(String id, com.azure.core.util.Context context) Gets information about a RedisEnterprise cluster.getByResourceGroup
(String resourceGroupName, String clusterName) Gets information about a RedisEnterprise cluster.com.azure.core.http.rest.Response<Cluster>
getByResourceGroupWithResponse
(String resourceGroupName, String clusterName, com.azure.core.util.Context context) Gets information about a RedisEnterprise cluster.com.azure.core.http.rest.PagedIterable<Cluster>
list()
Gets all RedisEnterprise clusters in the specified subscription.com.azure.core.http.rest.PagedIterable<Cluster>
list
(com.azure.core.util.Context context) Gets all RedisEnterprise clusters in the specified subscription.com.azure.core.http.rest.PagedIterable<Cluster>
listByResourceGroup
(String resourceGroupName) Lists all RedisEnterprise clusters in a resource group.com.azure.core.http.rest.PagedIterable<Cluster>
listByResourceGroup
(String resourceGroupName, com.azure.core.util.Context context) Lists all RedisEnterprise clusters in a resource group.
-
Method Details
-
deleteByResourceGroup
Deletes a RedisEnterprise cache cluster.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.clusterName
- The name of the RedisEnterprise 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
Deletes a RedisEnterprise cache cluster.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.clusterName
- The name of the RedisEnterprise cluster.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.
-
getByResourceGroupWithResponse
com.azure.core.http.rest.Response<Cluster> getByResourceGroupWithResponse(String resourceGroupName, String clusterName, com.azure.core.util.Context context) Gets information about a RedisEnterprise cluster.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.clusterName
- The name of the RedisEnterprise cluster.context
- The context to associate with this operation.- Returns:
- information about a RedisEnterprise 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.
-
getByResourceGroup
Gets information about a RedisEnterprise cluster.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.clusterName
- The name of the RedisEnterprise cluster.- Returns:
- information about a RedisEnterprise 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.
-
listByResourceGroup
Lists all RedisEnterprise clusters in a resource group.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.- Returns:
- the response of a list-all operation 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) Lists all RedisEnterprise clusters in a resource group.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.context
- The context to associate with this operation.- Returns:
- the response of a list-all operation 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.
-
list
com.azure.core.http.rest.PagedIterable<Cluster> list()Gets all RedisEnterprise clusters in the specified subscription.- Returns:
- all RedisEnterprise clusters in the specified subscription 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
Gets all RedisEnterprise clusters in the specified subscription.- Parameters:
context
- The context to associate with this operation.- Returns:
- all RedisEnterprise clusters in the specified subscription 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 information about a RedisEnterprise cluster.- Parameters:
id
- the resource ID.- Returns:
- information about a RedisEnterprise 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 information about a RedisEnterprise cluster.- Parameters:
id
- the resource ID.context
- The context to associate with this operation.- Returns:
- information about a RedisEnterprise 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 a RedisEnterprise cache cluster.- 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 a RedisEnterprise cache cluster.- Parameters:
id
- the resource ID.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.
-