PrivateEndpointConnections Interface

public interface PrivateEndpointConnections

Resource collection API of PrivateEndpointConnections.

Method Summary

Modifier and Type Method and Description
abstract Blank define(String name)

Begins definition for a new PrivateEndpointConnection resource.

abstract void delete(String resourceGroupName, String privateLinkName, String privateEndpointConnectionName)

Deletes the specified private endpoint connection associated with the private link.

abstract void delete(String resourceGroupName, String privateLinkName, String privateEndpointConnectionName, Context context)

Deletes the specified private endpoint connection associated with the private link.

abstract void deleteById(String id)

Deletes the specified private endpoint connection associated with the private link.

abstract void deleteByIdWithResponse(String id, Context context)

Deletes the specified private endpoint connection associated with the private link.

abstract PrivateEndpointConnection get(String resourceGroupName, String privateLinkName, String privateEndpointConnectionName)

Gets the specified private endpoint connection associated with the private link.

abstract PrivateEndpointConnection getById(String id)

Gets the specified private endpoint connection associated with the private link.

abstract Response<PrivateEndpointConnection> getByIdWithResponse(String id, Context context)

Gets the specified private endpoint connection associated with the private link.

abstract Response<PrivateEndpointConnection> getWithResponse(String resourceGroupName, String privateLinkName, String privateEndpointConnectionName, Context context)

Gets the specified private endpoint connection associated with the private link.

abstract PagedIterable<PrivateEndpointConnection> list(String resourceGroupName, String privateLinkName)

Gets all private endpoint connections for a private link.

abstract PagedIterable<PrivateEndpointConnection> list(String resourceGroupName, String privateLinkName, Context context)

Gets all private endpoint connections for a private link.

Method Details

define

public abstract 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.

delete

public abstract void delete(String resourceGroupName, String privateLinkName, String privateEndpointConnectionName)

Deletes the specified private endpoint connection associated with the private link. This operation will disconnect the private endpoint and remove the connection configuration.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
privateLinkName - The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.
privateEndpointConnectionName - The name of the private endpoint connection associated with the Azure resource.

delete

public abstract void delete(String resourceGroupName, String privateLinkName, String privateEndpointConnectionName, Context context)

Deletes the specified private endpoint connection associated with the private link. This operation will disconnect the private endpoint and remove the connection configuration.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
privateLinkName - The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.
privateEndpointConnectionName - The name of the private endpoint connection associated with the Azure resource.
context - The context to associate with this operation.

deleteById

public abstract void deleteById(String id)

Deletes the specified private endpoint connection associated with the private link. This operation will disconnect the private endpoint and remove the connection configuration.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Deletes the specified private endpoint connection associated with the private link. This operation will disconnect the private endpoint and remove the connection configuration.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

get

public abstract PrivateEndpointConnection get(String resourceGroupName, String privateLinkName, String privateEndpointConnectionName)

Gets the specified private endpoint connection associated with the private link. Returns the connection details, status, and configuration for a specific private endpoint.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
privateLinkName - The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.
privateEndpointConnectionName - The name of the private endpoint connection associated with the Azure resource.

Returns:

the specified private endpoint connection associated with the private link.

getById

public abstract PrivateEndpointConnection getById(String id)

Gets the specified private endpoint connection associated with the private link. Returns the connection details, status, and configuration for a specific private endpoint.

Parameters:

id - the resource ID.

Returns:

the specified private endpoint connection associated with the private link along with Response<T>.

getByIdWithResponse

public abstract Response<PrivateEndpointConnection> getByIdWithResponse(String id, Context context)

Gets the specified private endpoint connection associated with the private link. Returns the connection details, status, and configuration for a specific private endpoint.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

Returns:

the specified private endpoint connection associated with the private link along with Response<T>.

getWithResponse

public abstract Response<PrivateEndpointConnection> getWithResponse(String resourceGroupName, String privateLinkName, String privateEndpointConnectionName, Context context)

Gets the specified private endpoint connection associated with the private link. Returns the connection details, status, and configuration for a specific private endpoint.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
privateLinkName - The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.
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 private link along with Response<T>.

list

public abstract PagedIterable<PrivateEndpointConnection> list(String resourceGroupName, String privateLinkName)

Gets all private endpoint connections for a private link. Returns the list of private endpoints that are connected or in the process of connecting to this private link.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
privateLinkName - The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.

Returns:

all private endpoint connections for a private link as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<PrivateEndpointConnection> list(String resourceGroupName, String privateLinkName, Context context)

Gets all private endpoint connections for a private link. Returns the list of private endpoints that are connected or in the process of connecting to this private link.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
privateLinkName - The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.
context - The context to associate with this operation.

Returns:

all private endpoint connections for a private link as paginated response with PagedIterable<T>.

Applies to