PipelineOperations interface

Package:

@azure/synapse-artifacts

Interface representing a PipelineOperations.

Methods

beginCreateOrUpdatePipeline(string, PipelineResource, PipelineCreateOrUpdatePipelineOptionalParams)	Creates or updates a pipeline.
beginCreateOrUpdatePipelineAndWait(string, PipelineResource, PipelineCreateOrUpdatePipelineOptionalParams)	Creates or updates a pipeline.
beginDeletePipeline(string, PipelineDeletePipelineOptionalParams)	Deletes a pipeline.
beginDeletePipelineAndWait(string, PipelineDeletePipelineOptionalParams)	Deletes a pipeline.
beginRenamePipeline(string, ArtifactRenameRequest, PipelineRenamePipelineOptionalParams)	Renames a pipeline.
beginRenamePipelineAndWait(string, ArtifactRenameRequest, PipelineRenamePipelineOptionalParams)	Renames a pipeline.
createPipelineRun(string, PipelineCreatePipelineRunOptionalParams)	Creates a run of a pipeline.
getPipeline(string, PipelineGetPipelineOptionalParams)	Gets a pipeline.
listPipelinesByWorkspace(PipelineGetPipelinesByWorkspaceOptionalParams)	Lists pipelines.

Method Details

beginCreateOrUpdatePipeline(string, PipelineResource, PipelineCreateOrUpdatePipelineOptionalParams)

Creates or updates a pipeline.

function beginCreateOrUpdatePipeline(pipelineName: string, pipeline: PipelineResource, options?: PipelineCreateOrUpdatePipelineOptionalParams): Promise<SimplePollerLike<OperationState<PipelineResource>, PipelineResource>>

Parameters

pipelineName

string

The pipeline name.

pipeline

PipelineResource

Pipeline resource definition.

options

PipelineCreateOrUpdatePipelineOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdatePipelineAndWait(string, PipelineResource, PipelineCreateOrUpdatePipelineOptionalParams)

Creates or updates a pipeline.

function beginCreateOrUpdatePipelineAndWait(pipelineName: string, pipeline: PipelineResource, options?: PipelineCreateOrUpdatePipelineOptionalParams): Promise<PipelineResource>

Parameters

pipelineName

string

The pipeline name.

pipeline

PipelineResource

Pipeline resource definition.

options

PipelineCreateOrUpdatePipelineOptionalParams

The options parameters.

Returns

Promise<PipelineResource>

beginDeletePipeline(string, PipelineDeletePipelineOptionalParams)

Deletes a pipeline.

function beginDeletePipeline(pipelineName: string, options?: PipelineDeletePipelineOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

pipelineName

string

The pipeline name.

options

PipelineDeletePipelineOptionalParams

The options parameters.

Returns

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

beginDeletePipelineAndWait(string, PipelineDeletePipelineOptionalParams)

Deletes a pipeline.

function beginDeletePipelineAndWait(pipelineName: string, options?: PipelineDeletePipelineOptionalParams): Promise<void>

Parameters

pipelineName

string

The pipeline name.

options

PipelineDeletePipelineOptionalParams

The options parameters.

Returns

Promise<void>

beginRenamePipeline(string, ArtifactRenameRequest, PipelineRenamePipelineOptionalParams)

Renames a pipeline.

function beginRenamePipeline(pipelineName: string, request: ArtifactRenameRequest, options?: PipelineRenamePipelineOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

pipelineName

string

The pipeline name.

request

ArtifactRenameRequest

proposed new name.

options

PipelineRenamePipelineOptionalParams

The options parameters.

Returns

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

beginRenamePipelineAndWait(string, ArtifactRenameRequest, PipelineRenamePipelineOptionalParams)

Renames a pipeline.

function beginRenamePipelineAndWait(pipelineName: string, request: ArtifactRenameRequest, options?: PipelineRenamePipelineOptionalParams): Promise<void>

Parameters

pipelineName

string

The pipeline name.

request

ArtifactRenameRequest

proposed new name.

options

PipelineRenamePipelineOptionalParams

The options parameters.

Returns

Promise<void>

createPipelineRun(string, PipelineCreatePipelineRunOptionalParams)

Creates a run of a pipeline.

function createPipelineRun(pipelineName: string, options?: PipelineCreatePipelineRunOptionalParams): Promise<CreateRunResponse>

Parameters

pipelineName

string

The pipeline name.

options

PipelineCreatePipelineRunOptionalParams

The options parameters.

Returns

Promise<CreateRunResponse>

getPipeline(string, PipelineGetPipelineOptionalParams)

Gets a pipeline.

function getPipeline(pipelineName: string, options?: PipelineGetPipelineOptionalParams): Promise<PipelineResource>

Parameters

pipelineName

string

The pipeline name.

options

PipelineGetPipelineOptionalParams

The options parameters.

Returns

Promise<PipelineResource>

listPipelinesByWorkspace(PipelineGetPipelinesByWorkspaceOptionalParams)

Lists pipelines.

function listPipelinesByWorkspace(options?: PipelineGetPipelinesByWorkspaceOptionalParams): PagedAsyncIterableIterator<PipelineResource, PipelineResource[], PageSettings>

Parameters

options

PipelineGetPipelinesByWorkspaceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PipelineResource, PipelineResource[], PageSettings>