PrivateEndpointConnections interface

Interface representing a PrivateEndpointConnections.

Methods

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

Approves or Rejects a private endpoint connection with a given name.

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

Approves or Rejects 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 private endpoint connection.

listByCluster(string, string, PrivateEndpointConnectionsListByClusterOptionalParams)

Gets list of private endpoint connections on a cluster.

Method Details

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

Approves or Rejects a private endpoint connection with a given name.

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

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

privateEndpointConnectionName

string

The name of the private endpoint connection associated with the cluster.

parameters
PrivateEndpointConnection

The required parameters for approving a private endpoint connection.

Returns

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

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

Approves or Rejects a private endpoint connection with a given name.

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

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

privateEndpointConnectionName

string

The name of the private endpoint connection associated with the cluster.

parameters
PrivateEndpointConnection

The required parameters for approving a private endpoint connection.

Returns

beginDelete(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Deletes a private endpoint connection with a given name.

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

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

privateEndpointConnectionName

string

The name of the private endpoint connection associated with the cluster.

options
PrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

beginDeleteAndWait(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Deletes a private endpoint connection with a given name.

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

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

privateEndpointConnectionName

string

The name of the private endpoint connection associated with the cluster.

options
PrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

get(string, string, string, PrivateEndpointConnectionsGetOptionalParams)

Gets private endpoint connection.

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

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

privateEndpointConnectionName

string

The name of the private endpoint connection associated with the cluster.

options
PrivateEndpointConnectionsGetOptionalParams

The options parameters.

Returns

listByCluster(string, string, PrivateEndpointConnectionsListByClusterOptionalParams)

Gets list of private endpoint connections on a cluster.

function listByCluster(resourceGroupName: string, clusterName: string, options?: PrivateEndpointConnectionsListByClusterOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

Returns