DataFlow | @azure/synapse-artifacts

Azure Synapse nested object which contains a flow with data movements and transformations. Interface representing a DataFlow.

Hierarchy

DataFlow

Index

Properties

Methods

Properties

Optional annotations

annotations: any[]

List of tags that can be used for describing the data flow.

Optional description

description: undefined | string

The description of the data flow.

Optional folder

folder: DataFlowFolder

The folder that this data flow is in. If not specified, Data flow will appear at the root level.

type

type: "MappingDataFlow"

Polymorphic discriminator, which specifies the different types this object can be

Methods

createOrUpdateDataFlow

createOrUpdateDataFlow(dataFlowName: string, dataFlow: DataFlowResource, options?: DataFlowCreateOrUpdateDataFlowOptionalParams): Promise<LROPoller<DataFlowCreateOrUpdateDataFlowResponse>>

- Defined in operationsInterfaces/dataFlow.ts:38
Creates or updates a data flow.

Parameters
- dataFlowName: string
  
  The data flow name.
- dataFlow: DataFlowResource
  
  Data flow resource definition.
- Optional options: DataFlowCreateOrUpdateDataFlowOptionalParams
  
  The options parameters.
Returns Promise<LROPoller<DataFlowCreateOrUpdateDataFlowResponse>>

deleteDataFlow

deleteDataFlow(dataFlowName: string, options?: coreHttp.OperationOptions): Promise<LROPoller<coreHttp.RestResponse>>

- Defined in operationsInterfaces/dataFlow.ts:57
Deletes a data flow.

Parameters
- dataFlowName: string
  
  The data flow name.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<LROPoller<coreHttp.RestResponse>>

getDataFlow

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

- Defined in operationsInterfaces/dataFlow.ts:48
Gets a data flow.

Parameters
- dataFlowName: string
  
  The data flow name.
- Optional options: DataFlowGetDataFlowOptionalParams
  
  The options parameters.
Returns Promise<DataFlowGetDataFlowResponse>

listDataFlowsByWorkspace

listDataFlowsByWorkspace(options?: coreHttp.OperationOptions): PagedAsyncIterableIterator<DataFlowResource>

- Defined in operationsInterfaces/dataFlow.ts:29
Lists data flows.

Parameters
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns PagedAsyncIterableIterator<DataFlowResource>

renameDataFlow

renameDataFlow(dataFlowName: string, request: ArtifactRenameRequest, options?: coreHttp.OperationOptions): Promise<LROPoller<coreHttp.RestResponse>>

- Defined in operationsInterfaces/dataFlow.ts:67
Renames a dataflow.

Parameters
- dataFlowName: string
  
  The data flow name.
- request: ArtifactRenameRequest
  
  proposed new name.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<LROPoller<coreHttp.RestResponse>>

Hierarchy

Index

Properties

Methods

Properties

Optional annotations

Optional description

Optional folder

type

Methods

createOrUpdateDataFlow

Parameters

dataFlowName: string

dataFlow: DataFlowResource

Optional options: DataFlowCreateOrUpdateDataFlowOptionalParams

Returns Promise<LROPoller<DataFlowCreateOrUpdateDataFlowResponse>>

deleteDataFlow

Parameters

dataFlowName: string

Optional options: coreHttp.OperationOptions

Returns Promise<LROPoller<coreHttp.RestResponse>>

getDataFlow

Parameters

dataFlowName: string

Optional options: DataFlowGetDataFlowOptionalParams

Returns Promise<DataFlowGetDataFlowResponse>

listDataFlowsByWorkspace

Parameters

Optional options: coreHttp.OperationOptions

Returns PagedAsyncIterableIterator<DataFlowResource>

renameDataFlow

Parameters

dataFlowName: string

request: ArtifactRenameRequest

Optional options: coreHttp.OperationOptions

Returns Promise<LROPoller<coreHttp.RestResponse>>