LinkedServiceOperations interface

Package:

@azure/synapse-artifacts

Interface representing a LinkedServiceOperations.

Methods

beginCreateOrUpdateLinkedService(string, LinkedServiceResource, LinkedServiceCreateOrUpdateLinkedServiceOptionalParams)	Creates or updates a linked service.
beginCreateOrUpdateLinkedServiceAndWait(string, LinkedServiceResource, LinkedServiceCreateOrUpdateLinkedServiceOptionalParams)	Creates or updates a linked service.
beginDeleteLinkedService(string, LinkedServiceDeleteLinkedServiceOptionalParams)	Deletes a linked service.
beginDeleteLinkedServiceAndWait(string, LinkedServiceDeleteLinkedServiceOptionalParams)	Deletes a linked service.
beginRenameLinkedService(string, ArtifactRenameRequest, LinkedServiceRenameLinkedServiceOptionalParams)	Renames a linked service.
beginRenameLinkedServiceAndWait(string, ArtifactRenameRequest, LinkedServiceRenameLinkedServiceOptionalParams)	Renames a linked service.
getLinkedService(string, LinkedServiceGetLinkedServiceOptionalParams)	Gets a linked service.
listLinkedServicesByWorkspace(LinkedServiceGetLinkedServicesByWorkspaceOptionalParams)	Lists linked services.

Method Details

beginCreateOrUpdateLinkedService(string, LinkedServiceResource, LinkedServiceCreateOrUpdateLinkedServiceOptionalParams)

Creates or updates a linked service.

function beginCreateOrUpdateLinkedService(linkedServiceName: string, linkedService: LinkedServiceResource, options?: LinkedServiceCreateOrUpdateLinkedServiceOptionalParams): Promise<SimplePollerLike<OperationState<LinkedServiceResource>, LinkedServiceResource>>

Parameters

linkedServiceName

string

The linked service name.

linkedService

LinkedServiceResource

Linked service resource definition.

options

LinkedServiceCreateOrUpdateLinkedServiceOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateLinkedServiceAndWait(string, LinkedServiceResource, LinkedServiceCreateOrUpdateLinkedServiceOptionalParams)

Creates or updates a linked service.

function beginCreateOrUpdateLinkedServiceAndWait(linkedServiceName: string, linkedService: LinkedServiceResource, options?: LinkedServiceCreateOrUpdateLinkedServiceOptionalParams): Promise<LinkedServiceResource>

Parameters

linkedServiceName

string

The linked service name.

linkedService

LinkedServiceResource

Linked service resource definition.

options

LinkedServiceCreateOrUpdateLinkedServiceOptionalParams

The options parameters.

Returns

Promise<LinkedServiceResource>

beginDeleteLinkedService(string, LinkedServiceDeleteLinkedServiceOptionalParams)

Deletes a linked service.

function beginDeleteLinkedService(linkedServiceName: string, options?: LinkedServiceDeleteLinkedServiceOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

linkedServiceName

string

The linked service name.

options

LinkedServiceDeleteLinkedServiceOptionalParams

The options parameters.

Returns

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

beginDeleteLinkedServiceAndWait(string, LinkedServiceDeleteLinkedServiceOptionalParams)

Deletes a linked service.

function beginDeleteLinkedServiceAndWait(linkedServiceName: string, options?: LinkedServiceDeleteLinkedServiceOptionalParams): Promise<void>

Parameters

linkedServiceName

string

The linked service name.

options

LinkedServiceDeleteLinkedServiceOptionalParams

The options parameters.

Returns

Promise<void>

beginRenameLinkedService(string, ArtifactRenameRequest, LinkedServiceRenameLinkedServiceOptionalParams)

Renames a linked service.

function beginRenameLinkedService(linkedServiceName: string, request: ArtifactRenameRequest, options?: LinkedServiceRenameLinkedServiceOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

linkedServiceName

string

The linked service name.

request

ArtifactRenameRequest

proposed new name.

options

LinkedServiceRenameLinkedServiceOptionalParams

The options parameters.

Returns

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

beginRenameLinkedServiceAndWait(string, ArtifactRenameRequest, LinkedServiceRenameLinkedServiceOptionalParams)

Renames a linked service.

function beginRenameLinkedServiceAndWait(linkedServiceName: string, request: ArtifactRenameRequest, options?: LinkedServiceRenameLinkedServiceOptionalParams): Promise<void>

Parameters

linkedServiceName

string

The linked service name.

request

ArtifactRenameRequest

proposed new name.

options

LinkedServiceRenameLinkedServiceOptionalParams

The options parameters.

Returns

Promise<void>

getLinkedService(string, LinkedServiceGetLinkedServiceOptionalParams)

Gets a linked service.

function getLinkedService(linkedServiceName: string, options?: LinkedServiceGetLinkedServiceOptionalParams): Promise<LinkedServiceResource>

Parameters

linkedServiceName

string

The linked service name.

options

LinkedServiceGetLinkedServiceOptionalParams

The options parameters.

Returns

Promise<LinkedServiceResource>

listLinkedServicesByWorkspace(LinkedServiceGetLinkedServicesByWorkspaceOptionalParams)

Lists linked services.

function listLinkedServicesByWorkspace(options?: LinkedServiceGetLinkedServicesByWorkspaceOptionalParams): PagedAsyncIterableIterator<LinkedServiceResource, LinkedServiceResource[], PageSettings>

Parameters

options

LinkedServiceGetLinkedServicesByWorkspaceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<LinkedServiceResource, LinkedServiceResource[], PageSettings>