PrivateEndpointConnections interface

Package:

@azure/arm-synapse

Interface representing a PrivateEndpointConnections.

Methods

beginCreate(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsCreateOptionalParams)	Approve or reject a private endpoint connection.
beginCreateAndWait(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsCreateOptionalParams)	Approve or reject a private endpoint connection.
beginDelete(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)	Delete a private endpoint connection.
beginDeleteAndWait(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)	Delete a private endpoint connection.
get(string, string, string, PrivateEndpointConnectionsGetOptionalParams)	Gets a private endpoint connection.
list(string, string, PrivateEndpointConnectionsListOptionalParams)	Lists private endpoint connection in workspace.

Method Details

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

Approve or reject a private endpoint connection.

function beginCreate(resourceGroupName: string, workspaceName: string, privateEndpointConnectionName: string, request: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOptionalParams): Promise<PollerLike<PollOperationState<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.

request

PrivateEndpointConnection

Request body of private endpoint connection to create.

options

PrivateEndpointConnectionsCreateOptionalParams

The options parameters.

Returns

Promise<PollerLike<PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>

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

Approve or reject a private endpoint connection.

function beginCreateAndWait(resourceGroupName: string, workspaceName: string, privateEndpointConnectionName: string, request: 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.

request

PrivateEndpointConnection

Request body of private endpoint connection to create.

options

PrivateEndpointConnectionsCreateOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnection>

beginDelete(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Delete a private endpoint connection.

function beginDelete(resourceGroupName: string, workspaceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<PollerLike<PollOperationState<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<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Delete a private endpoint connection.

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)

Gets a private endpoint connection.

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

Promise<PrivateEndpointConnection>

list(string, string, PrivateEndpointConnectionsListOptionalParams)

Lists private endpoint connection in 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

PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>