Package com.azure.resourcemanager.redisenterprise.fluent

Interface RedisEnterprisesClient

public interface RedisEnterprisesClient

An instance of this class provides access to all the operations defined in RedisEnterprisesClient.

Method Summary

Modifier and Type	Method	Description
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ClusterInner>,ClusterInner>	beginCreate(String resourceGroupName, String clusterName, ClusterInner parameters)	Creates or updates an existing (overwrite/recreate, with potential downtime) cache cluster.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ClusterInner>,ClusterInner>	beginCreate(String resourceGroupName, String clusterName, ClusterInner parameters, com.azure.core.util.Context context)	Creates or updates an existing (overwrite/recreate, with potential downtime) cache cluster.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginDelete(String resourceGroupName, String clusterName)	Deletes a RedisEnterprise cache cluster.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginDelete(String resourceGroupName, String clusterName, com.azure.core.util.Context context)	Deletes a RedisEnterprise cache cluster.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ClusterInner>,ClusterInner>	beginUpdate(String resourceGroupName, String clusterName, ClusterUpdate parameters)	Updates an existing RedisEnterprise cluster.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ClusterInner>,ClusterInner>	beginUpdate(String resourceGroupName, String clusterName, ClusterUpdate parameters, com.azure.core.util.Context context)	Updates an existing RedisEnterprise cluster.
ClusterInner	create(String resourceGroupName, String clusterName, ClusterInner parameters)	Creates or updates an existing (overwrite/recreate, with potential downtime) cache cluster.
ClusterInner	create(String resourceGroupName, String clusterName, ClusterInner parameters, com.azure.core.util.Context context)	Creates or updates an existing (overwrite/recreate, with potential downtime) cache cluster.
void	delete(String resourceGroupName, String clusterName)	Deletes a RedisEnterprise cache cluster.
void	delete(String resourceGroupName, String clusterName, com.azure.core.util.Context context)	Deletes a RedisEnterprise cache cluster.
ClusterInner	getByResourceGroup(String resourceGroupName, String clusterName)	Gets information about a RedisEnterprise cluster.
com.azure.core.http.rest.Response<ClusterInner>	getByResourceGroupWithResponse(String resourceGroupName, String clusterName, com.azure.core.util.Context context)	Gets information about a RedisEnterprise cluster.
com.azure.core.http.rest.PagedIterable<ClusterInner>	list()	Gets all RedisEnterprise clusters in the specified subscription.
com.azure.core.http.rest.PagedIterable<ClusterInner>	list(com.azure.core.util.Context context)	Gets all RedisEnterprise clusters in the specified subscription.
com.azure.core.http.rest.PagedIterable<ClusterInner>	listByResourceGroup(String resourceGroupName)	Lists all RedisEnterprise clusters in a resource group.
com.azure.core.http.rest.PagedIterable<ClusterInner>	listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)	Lists all RedisEnterprise clusters in a resource group.
ClusterInner	update(String resourceGroupName, String clusterName, ClusterUpdate parameters)	Updates an existing RedisEnterprise cluster.
ClusterInner	update(String resourceGroupName, String clusterName, ClusterUpdate parameters, com.azure.core.util.Context context)	Updates an existing RedisEnterprise cluster.

Method Detail

beginCreate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ClusterInner>,ClusterInner> beginCreate(String resourceGroupName,
                                                                                                                                  String clusterName,
                                                                                                                                  ClusterInner parameters)

Creates or updates an existing (overwrite/recreate, with potential downtime) cache cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

clusterName - The name of the RedisEnterprise cluster.

parameters - Parameters supplied to the Create RedisEnterprise operation.

Returns:

the SyncPoller for polling of describes 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.

beginCreate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ClusterInner>,ClusterInner> beginCreate(String resourceGroupName,
                                                                                                                                  String clusterName,
                                                                                                                                  ClusterInner parameters,
                                                                                                                                  com.azure.core.util.Context context)

Creates or updates an existing (overwrite/recreate, with potential downtime) cache cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

clusterName - The name of the RedisEnterprise cluster.

parameters - Parameters supplied to the Create RedisEnterprise operation.

context - The context to associate with this operation.

Returns:

the SyncPoller for polling of describes 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.

create

ClusterInner create(String resourceGroupName,
                    String clusterName,
                    ClusterInner parameters)

Creates or updates an existing (overwrite/recreate, with potential downtime) cache cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

clusterName - The name of the RedisEnterprise cluster.

parameters - Parameters supplied to the Create RedisEnterprise operation.

Returns:

describes 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.

create

ClusterInner create(String resourceGroupName,
                    String clusterName,
                    ClusterInner parameters,
                    com.azure.core.util.Context context)

Creates or updates an existing (overwrite/recreate, with potential downtime) cache cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

clusterName - The name of the RedisEnterprise cluster.

parameters - Parameters supplied to the Create RedisEnterprise operation.

context - The context to associate with this operation.

Returns:

describes 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.

beginUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ClusterInner>,ClusterInner> beginUpdate(String resourceGroupName,
                                                                                                                                  String clusterName,
                                                                                                                                  ClusterUpdate parameters)

Updates an existing RedisEnterprise cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

clusterName - The name of the RedisEnterprise cluster.

parameters - Parameters supplied to the Update RedisEnterprise operation.

Returns:

the SyncPoller for polling of describes 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.

beginUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ClusterInner>,ClusterInner> beginUpdate(String resourceGroupName,
                                                                                                                                  String clusterName,
                                                                                                                                  ClusterUpdate parameters,
                                                                                                                                  com.azure.core.util.Context context)

Updates an existing RedisEnterprise cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

clusterName - The name of the RedisEnterprise cluster.

parameters - Parameters supplied to the Update RedisEnterprise operation.

context - The context to associate with this operation.

Returns:

the SyncPoller for polling of describes 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.

update

ClusterInner update(String resourceGroupName,
                    String clusterName,
                    ClusterUpdate parameters)

Updates an existing RedisEnterprise cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

clusterName - The name of the RedisEnterprise cluster.

parameters - Parameters supplied to the Update RedisEnterprise operation.

Returns:

describes 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.

update

ClusterInner update(String resourceGroupName,
                    String clusterName,
                    ClusterUpdate parameters,
                    com.azure.core.util.Context context)

Updates an existing RedisEnterprise cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

clusterName - The name of the RedisEnterprise cluster.

parameters - Parameters supplied to the Update RedisEnterprise operation.

context - The context to associate with this operation.

Returns:

describes 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.

beginDelete

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName,
                                                                                                                  String clusterName)

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.

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,
                                                                                                                  com.azure.core.util.Context context)

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.

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

void delete(String resourceGroupName,
            String clusterName)

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

void delete(String resourceGroupName,
            String clusterName,
            com.azure.core.util.Context context)

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.

getByResourceGroup

ClusterInner getByResourceGroup(String resourceGroupName,
                                String clusterName)

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.

getByResourceGroupWithResponse

com.azure.core.http.rest.Response<ClusterInner> 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.

listByResourceGroup

com.azure.core.http.rest.PagedIterable<ClusterInner> listByResourceGroup(String resourceGroupName)

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<ClusterInner> 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<ClusterInner> 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

com.azure.core.http.rest.PagedIterable<ClusterInner> list(com.azure.core.util.Context context)

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.