PrivateEndpointConnections interface

Package:

@azure/arm-sql

Interface representing a PrivateEndpointConnections.

Methods

beginCreateOrUpdate(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsCreateOrUpdateOptionalParams)	Approve or reject a private endpoint connection with a given name.
beginCreateOrUpdateAndWait(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsCreateOrUpdateOptionalParams)	Approve or reject a private endpoint connection with a given name.
beginDelete(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)	Deletes a private endpoint connection with a given name.
beginDeleteAndWait(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)	Deletes a private endpoint connection with a given name.
get(string, string, string, PrivateEndpointConnectionsGetOptionalParams)	Gets a private endpoint connection.
listByServer(string, string, PrivateEndpointConnectionsListByServerOptionalParams)	Gets all private endpoint connections on a server.

Method Details

beginCreateOrUpdate(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsCreateOrUpdateOptionalParams)

Approve or reject a private endpoint connection with a given name.

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

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

privateEndpointConnectionName

string

parameters

PrivateEndpointConnection

A private endpoint connection

options

PrivateEndpointConnectionsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>

beginCreateOrUpdateAndWait(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsCreateOrUpdateOptionalParams)

Approve or reject a private endpoint connection with a given name.

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

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

privateEndpointConnectionName

string

parameters

PrivateEndpointConnection

A private endpoint connection

options

PrivateEndpointConnectionsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnection>

beginDelete(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Deletes a private endpoint connection with a given name.

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

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

privateEndpointConnectionName

string

options

PrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Deletes a private endpoint connection with a given name.

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

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

privateEndpointConnectionName

string

options

PrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

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 that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

privateEndpointConnectionName

string

The name of the private endpoint connection.

options

PrivateEndpointConnectionsGetOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnection>

listByServer(string, string, PrivateEndpointConnectionsListByServerOptionalParams)

Gets 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 that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

options

PrivateEndpointConnectionsListByServerOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>