PrivateEndpointConnections interface

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.

listByPrivateLinkScope(string, string, PrivateEndpointConnectionsListByPrivateLinkScopeOptionalParams)

Gets all private endpoint connections on a private link scope.

Method Details

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

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

function beginCreateOrUpdate(resourceGroupName: string, scopeName: string, privateEndpointConnectionName: string, parameters: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>

Parameters

resourceGroupName

string

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

scopeName

string

The name of the Azure Arc PrivateLinkScope resource.

privateEndpointConnectionName

string

The name of the private endpoint connection.

parameters
PrivateEndpointConnection

A private endpoint connection

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>

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

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

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

Parameters

resourceGroupName

string

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

scopeName

string

The name of the Azure Arc PrivateLinkScope resource.

privateEndpointConnectionName

string

The name of the private endpoint connection.

parameters
PrivateEndpointConnection

A private endpoint connection

Returns

beginDelete(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Deletes a private endpoint connection with a given name.

function beginDelete(resourceGroupName: string, scopeName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

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

scopeName

string

The name of the Azure Arc PrivateLinkScope resource.

privateEndpointConnectionName

string

The name of the private endpoint connection.

options
PrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Deletes a private endpoint connection with a given name.

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

Parameters

resourceGroupName

string

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

scopeName

string

The name of the Azure Arc PrivateLinkScope resource.

privateEndpointConnectionName

string

The name of the private endpoint connection.

options
PrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, PrivateEndpointConnectionsGetOptionalParams)

Gets a private endpoint connection.

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

Parameters

resourceGroupName

string

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

scopeName

string

The name of the Azure Arc PrivateLinkScope resource.

privateEndpointConnectionName

string

The name of the private endpoint connection.

options
PrivateEndpointConnectionsGetOptionalParams

The options parameters.

Returns

listByPrivateLinkScope(string, string, PrivateEndpointConnectionsListByPrivateLinkScopeOptionalParams)

Gets all private endpoint connections on a private link scope.

function listByPrivateLinkScope(resourceGroupName: string, scopeName: string, options?: PrivateEndpointConnectionsListByPrivateLinkScopeOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>

Parameters

resourceGroupName

string

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

scopeName

string

The name of the Azure Arc PrivateLinkScope resource.

Returns