DataFlowOperations interface

Package:

@azure/synapse-artifacts

Interface representing a DataFlowOperations.

Methods

beginCreateOrUpdateDataFlow(string, DataFlowResource, DataFlowCreateOrUpdateDataFlowOptionalParams)	Creates or updates a data flow.
beginCreateOrUpdateDataFlowAndWait(string, DataFlowResource, DataFlowCreateOrUpdateDataFlowOptionalParams)	Creates or updates a data flow.
beginDeleteDataFlow(string, DataFlowDeleteDataFlowOptionalParams)	Deletes a data flow.
beginDeleteDataFlowAndWait(string, DataFlowDeleteDataFlowOptionalParams)	Deletes a data flow.
beginRenameDataFlow(string, ArtifactRenameRequest, DataFlowRenameDataFlowOptionalParams)	Renames a dataflow.
beginRenameDataFlowAndWait(string, ArtifactRenameRequest, DataFlowRenameDataFlowOptionalParams)	Renames a dataflow.
getDataFlow(string, DataFlowGetDataFlowOptionalParams)	Gets a data flow.
listDataFlowsByWorkspace(DataFlowGetDataFlowsByWorkspaceOptionalParams)	Lists data flows.

Method Details

beginCreateOrUpdateDataFlow(string, DataFlowResource, DataFlowCreateOrUpdateDataFlowOptionalParams)

Creates or updates a data flow.

function beginCreateOrUpdateDataFlow(dataFlowName: string, dataFlow: DataFlowResource, options?: DataFlowCreateOrUpdateDataFlowOptionalParams): Promise<SimplePollerLike<OperationState<DataFlowResource>, DataFlowResource>>

Parameters

dataFlowName

string

The data flow name.

dataFlow

DataFlowResource

Data flow resource definition.

options

DataFlowCreateOrUpdateDataFlowOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateDataFlowAndWait(string, DataFlowResource, DataFlowCreateOrUpdateDataFlowOptionalParams)

Creates or updates a data flow.

function beginCreateOrUpdateDataFlowAndWait(dataFlowName: string, dataFlow: DataFlowResource, options?: DataFlowCreateOrUpdateDataFlowOptionalParams): Promise<DataFlowResource>

Parameters

dataFlowName

string

The data flow name.

dataFlow

DataFlowResource

Data flow resource definition.

options

DataFlowCreateOrUpdateDataFlowOptionalParams

The options parameters.

Returns

Promise<DataFlowResource>

beginDeleteDataFlow(string, DataFlowDeleteDataFlowOptionalParams)

Deletes a data flow.

function beginDeleteDataFlow(dataFlowName: string, options?: DataFlowDeleteDataFlowOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

dataFlowName

string

The data flow name.

options

DataFlowDeleteDataFlowOptionalParams

The options parameters.

Returns

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

beginDeleteDataFlowAndWait(string, DataFlowDeleteDataFlowOptionalParams)

Deletes a data flow.

function beginDeleteDataFlowAndWait(dataFlowName: string, options?: DataFlowDeleteDataFlowOptionalParams): Promise<void>

Parameters

dataFlowName

string

The data flow name.

options

DataFlowDeleteDataFlowOptionalParams

The options parameters.

Returns

Promise<void>

beginRenameDataFlow(string, ArtifactRenameRequest, DataFlowRenameDataFlowOptionalParams)

Renames a dataflow.

function beginRenameDataFlow(dataFlowName: string, request: ArtifactRenameRequest, options?: DataFlowRenameDataFlowOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

dataFlowName

string

The data flow name.

request

ArtifactRenameRequest

proposed new name.

options

DataFlowRenameDataFlowOptionalParams

The options parameters.

Returns

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

beginRenameDataFlowAndWait(string, ArtifactRenameRequest, DataFlowRenameDataFlowOptionalParams)

Renames a dataflow.

function beginRenameDataFlowAndWait(dataFlowName: string, request: ArtifactRenameRequest, options?: DataFlowRenameDataFlowOptionalParams): Promise<void>

Parameters

dataFlowName

string

The data flow name.

request

ArtifactRenameRequest

proposed new name.

options

DataFlowRenameDataFlowOptionalParams

The options parameters.

Returns

Promise<void>

getDataFlow(string, DataFlowGetDataFlowOptionalParams)

Gets a data flow.

function getDataFlow(dataFlowName: string, options?: DataFlowGetDataFlowOptionalParams): Promise<DataFlowResource>

Parameters

dataFlowName

string

The data flow name.

options

DataFlowGetDataFlowOptionalParams

The options parameters.

Returns

Promise<DataFlowResource>

listDataFlowsByWorkspace(DataFlowGetDataFlowsByWorkspaceOptionalParams)

Lists data flows.

function listDataFlowsByWorkspace(options?: DataFlowGetDataFlowsByWorkspaceOptionalParams): PagedAsyncIterableIterator<DataFlowResource, DataFlowResource[], PageSettings>

Parameters

options

DataFlowGetDataFlowsByWorkspaceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DataFlowResource, DataFlowResource[], PageSettings>