LinkConnectionOperations interface

Package:

@azure/synapse-artifacts

Interface representing a LinkConnectionOperations.

Methods

createOrUpdate(string, LinkConnectionResource, LinkConnectionCreateOrUpdateOptionalParams)	Creates or updates a link connection
delete(string, LinkConnectionDeleteOptionalParams)	Delete a link connection
editTables(string, EditTablesRequest, LinkConnectionEditTablesOptionalParams)	Edit tables for a link connection
get(string, LinkConnectionGetOptionalParams)	Get a link connection
getDetailedStatus(string, LinkConnectionGetDetailedStatusOptionalParams)	Get the detailed status of a link connection
listByWorkspace(LinkConnectionListByWorkspaceOptionalParams)	List link connections
listLinkTables(string, LinkConnectionListLinkTablesOptionalParams)	List the link tables of a link connection
pause(string, LinkConnectionPauseOptionalParams)	Pause a link connection. It may take a few minutes from Pausing to Paused, monitor the status with LinkConnection_GetDetailedStatus.
queryTableStatus(string, QueryTableStatusRequest, LinkConnectionQueryTableStatusOptionalParams)	Query the link table status of a link connection
resume(string, LinkConnectionResumeOptionalParams)	Resume a link connection. It may take a few minutes from Resuming to Running, monitor the status with LinkConnection_GetDetailedStatus.
start(string, LinkConnectionStartOptionalParams)	Start a link connection. It may take a few minutes from Starting to Running, monitor the status with LinkConnection_GetDetailedStatus.
stop(string, LinkConnectionStopOptionalParams)	Stop a link connection. It may take a few minutes from Stopping to stopped, monitor the status with LinkConnection_GetDetailedStatus.
updateLandingZoneCredential(string, UpdateLandingZoneCredential, LinkConnectionUpdateLandingZoneCredentialOptionalParams)	Update landing zone credential of a link connection

Method Details

createOrUpdate(string, LinkConnectionResource, LinkConnectionCreateOrUpdateOptionalParams)

Creates or updates a link connection

function createOrUpdate(linkConnectionName: string, linkConnection: LinkConnectionResource, options?: LinkConnectionCreateOrUpdateOptionalParams): Promise<LinkConnectionResource>

Parameters

linkConnectionName

string

The link connection name

linkConnection

LinkConnectionResource

Link connection resource definition

options

LinkConnectionCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<LinkConnectionResource>

delete(string, LinkConnectionDeleteOptionalParams)

Delete a link connection

function delete(linkConnectionName: string, options?: LinkConnectionDeleteOptionalParams): Promise<void>

Parameters

linkConnectionName

string

The link connection name

options

LinkConnectionDeleteOptionalParams

The options parameters.

Returns

Promise<void>

editTables(string, EditTablesRequest, LinkConnectionEditTablesOptionalParams)

Edit tables for a link connection

function editTables(linkConnectionName: string, editTablesRequest: EditTablesRequest, options?: LinkConnectionEditTablesOptionalParams): Promise<void>

Parameters

linkConnectionName

string

The link connection name

editTablesRequest

EditTablesRequest

Edit tables request

options

LinkConnectionEditTablesOptionalParams

The options parameters.

Returns

Promise<void>

get(string, LinkConnectionGetOptionalParams)

Get a link connection

function get(linkConnectionName: string, options?: LinkConnectionGetOptionalParams): Promise<LinkConnectionResource>

Parameters

linkConnectionName

string

The link connection name

options

LinkConnectionGetOptionalParams

The options parameters.

Returns

Promise<LinkConnectionResource>

getDetailedStatus(string, LinkConnectionGetDetailedStatusOptionalParams)

Get the detailed status of a link connection

function getDetailedStatus(linkConnectionName: string, options?: LinkConnectionGetDetailedStatusOptionalParams): Promise<LinkConnectionDetailedStatus>

Parameters

linkConnectionName

string

The link connection name

options

LinkConnectionGetDetailedStatusOptionalParams

The options parameters.

Returns

Promise<LinkConnectionDetailedStatus>

listByWorkspace(LinkConnectionListByWorkspaceOptionalParams)

List link connections

function listByWorkspace(options?: LinkConnectionListByWorkspaceOptionalParams): PagedAsyncIterableIterator<LinkConnectionResource, LinkConnectionResource[], PageSettings>

Parameters

options

LinkConnectionListByWorkspaceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<LinkConnectionResource, LinkConnectionResource[], PageSettings>

listLinkTables(string, LinkConnectionListLinkTablesOptionalParams)

List the link tables of a link connection

function listLinkTables(linkConnectionName: string, options?: LinkConnectionListLinkTablesOptionalParams): Promise<LinkTableListResponse>

Parameters

linkConnectionName

string

The link connection name

options

LinkConnectionListLinkTablesOptionalParams

The options parameters.

Returns

Promise<LinkTableListResponse>

pause(string, LinkConnectionPauseOptionalParams)

Pause a link connection. It may take a few minutes from Pausing to Paused, monitor the status with LinkConnection_GetDetailedStatus.

function pause(linkConnectionName: string, options?: LinkConnectionPauseOptionalParams): Promise<void>

Parameters

linkConnectionName

string

The link connection name

options

LinkConnectionPauseOptionalParams

The options parameters.

Returns

Promise<void>

queryTableStatus(string, QueryTableStatusRequest, LinkConnectionQueryTableStatusOptionalParams)

Query the link table status of a link connection

function queryTableStatus(linkConnectionName: string, queryTableStatusRequest: QueryTableStatusRequest, options?: LinkConnectionQueryTableStatusOptionalParams): Promise<LinkConnectionQueryTableStatus>

Parameters

linkConnectionName

string

The link connection name

queryTableStatusRequest

QueryTableStatusRequest

Query table status request

options

LinkConnectionQueryTableStatusOptionalParams

The options parameters.

Returns

Promise<LinkConnectionQueryTableStatus>

resume(string, LinkConnectionResumeOptionalParams)

Resume a link connection. It may take a few minutes from Resuming to Running, monitor the status with LinkConnection_GetDetailedStatus.

function resume(linkConnectionName: string, options?: LinkConnectionResumeOptionalParams): Promise<void>

Parameters

linkConnectionName

string

The link connection name

options

LinkConnectionResumeOptionalParams

The options parameters.

Returns

Promise<void>

start(string, LinkConnectionStartOptionalParams)

Start a link connection. It may take a few minutes from Starting to Running, monitor the status with LinkConnection_GetDetailedStatus.

function start(linkConnectionName: string, options?: LinkConnectionStartOptionalParams): Promise<void>

Parameters

linkConnectionName

string

The link connection name

options

LinkConnectionStartOptionalParams

The options parameters.

Returns

Promise<void>

stop(string, LinkConnectionStopOptionalParams)

Stop a link connection. It may take a few minutes from Stopping to stopped, monitor the status with LinkConnection_GetDetailedStatus.

function stop(linkConnectionName: string, options?: LinkConnectionStopOptionalParams): Promise<void>

Parameters

linkConnectionName

string

The link connection name

options

LinkConnectionStopOptionalParams

The options parameters.

Returns

Promise<void>

updateLandingZoneCredential(string, UpdateLandingZoneCredential, LinkConnectionUpdateLandingZoneCredentialOptionalParams)

Update landing zone credential of a link connection

function updateLandingZoneCredential(linkConnectionName: string, updateLandingZoneCredentialRequest: UpdateLandingZoneCredential, options?: LinkConnectionUpdateLandingZoneCredentialOptionalParams): Promise<void>

Parameters

linkConnectionName

string

The link connection name

updateLandingZoneCredentialRequest

UpdateLandingZoneCredential

update landing zone credential request

options

LinkConnectionUpdateLandingZoneCredentialOptionalParams

The options parameters.

Returns

Promise<void>