com.azure.resourcemanager.postgresqlflexibleserver.models

Interface Configurations

public interface Configurations

Resource collection API of Configurations.

Method Summary

Modifier and Type	Method and Description
Configuration.DefinitionStages.Blank	define(String name) Begins definition for a new Configuration resource.
Configuration	get(String resourceGroupName, String serverName, String configurationName) Gets information about a configuration of server.
Configuration	getById(String id) Gets information about a configuration of server.
com.azure.core.http.rest.Response<Configuration>	getByIdWithResponse(String id, com.azure.core.util.Context context) Gets information about a configuration of server.
com.azure.core.http.rest.Response<Configuration>	getWithResponse(String resourceGroupName, String serverName, String configurationName, com.azure.core.util.Context context) Gets information about a configuration of server.
com.azure.core.http.rest.PagedIterable<Configuration>	listByServer(String resourceGroupName, String serverName) List all the configurations in a given server.
com.azure.core.http.rest.PagedIterable<Configuration>	listByServer(String resourceGroupName, String serverName, com.azure.core.util.Context context) List all the configurations in a given server.

Method Detail

listByServer

com.azure.core.http.rest.PagedIterable<Configuration> listByServer(String resourceGroupName,
                                                                   String serverName)

List all the configurations in a given server.

Parameters:

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

serverName - The name of the server.

Returns:

a list of server configurations.

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.

listByServer

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

List all the configurations in a given server.

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

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

Configuration get(String resourceGroupName,
                  String serverName,
                  String configurationName)

Gets information about a configuration of server.

Parameters:

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

serverName - The name of the server.

configurationName - The name of the server configuration.

Returns:

information about a configuration of server.

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

Gets information about a configuration of server.

Parameters:

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

serverName - The name of the server.

configurationName - The name of the server configuration.

context - The context to associate with this operation.

Returns:

information about a configuration of server.

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

Configuration getById(String id)

Gets information about a configuration of server.

Parameters:

id - the resource ID.

Returns:

information about a configuration of server.

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<Configuration> getByIdWithResponse(String id,
                                                                     com.azure.core.util.Context context)

Gets information about a configuration of server.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

information about a configuration of server.

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

Configuration.DefinitionStages.Blank define(String name)

Begins definition for a new Configuration resource.

Parameters:

name - resource name.

Returns:

the first stage of the new Configuration definition.