PipelinesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

DataFactoryManagementClient's

<xref:pipelines> attribute.

Inheritance

builtins.object

PipelinesOperations

Constructor

PipelinesOperations(*args, **kwargs)

Methods

create_or_update	Creates or updates a pipeline.
create_run	Creates a run of a pipeline.
delete	Deletes a pipeline.
get	Gets a pipeline.
list_by_factory	Lists pipelines.

create_or_update

Creates or updates a pipeline.

async create_or_update(resource_group_name: str, factory_name: str, pipeline_name: str, pipeline: azure.mgmt.datafactory.models._models_py3.PipelineResource, if_match: Optional[str] = None, **kwargs: Any) -> azure.mgmt.datafactory.models._models_py3.PipelineResource

Parameters

resource_group_name

str

Required

The resource group name.

factory_name

str

Required

The factory name.

pipeline_name

str

Required

The pipeline name.

pipeline

PipelineResource

Required

Pipeline resource definition.

if_match

str

Required

ETag of the pipeline entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. Default value is None.

cls

callable

A custom type or function that will be passed the direct response

Returns

PipelineResource, or the result of cls(response)

Return type

PipelineResource

Exceptions

HttpResponseError

create_run

Creates a run of a pipeline.

async create_run(resource_group_name: str, factory_name: str, pipeline_name: str, reference_pipeline_run_id: Optional[str] = None, is_recovery: Optional[bool] = None, start_activity_name: Optional[str] = None, start_from_failure: Optional[bool] = None, parameters: Optional[Dict[str, Any]] = None, **kwargs: Any) -> azure.mgmt.datafactory.models._models_py3.CreateRunResponse

Parameters

resource_group_name

str

Required

The resource group name.

factory_name

str

Required

The factory name.

pipeline_name

str

Required

The pipeline name.

reference_pipeline_run_id

str

Required

The pipeline run identifier. If run ID is specified the parameters of the specified run will be used to create a new run. Default value is None.

is_recovery

bool

Required

Recovery mode flag. If recovery mode is set to true, the specified referenced pipeline run and the new run will be grouped under the same groupId. Default value is None.

start_activity_name

str

Required

In recovery mode, the rerun will start from this activity. If not specified, all activities will run. Default value is None.

start_from_failure

bool

Required

In recovery mode, if set to true, the rerun will start from failed activities. The property will be used only if startActivityName is not specified. Default value is None.

parameters

dict[str, any]

Required

Parameters of the pipeline run. These parameters will be used only if the runId is not specified. Default value is None.

cls

callable

A custom type or function that will be passed the direct response

Returns

CreateRunResponse, or the result of cls(response)

Return type

CreateRunResponse

Exceptions

HttpResponseError

delete

Deletes a pipeline.

async delete(resource_group_name: str, factory_name: str, pipeline_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

The resource group name.

factory_name

str

Required

The factory name.

pipeline_name

str

Required

The pipeline name.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get

Gets a pipeline.

async get(resource_group_name: str, factory_name: str, pipeline_name: str, if_none_match: Optional[str] = None, **kwargs: Any) -> Optional[azure.mgmt.datafactory.models._models_py3.PipelineResource]

Parameters

resource_group_name

str

Required

The resource group name.

factory_name

str

Required

The factory name.

pipeline_name

str

Required

The pipeline name.

if_none_match

str

Required

ETag of the pipeline entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. Default value is None.

cls

callable

A custom type or function that will be passed the direct response

Returns

PipelineResource, or the result of cls(response)

Return type

PipelineResource,

None

Exceptions

HttpResponseError

list_by_factory

Lists pipelines.

list_by_factory(resource_group_name: str, factory_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.datafactory.models._models_py3.PipelineListResponse]

Parameters

resource_group_name

str

Required

The resource group name.

factory_name

str

Required

The factory name.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PipelineListResponse or the result of cls(response)

Return type

AsyncItemPaged[PipelineListResponse]

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.datafactory.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\datafactory\\models\\__init__.py'>