Pipelines interface

Package:

@azure/arm-datafactory

Interface representing a Pipelines.

Methods

createOrUpdate(string, string, string, PipelineResource, PipelinesCreateOrUpdateOptionalParams)	Creates or updates a pipeline.
createRun(string, string, string, PipelinesCreateRunOptionalParams)	Creates a run of a pipeline.
delete(string, string, string, PipelinesDeleteOptionalParams)	Deletes a pipeline.
get(string, string, string, PipelinesGetOptionalParams)	Gets a pipeline.
listByFactory(string, string, PipelinesListByFactoryOptionalParams)	Lists pipelines.

Method Details

createOrUpdate(string, string, string, PipelineResource, PipelinesCreateOrUpdateOptionalParams)

Creates or updates a pipeline.

function createOrUpdate(resourceGroupName: string, factoryName: string, pipelineName: string, pipeline: PipelineResource, options?: PipelinesCreateOrUpdateOptionalParams): Promise<PipelineResource>

Parameters

resourceGroupName

string

The resource group name.

factoryName

string

The factory name.

pipelineName

string

The pipeline name.

pipeline

PipelineResource

Pipeline resource definition.

options

PipelinesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PipelineResource>

createRun(string, string, string, PipelinesCreateRunOptionalParams)

Creates a run of a pipeline.

function createRun(resourceGroupName: string, factoryName: string, pipelineName: string, options?: PipelinesCreateRunOptionalParams): Promise<CreateRunResponse>

Parameters

resourceGroupName

string

The resource group name.

factoryName

string

The factory name.

pipelineName

string

The pipeline name.

options

PipelinesCreateRunOptionalParams

The options parameters.

Returns

Promise<CreateRunResponse>

delete(string, string, string, PipelinesDeleteOptionalParams)

Deletes a pipeline.

function delete(resourceGroupName: string, factoryName: string, pipelineName: string, options?: PipelinesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The resource group name.

factoryName

string

The factory name.

pipelineName

string

The pipeline name.

options

PipelinesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, PipelinesGetOptionalParams)

Gets a pipeline.

function get(resourceGroupName: string, factoryName: string, pipelineName: string, options?: PipelinesGetOptionalParams): Promise<PipelineResource>

Parameters

resourceGroupName

string

The resource group name.

factoryName

string

The factory name.

pipelineName

string

The pipeline name.

options

PipelinesGetOptionalParams

The options parameters.

Returns

Promise<PipelineResource>

listByFactory(string, string, PipelinesListByFactoryOptionalParams)

Lists pipelines.

function listByFactory(resourceGroupName: string, factoryName: string, options?: PipelinesListByFactoryOptionalParams): PagedAsyncIterableIterator<PipelineResource, PipelineResource[], PageSettings>

Parameters

resourceGroupName

string

The resource group name.

factoryName

string

The factory name.

options

PipelinesListByFactoryOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PipelineResource, PipelineResource[], PageSettings>