PrivateEndpointConnections interface

Reference

Package:: @azure/arm-keyvault

Interface representing a PrivateEndpointConnections.

Methods

beginDelete(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)	Deletes the specified private endpoint connection associated with the key vault.
beginDeleteAndWait(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)	Deletes the specified private endpoint connection associated with the key vault.
get(string, string, string, PrivateEndpointConnectionsGetOptionalParams)	Gets the specified private endpoint connection associated with the key vault.
listByResource(string, string, PrivateEndpointConnectionsListByResourceOptionalParams)	The List operation gets information about the private endpoint connections associated with the vault.
put(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsPutOptionalParams)	Updates the specified private endpoint connection associated with the key vault.

Method Details

beginDelete(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Deletes the specified private endpoint connection associated with the key vault.

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

Parameters

resourceGroupName: string

Name of the resource group that contains the key vault.

vaultName: string

The name of the key vault.

privateEndpointConnectionName: string

Name of the private endpoint connection associated with the key vault.

options: PrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<PollOperationState<PrivateEndpointConnectionsDeleteResponse>, PrivateEndpointConnectionsDeleteResponse>>

beginDeleteAndWait(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Deletes the specified private endpoint connection associated with the key vault.

function beginDeleteAndWait(resourceGroupName: string, vaultName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<PrivateEndpointConnectionsDeleteResponse>

Parameters

resourceGroupName: string

Name of the resource group that contains the key vault.

vaultName: string

The name of the key vault.

privateEndpointConnectionName: string

Name of the private endpoint connection associated with the key vault.

options: PrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnectionsDeleteResponse>

get(string, string, string, PrivateEndpointConnectionsGetOptionalParams)

Gets the specified private endpoint connection associated with the key vault.

function get(resourceGroupName: string, vaultName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetOptionalParams): Promise<PrivateEndpointConnectionsGetResponse>

Parameters

resourceGroupName: string

Name of the resource group that contains the key vault.

vaultName: string

The name of the key vault.

privateEndpointConnectionName: string

Name of the private endpoint connection associated with the key vault.

options: PrivateEndpointConnectionsGetOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnectionsGetResponse>

listByResource(string, string, PrivateEndpointConnectionsListByResourceOptionalParams)

The List operation gets information about the private endpoint connections associated with the vault.

function listByResource(resourceGroupName: string, vaultName: string, options?: PrivateEndpointConnectionsListByResourceOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnection>

Parameters

resourceGroupName: string

Name of the resource group that contains the key vault.

vaultName: string

The name of the key vault.

options: PrivateEndpointConnectionsListByResourceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PrivateEndpointConnection>

put(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsPutOptionalParams)

Updates the specified private endpoint connection associated with the key vault.

function put(resourceGroupName: string, vaultName: string, privateEndpointConnectionName: string, properties: PrivateEndpointConnection, options?: PrivateEndpointConnectionsPutOptionalParams): Promise<PrivateEndpointConnectionsPutResponse>

Parameters

resourceGroupName: string

Name of the resource group that contains the key vault.

vaultName: string

The name of the key vault.

privateEndpointConnectionName: string

Name of the private endpoint connection associated with the key vault.

properties: PrivateEndpointConnection

The intended state of private endpoint connection.

options: PrivateEndpointConnectionsPutOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnectionsPutResponse>