PrivateEndpointConnections interface

Interface representing a PrivateEndpointConnections.

Methods

beginCreate(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsCreateOptionalParams)

Update the status of a private endpoint connection with the specified name

beginCreateAndWait(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsCreateOptionalParams)

Update the status of a private endpoint connection with the specified name

beginDelete(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Remove private endpoint connection with the specified name

beginDeleteAndWait(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Remove private endpoint connection with the specified name

get(string, string, string, PrivateEndpointConnectionsGetOptionalParams)

Get a private endpoint connection properties for a workspace

list(string, string, PrivateEndpointConnectionsListOptionalParams)

List private endpoint connections of the workspace

Method Details

beginCreate(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsCreateOptionalParams)

Update the status of a private endpoint connection with the specified name

function beginCreate(resourceGroupName: string, workspaceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOptionalParams): Promise<SimplePollerLike<OperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

privateEndpointConnectionName

string

The name of the private endpoint connection

privateEndpointConnection
PrivateEndpointConnection

The private endpoint connection with updated properties

options
PrivateEndpointConnectionsCreateOptionalParams

The options parameters.

Returns

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

beginCreateAndWait(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsCreateOptionalParams)

Update the status of a private endpoint connection with the specified name

function beginCreateAndWait(resourceGroupName: string, workspaceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOptionalParams): Promise<PrivateEndpointConnection>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

privateEndpointConnectionName

string

The name of the private endpoint connection

privateEndpointConnection
PrivateEndpointConnection

The private endpoint connection with updated properties

options
PrivateEndpointConnectionsCreateOptionalParams

The options parameters.

Returns

beginDelete(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Remove private endpoint connection with the specified name

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

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

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)

Remove private endpoint connection with the specified name

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

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

privateEndpointConnectionName

string

The name of the private endpoint connection

options
PrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, PrivateEndpointConnectionsGetOptionalParams)

Get a private endpoint connection properties for a workspace

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

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

privateEndpointConnectionName

string

The name of the private endpoint connection

options
PrivateEndpointConnectionsGetOptionalParams

The options parameters.

Returns

list(string, string, PrivateEndpointConnectionsListOptionalParams)

List private endpoint connections of the workspace

function list(resourceGroupName: string, workspaceName: string, options?: PrivateEndpointConnectionsListOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

options
PrivateEndpointConnectionsListOptionalParams

The options parameters.

Returns