Package com.azure.resourcemanager.redisenterprise.models

Interface PrivateEndpointConnections

public interface PrivateEndpointConnections

Resource collection API of PrivateEndpointConnections.

Method Summary

Modifier and Type	Method	Description
PrivateEndpointConnection.DefinitionStages.Blank	define(String name)	Begins definition for a new PrivateEndpointConnection resource.
void	delete(String resourceGroupName, String clusterName, String privateEndpointConnectionName)	Deletes the specified private endpoint connection associated with the RedisEnterprise cluster.
void	deleteById(String id)	Deletes the specified private endpoint connection associated with the RedisEnterprise cluster.
com.azure.core.http.rest.Response<Void>	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Deletes the specified private endpoint connection associated with the RedisEnterprise cluster.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String clusterName, String privateEndpointConnectionName, com.azure.core.util.Context context)	Deletes the specified private endpoint connection associated with the RedisEnterprise cluster.
PrivateEndpointConnection	get(String resourceGroupName, String clusterName, String privateEndpointConnectionName)	Gets the specified private endpoint connection associated with the RedisEnterprise cluster.
PrivateEndpointConnection	getById(String id)	Gets the specified private endpoint connection associated with the RedisEnterprise cluster.
com.azure.core.http.rest.Response<PrivateEndpointConnection>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Gets the specified private endpoint connection associated with the RedisEnterprise cluster.
com.azure.core.http.rest.Response<PrivateEndpointConnection>	getWithResponse(String resourceGroupName, String clusterName, String privateEndpointConnectionName, com.azure.core.util.Context context)	Gets the specified private endpoint connection associated with the RedisEnterprise cluster.
com.azure.core.http.rest.PagedIterable<PrivateEndpointConnection>	list(String resourceGroupName, String clusterName)	Lists all the private endpoint connections associated with the RedisEnterprise cluster.
com.azure.core.http.rest.PagedIterable<PrivateEndpointConnection>	list(String resourceGroupName, String clusterName, com.azure.core.util.Context context)	Lists all the private endpoint connections associated with the RedisEnterprise cluster.

Method Detail

list

com.azure.core.http.rest.PagedIterable<PrivateEndpointConnection> list(String resourceGroupName,
                                                                       String clusterName)

Lists all the private endpoint connections associated with the RedisEnterprise cluster.

Parameters:

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

clusterName - The name of the RedisEnterprise cluster.

Returns:

list of private endpoint connection associated with the specified storage account 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<PrivateEndpointConnection> list(String resourceGroupName,
                                                                       String clusterName,
                                                                       com.azure.core.util.Context context)

Lists all the private endpoint connections associated with the 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:

list of private endpoint connection associated with the specified storage account 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

PrivateEndpointConnection get(String resourceGroupName,
                              String clusterName,
                              String privateEndpointConnectionName)

Gets the specified private endpoint connection associated with the RedisEnterprise cluster.

Parameters:

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

clusterName - The name of the RedisEnterprise cluster.

privateEndpointConnectionName - The name of the private endpoint connection associated with the Azure resource.

Returns:

the specified private endpoint connection associated with 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.

getWithResponse

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

Gets the specified private endpoint connection associated with the RedisEnterprise cluster.

Parameters:

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

clusterName - The name of the RedisEnterprise cluster.

privateEndpointConnectionName - The name of the private endpoint connection associated with the Azure resource.

context - The context to associate with this operation.

Returns:

the specified private endpoint connection associated with the 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 privateEndpointConnectionName)

Deletes the specified private endpoint connection associated with the RedisEnterprise cluster.

Parameters:

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

clusterName - The name of the RedisEnterprise cluster.

privateEndpointConnectionName - The name of the private endpoint connection associated with the Azure resource.

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.

deleteWithResponse

com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName,
                                                           String clusterName,
                                                           String privateEndpointConnectionName,
                                                           com.azure.core.util.Context context)

Deletes the specified private endpoint connection associated with the RedisEnterprise cluster.

Parameters:

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

clusterName - The name of the RedisEnterprise cluster.

privateEndpointConnectionName - The name of the private endpoint connection associated with the Azure resource.

context - The context to associate with this operation.

Returns:

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

getById

PrivateEndpointConnection getById(String id)

Gets the specified private endpoint connection associated with the RedisEnterprise cluster.

Parameters:

id - the resource ID.

Returns:

the specified private endpoint connection associated with the 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<PrivateEndpointConnection> getByIdWithResponse(String id,
                                                                                 com.azure.core.util.Context context)

Gets the specified private endpoint connection associated with the RedisEnterprise cluster.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the specified private endpoint connection associated with the 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 the specified private endpoint connection associated with the RedisEnterprise 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

com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id,
                                                               com.azure.core.util.Context context)

Deletes the specified private endpoint connection associated with the RedisEnterprise cluster.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

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

define

PrivateEndpointConnection.DefinitionStages.Blank define(String name)

Begins definition for a new PrivateEndpointConnection resource.

Parameters:

name - resource name.

Returns:

the first stage of the new PrivateEndpointConnection definition.