Package com.azure.resourcemanager.redisenterprise.models

Interface Databases

public interface Databases

Resource collection API of Databases.

Method Summary

Modifier and Type	Method	Description
Database.DefinitionStages.Blank	define(String name)	Begins definition for a new Database resource.
void	delete(String resourceGroupName, String clusterName, String databaseName)	Deletes a single database.
void	delete(String resourceGroupName, String clusterName, String databaseName, com.azure.core.util.Context context)	Deletes a single database.
void	deleteById(String id)	Deletes a single database.
void	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Deletes a single database.
void	export(String resourceGroupName, String clusterName, String databaseName, ExportClusterParameters parameters)	Exports a database file from target database.
void	export(String resourceGroupName, String clusterName, String databaseName, ExportClusterParameters parameters, com.azure.core.util.Context context)	Exports a database file from target database.
void	forceUnlink(String resourceGroupName, String clusterName, String databaseName, ForceUnlinkParameters parameters)	Forcibly removes the link to the specified database resource.
void	forceUnlink(String resourceGroupName, String clusterName, String databaseName, ForceUnlinkParameters parameters, com.azure.core.util.Context context)	Forcibly removes the link to the specified database resource.
Database	get(String resourceGroupName, String clusterName, String databaseName)	Gets information about a database in a RedisEnterprise cluster.
Database	getById(String id)	Gets information about a database in a RedisEnterprise cluster.
com.azure.core.http.rest.Response<Database>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Gets information about a database in a RedisEnterprise cluster.
com.azure.core.http.rest.Response<Database>	getWithResponse(String resourceGroupName, String clusterName, String databaseName, com.azure.core.util.Context context)	Gets information about a database in a RedisEnterprise cluster.
void	importMethod(String resourceGroupName, String clusterName, String databaseName, ImportClusterParameters parameters)	Imports database files to target database.
void	importMethod(String resourceGroupName, String clusterName, String databaseName, ImportClusterParameters parameters, com.azure.core.util.Context context)	Imports database files to target database.
com.azure.core.http.rest.PagedIterable<Database>	listByCluster(String resourceGroupName, String clusterName)	Gets all databases in the specified RedisEnterprise cluster.
com.azure.core.http.rest.PagedIterable<Database>	listByCluster(String resourceGroupName, String clusterName, com.azure.core.util.Context context)	Gets all databases in the specified RedisEnterprise cluster.
AccessKeys	listKeys(String resourceGroupName, String clusterName, String databaseName)	Retrieves the access keys for the RedisEnterprise database.
com.azure.core.http.rest.Response<AccessKeys>	listKeysWithResponse(String resourceGroupName, String clusterName, String databaseName, com.azure.core.util.Context context)	Retrieves the access keys for the RedisEnterprise database.
AccessKeys	regenerateKey(String resourceGroupName, String clusterName, String databaseName, RegenerateKeyParameters parameters)	Regenerates the RedisEnterprise database's access keys.
AccessKeys	regenerateKey(String resourceGroupName, String clusterName, String databaseName, RegenerateKeyParameters parameters, com.azure.core.util.Context context)	Regenerates the RedisEnterprise database's access keys.

Method Detail

listByCluster

com.azure.core.http.rest.PagedIterable<Database> listByCluster(String resourceGroupName,
                                                               String clusterName)

Gets all databases in the specified RedisEnterprise cluster.

Parameters:

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

clusterName - The name of the RedisEnterprise cluster.

Returns:

all databases in the specified RedisEnterprise cluster 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.

listByCluster

com.azure.core.http.rest.PagedIterable<Database> listByCluster(String resourceGroupName,
                                                               String clusterName,
                                                               com.azure.core.util.Context context)

Gets all databases in the specified 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:

all databases in the specified RedisEnterprise cluster 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.

get

Database get(String resourceGroupName,
             String clusterName,
             String databaseName)

Gets information about a database in a RedisEnterprise cluster.

Parameters:

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

clusterName - The name of the RedisEnterprise cluster.

databaseName - The name of the database.

Returns:

information about a database in 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.

getWithResponse

com.azure.core.http.rest.Response<Database> getWithResponse(String resourceGroupName,
                                                            String clusterName,
                                                            String databaseName,
                                                            com.azure.core.util.Context context)

Gets information about a database in a RedisEnterprise cluster.

Parameters:

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

clusterName - The name of the RedisEnterprise cluster.

databaseName - The name of the database.

context - The context to associate with this operation.

Returns:

information about a database in 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.

delete

void delete(String resourceGroupName,
            String clusterName,
            String databaseName)

Deletes a single database.

Parameters:

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

clusterName - The name of the RedisEnterprise cluster.

databaseName - The name of the database.

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

Deletes a single database.

Parameters:

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

clusterName - The name of the RedisEnterprise cluster.

databaseName - The name of the database.

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.

listKeys

AccessKeys listKeys(String resourceGroupName,
                    String clusterName,
                    String databaseName)

Retrieves the access keys for the RedisEnterprise database.

Parameters:

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

clusterName - The name of the RedisEnterprise cluster.

databaseName - The name of the database.

Returns:

access keys.

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.

listKeysWithResponse

com.azure.core.http.rest.Response<AccessKeys> listKeysWithResponse(String resourceGroupName,
                                                                   String clusterName,
                                                                   String databaseName,
                                                                   com.azure.core.util.Context context)

Retrieves the access keys for the RedisEnterprise database.

Parameters:

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

clusterName - The name of the RedisEnterprise cluster.

databaseName - The name of the database.

context - The context to associate with this operation.

Returns:

access keys 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.

regenerateKey

AccessKeys regenerateKey(String resourceGroupName,
                         String clusterName,
                         String databaseName,
                         RegenerateKeyParameters parameters)

Regenerates the RedisEnterprise database's access keys.

Parameters:

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

clusterName - The name of the RedisEnterprise cluster.

databaseName - The name of the database.

parameters - Specifies which key to regenerate.

Returns:

access keys.

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.

regenerateKey

AccessKeys regenerateKey(String resourceGroupName,
                         String clusterName,
                         String databaseName,
                         RegenerateKeyParameters parameters,
                         com.azure.core.util.Context context)

Regenerates the RedisEnterprise database's access keys.

Parameters:

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

clusterName - The name of the RedisEnterprise cluster.

databaseName - The name of the database.

parameters - Specifies which key to regenerate.

context - The context to associate with this operation.

Returns:

access keys.

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.

importMethod

void importMethod(String resourceGroupName,
                  String clusterName,
                  String databaseName,
                  ImportClusterParameters parameters)

Imports database files to target database.

Parameters:

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

clusterName - The name of the RedisEnterprise cluster.

databaseName - The name of the database.

parameters - Storage information for importing into 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.

importMethod

void importMethod(String resourceGroupName,
                  String clusterName,
                  String databaseName,
                  ImportClusterParameters parameters,
                  com.azure.core.util.Context context)

Imports database files to target database.

Parameters:

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

clusterName - The name of the RedisEnterprise cluster.

databaseName - The name of the database.

parameters - Storage information for importing into the 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.

export

void export(String resourceGroupName,
            String clusterName,
            String databaseName,
            ExportClusterParameters parameters)

Exports a database file from target database.

Parameters:

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

clusterName - The name of the RedisEnterprise cluster.

databaseName - The name of the database.

parameters - Storage information for exporting into 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.

export

void export(String resourceGroupName,
            String clusterName,
            String databaseName,
            ExportClusterParameters parameters,
            com.azure.core.util.Context context)

Exports a database file from target database.

Parameters:

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

clusterName - The name of the RedisEnterprise cluster.

databaseName - The name of the database.

parameters - Storage information for exporting into the 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.

forceUnlink

void forceUnlink(String resourceGroupName,
                 String clusterName,
                 String databaseName,
                 ForceUnlinkParameters parameters)

Forcibly removes the link to the specified database resource.

Parameters:

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

clusterName - The name of the RedisEnterprise cluster.

databaseName - The name of the database.

parameters - Information identifying the database to be unlinked.

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.

forceUnlink

void forceUnlink(String resourceGroupName,
                 String clusterName,
                 String databaseName,
                 ForceUnlinkParameters parameters,
                 com.azure.core.util.Context context)

Forcibly removes the link to the specified database resource.

Parameters:

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

clusterName - The name of the RedisEnterprise cluster.

databaseName - The name of the database.

parameters - Information identifying the database to be unlinked.

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.

getById

Database getById(String id)

Gets information about a database in a RedisEnterprise cluster.

Parameters:

id - the resource ID.

Returns:

information about a database in 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<Database> getByIdWithResponse(String id,
                                                                com.azure.core.util.Context context)

Gets information about a database in a RedisEnterprise cluster.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

information about a database in 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

void deleteById(String id)

Deletes a single database.

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

void deleteByIdWithResponse(String id,
                            com.azure.core.util.Context context)

Deletes a single database.

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

Database.DefinitionStages.Blank define(String name)

Begins definition for a new Database resource.

Parameters:

name - resource name.

Returns:

the first stage of the new Database definition.