Package version:

Interface LinkConnectionOperations

Interface representing a LinkConnectionOperations.

Hierarchy

LinkConnectionOperations

Index

Methods

createOrUpdate delete editTables get getDetailedStatus listByWorkspace listLinkTables pause queryTableStatus resume start stop updateLandingZoneCredential

Methods

createOrUpdate

createOrUpdate(linkConnectionName: string, linkConnection: LinkConnectionResource, options?: LinkConnectionCreateOrUpdateOptionalParams): Promise<LinkConnectionResource>
Creates or updates a link connection
Parameters
- linkConnectionName: string
  
  The link connection name
- linkConnection: LinkConnectionResource
  
  Link connection resource definition
- Optional options: LinkConnectionCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<LinkConnectionResource>
- Defined in operationsInterfaces/linkConnectionOperations.ts:51

delete

delete(linkConnectionName: string, options?: LinkConnectionDeleteOptionalParams): Promise<void>
Delete a link connection
Parameters
- linkConnectionName: string
  
  The link connection name
- Optional options: LinkConnectionDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/linkConnectionOperations.ts:70

editTables

editTables(linkConnectionName: string, editTablesRequest: EditTablesRequest, options?: LinkConnectionEditTablesOptionalParams): Promise<void>
Edit tables for a link connection
Parameters
- linkConnectionName: string
  
  The link connection name
- editTablesRequest: EditTablesRequest
  
  Edit tables request
- Optional options: LinkConnectionEditTablesOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/linkConnectionOperations.ts:80

get

get(linkConnectionName: string, options?: LinkConnectionGetOptionalParams): Promise<LinkConnectionResource>
Get a link connection
Parameters
- linkConnectionName: string
  
  The link connection name
- Optional options: LinkConnectionGetOptionalParams
  
  The options parameters.
Returns Promise<LinkConnectionResource>
- Defined in operationsInterfaces/linkConnectionOperations.ts:61

getDetailedStatus

getDetailedStatus(linkConnectionName: string, options?: LinkConnectionGetDetailedStatusOptionalParams): Promise<LinkConnectionDetailedStatus>
Get the detailed status of a link connection
Parameters
- linkConnectionName: string
  
  The link connection name
- Optional options: LinkConnectionGetDetailedStatusOptionalParams
  
  The options parameters.
Returns Promise<LinkConnectionDetailedStatus>
- Defined in operationsInterfaces/linkConnectionOperations.ts:110

listByWorkspace

listByWorkspace(options?: LinkConnectionListByWorkspaceOptionalParams): PagedAsyncIterableIterator<LinkConnectionResource>
List link connections
Parameters
- Optional options: LinkConnectionListByWorkspaceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<LinkConnectionResource>
- Defined in operationsInterfaces/linkConnectionOperations.ts:42

listLinkTables

listLinkTables(linkConnectionName: string, options?: LinkConnectionListLinkTablesOptionalParams): Promise<LinkTableListResponse>
List the link tables of a link connection
Parameters
- linkConnectionName: string
  
  The link connection name
- Optional options: LinkConnectionListLinkTablesOptionalParams
  
  The options parameters.
Returns Promise<LinkTableListResponse>
- Defined in operationsInterfaces/linkConnectionOperations.ts:119

pause

pause(linkConnectionName: string, options?: LinkConnectionPauseOptionalParams): Promise<void>
Pause a link connection. It may take a few minutes from Pausing to Paused, monitor the status with LinkConnection_GetDetailedStatus.
Parameters
- linkConnectionName: string
  
  The link connection name
- Optional options: LinkConnectionPauseOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/linkConnectionOperations.ts:151

queryTableStatus

queryTableStatus(linkConnectionName: string, queryTableStatusRequest: QueryTableStatusRequest, options?: LinkConnectionQueryTableStatusOptionalParams): Promise<LinkConnectionQueryTableStatus>
Query the link table status of a link connection
Parameters
- linkConnectionName: string
  
  The link connection name
- queryTableStatusRequest: QueryTableStatusRequest
  
  Query table status request
- Optional options: LinkConnectionQueryTableStatusOptionalParams
  
  The options parameters.
Returns Promise<LinkConnectionQueryTableStatus>
- Defined in operationsInterfaces/linkConnectionOperations.ts:129

resume

resume(linkConnectionName: string, options?: LinkConnectionResumeOptionalParams): Promise<void>
Resume a link connection. It may take a few minutes from Resuming to Running, monitor the status with LinkConnection_GetDetailedStatus.
Parameters
- linkConnectionName: string
  
  The link connection name
- Optional options: LinkConnectionResumeOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/linkConnectionOperations.ts:161

start

start(linkConnectionName: string, options?: LinkConnectionStartOptionalParams): Promise<void>
Start a link connection. It may take a few minutes from Starting to Running, monitor the status with LinkConnection_GetDetailedStatus.
Parameters
- linkConnectionName: string
  
  The link connection name
- Optional options: LinkConnectionStartOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/linkConnectionOperations.ts:91

stop

stop(linkConnectionName: string, options?: LinkConnectionStopOptionalParams): Promise<void>
Stop a link connection. It may take a few minutes from Stopping to stopped, monitor the status with LinkConnection_GetDetailedStatus.
Parameters
- linkConnectionName: string
  
  The link connection name
- Optional options: LinkConnectionStopOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/linkConnectionOperations.ts:101

updateLandingZoneCredential

updateLandingZoneCredential(linkConnectionName: string, updateLandingZoneCredentialRequest: UpdateLandingZoneCredential, options?: LinkConnectionUpdateLandingZoneCredentialOptionalParams): Promise<void>
Update landing zone credential of a link connection
Parameters
- linkConnectionName: string
  
  The link connection name
- updateLandingZoneCredentialRequest: UpdateLandingZoneCredential
  
  update landing zone credential request
- Optional options: LinkConnectionUpdateLandingZoneCredentialOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/linkConnectionOperations.ts:140

Interface LinkConnectionOperations

Hierarchy

Index

Methods

Methods

createOrUpdate

Parameters

linkConnectionName: string

linkConnection: LinkConnectionResource

Optional options: LinkConnectionCreateOrUpdateOptionalParams

Returns Promise<LinkConnectionResource>

delete

Parameters

linkConnectionName: string

Optional options: LinkConnectionDeleteOptionalParams

Returns Promise<void>

editTables

Parameters

linkConnectionName: string

editTablesRequest: EditTablesRequest

Optional options: LinkConnectionEditTablesOptionalParams

Returns Promise<void>

get

Parameters

linkConnectionName: string

Optional options: LinkConnectionGetOptionalParams

Returns Promise<LinkConnectionResource>

getDetailedStatus

Parameters

linkConnectionName: string

Optional options: LinkConnectionGetDetailedStatusOptionalParams

Returns Promise<LinkConnectionDetailedStatus>

listByWorkspace

Parameters

Optional options: LinkConnectionListByWorkspaceOptionalParams

Returns PagedAsyncIterableIterator<LinkConnectionResource>

listLinkTables

Parameters

linkConnectionName: string

Optional options: LinkConnectionListLinkTablesOptionalParams

Returns Promise<LinkTableListResponse>

pause

Parameters

linkConnectionName: string

Optional options: LinkConnectionPauseOptionalParams

Returns Promise<void>

queryTableStatus

Parameters

linkConnectionName: string

queryTableStatusRequest: QueryTableStatusRequest

Optional options: LinkConnectionQueryTableStatusOptionalParams

Returns Promise<LinkConnectionQueryTableStatus>

resume

Parameters

linkConnectionName: string

Optional options: LinkConnectionResumeOptionalParams

Returns Promise<void>

start

Parameters

linkConnectionName: string

Optional options: LinkConnectionStartOptionalParams

Returns Promise<void>

stop

Parameters

linkConnectionName: string

Optional options: LinkConnectionStopOptionalParams

Returns Promise<void>

updateLandingZoneCredential

Parameters

linkConnectionName: string

updateLandingZoneCredentialRequest: UpdateLandingZoneCredential

Optional options: LinkConnectionUpdateLandingZoneCredentialOptionalParams

Returns Promise<void>

Settings

Member Visibility

Theme

`Optional` options: LinkConnectionCreateOrUpdateOptionalParams

`Optional` options: LinkConnectionDeleteOptionalParams

`Optional` options: LinkConnectionEditTablesOptionalParams

`Optional` options: LinkConnectionGetOptionalParams

`Optional` options: LinkConnectionGetDetailedStatusOptionalParams

`Optional` options: LinkConnectionListByWorkspaceOptionalParams

`Optional` options: LinkConnectionListLinkTablesOptionalParams

`Optional` options: LinkConnectionPauseOptionalParams

`Optional` options: LinkConnectionQueryTableStatusOptionalParams

`Optional` options: LinkConnectionResumeOptionalParams

`Optional` options: LinkConnectionStartOptionalParams

`Optional` options: LinkConnectionStopOptionalParams

`Optional` options: LinkConnectionUpdateLandingZoneCredentialOptionalParams