Share via


PrivateEndpointConnections interface

Interface representing a PrivateEndpointConnections.

Methods

beginDelete(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Deletes a private endpoint connection.

beginDeleteAndWait(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Deletes a private endpoint connection.

beginUpdate(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsUpdateOptionalParams)

Approves or rejects a private endpoint connection.

beginUpdateAndWait(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsUpdateOptionalParams)

Approves or rejects a private endpoint connection.

get(string, string, string, PrivateEndpointConnectionsGetOptionalParams)

Gets a private endpoint connection.

listByServer(string, string, PrivateEndpointConnectionsListByServerOptionalParams)

Lists all private endpoint connections on a server.

Method Details

beginDelete(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Deletes a private endpoint connection.

function beginDelete(resourceGroupName: string, serverName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<PrivateEndpointConnectionsDeleteHeaders>, PrivateEndpointConnectionsDeleteHeaders>>

Parameters

resourceGroupName

string

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

serverName

string

The name of the server.

privateEndpointConnectionName

string

The name of the private endpoint connection.

options
PrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

beginDeleteAndWait(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Deletes a private endpoint connection.

function beginDeleteAndWait(resourceGroupName: string, serverName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<PrivateEndpointConnectionsDeleteHeaders>

Parameters

resourceGroupName

string

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

serverName

string

The name of the server.

privateEndpointConnectionName

string

The name of the private endpoint connection.

options
PrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

beginUpdate(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsUpdateOptionalParams)

Approves or rejects a private endpoint connection.

function beginUpdate(resourceGroupName: string, serverName: string, privateEndpointConnectionName: string, parameters: PrivateEndpointConnection, options?: PrivateEndpointConnectionsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>

Parameters

resourceGroupName

string

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

serverName

string

The name of the server.

privateEndpointConnectionName

string

The name of the private endpoint connection.

parameters
PrivateEndpointConnection

Parameters required to update a private endpoint connection.

options
PrivateEndpointConnectionsUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>

beginUpdateAndWait(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsUpdateOptionalParams)

Approves or rejects a private endpoint connection.

function beginUpdateAndWait(resourceGroupName: string, serverName: string, privateEndpointConnectionName: string, parameters: PrivateEndpointConnection, options?: PrivateEndpointConnectionsUpdateOptionalParams): Promise<PrivateEndpointConnection>

Parameters

resourceGroupName

string

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

serverName

string

The name of the server.

privateEndpointConnectionName

string

The name of the private endpoint connection.

parameters
PrivateEndpointConnection

Parameters required to update a private endpoint connection.

options
PrivateEndpointConnectionsUpdateOptionalParams

The options parameters.

Returns

get(string, string, string, PrivateEndpointConnectionsGetOptionalParams)

Gets a private endpoint connection.

function get(resourceGroupName: string, serverName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetOptionalParams): Promise<PrivateEndpointConnection>

Parameters

resourceGroupName

string

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

serverName

string

The name of the server.

privateEndpointConnectionName

string

The name of the private endpoint connection.

options
PrivateEndpointConnectionsGetOptionalParams

The options parameters.

Returns

listByServer(string, string, PrivateEndpointConnectionsListByServerOptionalParams)

Lists all private endpoint connections on a server.

function listByServer(resourceGroupName: string, serverName: string, options?: PrivateEndpointConnectionsListByServerOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>

Parameters

resourceGroupName

string

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

serverName

string

The name of the server.

Returns