PrivateEndpointConnections interface

Package:

@azure/arm-containerservice

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.
get(string, string, string, PrivateEndpointConnectionsGetOptionalParams)	To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters
list(string, string, PrivateEndpointConnectionsListOptionalParams)	To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters
update(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsUpdateOptionalParams)	Updates a private endpoint connection.

Method Details

beginDelete(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Deletes a private endpoint connection.

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

Parameters

resourceGroupName

string

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

resourceName

string

The name of the managed cluster resource.

privateEndpointConnectionName

string

The name of the private endpoint connection.

options

PrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Deletes a private endpoint connection.

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

Parameters

resourceGroupName

string

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

resourceName

string

The name of the managed cluster resource.

privateEndpointConnectionName

string

The name of the private endpoint connection.

options

PrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, PrivateEndpointConnectionsGetOptionalParams)

To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters

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

Parameters

resourceGroupName

string

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

resourceName

string

The name of the managed cluster resource.

privateEndpointConnectionName

string

The name of the private endpoint connection.

options

PrivateEndpointConnectionsGetOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnection>

list(string, string, PrivateEndpointConnectionsListOptionalParams)

To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters

function list(resourceGroupName: string, resourceName: string, options?: PrivateEndpointConnectionsListOptionalParams): Promise<PrivateEndpointConnectionListResult>

Parameters

resourceGroupName

string

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

resourceName

string

The name of the managed cluster resource.

options

PrivateEndpointConnectionsListOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnectionListResult>

update(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsUpdateOptionalParams)

Updates a private endpoint connection.

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

Parameters

resourceGroupName

string

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

resourceName

string

The name of the managed cluster resource.

privateEndpointConnectionName

string

The name of the private endpoint connection.

parameters

PrivateEndpointConnection

The updated private endpoint connection.

options

PrivateEndpointConnectionsUpdateOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnection>