Package com.azure.resourcemanager.mysql.models

Interface ServerKeys

public interface ServerKeys

Resource collection API of ServerKeys.

Method Summary

Modifier and Type	Method	Description
ServerKey.DefinitionStages.Blank	define(String name)	Begins definition for a new ServerKey resource.
void	delete(String serverName, String keyName, String resourceGroupName)	Deletes the MySQL Server key with the given name.
void	delete(String serverName, String keyName, String resourceGroupName, com.azure.core.util.Context context)	Deletes the MySQL Server key with the given name.
void	deleteById(String id)	Deletes the MySQL Server key with the given name.
void	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Deletes the MySQL Server key with the given name.
ServerKey	get(String resourceGroupName, String serverName, String keyName)	Gets a MySQL Server key.
ServerKey	getById(String id)	Gets a MySQL Server key.
com.azure.core.http.rest.Response<ServerKey>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Gets a MySQL Server key.
com.azure.core.http.rest.Response<ServerKey>	getWithResponse(String resourceGroupName, String serverName, String keyName, com.azure.core.util.Context context)	Gets a MySQL Server key.
com.azure.core.http.rest.PagedIterable<ServerKey>	list(String resourceGroupName, String serverName)	Gets a list of Server keys.
com.azure.core.http.rest.PagedIterable<ServerKey>	list(String resourceGroupName, String serverName, com.azure.core.util.Context context)	Gets a list of Server keys.

Method Detail

list

com.azure.core.http.rest.PagedIterable<ServerKey> list(String resourceGroupName,
                                                       String serverName)

Gets a list of Server keys.

Parameters:

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

serverName - The name of the server.

Returns:

a list of Server 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.

list

com.azure.core.http.rest.PagedIterable<ServerKey> list(String resourceGroupName,
                                                       String serverName,
                                                       com.azure.core.util.Context context)

Gets a list of Server keys.

Parameters:

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

serverName - The name of the server.

context - The context to associate with this operation.

Returns:

a list of Server 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.

get

ServerKey get(String resourceGroupName,
              String serverName,
              String keyName)

Gets a MySQL Server key.

Parameters:

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

serverName - The name of the server.

keyName - The name of the MySQL Server key to be retrieved.

Returns:

a MySQL Server key.

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<ServerKey> getWithResponse(String resourceGroupName,
                                                             String serverName,
                                                             String keyName,
                                                             com.azure.core.util.Context context)

Gets a MySQL Server key.

Parameters:

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

serverName - The name of the server.

keyName - The name of the MySQL Server key to be retrieved.

context - The context to associate with this operation.

Returns:

a MySQL Server key 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 serverName,
            String keyName,
            String resourceGroupName)

Deletes the MySQL Server key with the given name.

Parameters:

serverName - The name of the server.

keyName - The name of the MySQL Server key to be deleted.

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

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

Deletes the MySQL Server key with the given name.

Parameters:

serverName - The name of the server.

keyName - The name of the MySQL Server key to be deleted.

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

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

ServerKey getById(String id)

Gets a MySQL Server key.

Parameters:

id - the resource ID.

Returns:

a MySQL Server key 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<ServerKey> getByIdWithResponse(String id,
                                                                 com.azure.core.util.Context context)

Gets a MySQL Server key.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

a MySQL Server key 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 the MySQL Server key with the given name.

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 the MySQL Server key with the given name.

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

ServerKey.DefinitionStages.Blank define(String name)

Begins definition for a new ServerKey resource.

Parameters:

name - resource name.

Returns:

the first stage of the new ServerKey definition.