Share via

PipelinesOperations Class

  • Reference

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.

create_or_update(resource_group_name: str, factory_name: str, pipeline_name: str, pipeline: _models.PipelineResource, if_match: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PipelineResource

Parameters

Name Description
resource_group_name
Required
str

The resource group name. Required.
factory_name
Required
str

The factory name. Required.
pipeline_name
Required
str

The pipeline name. Required.
pipeline
Required
PipelineResource or IO[bytes]

Pipeline resource definition. Is either a PipelineResource type or a IO[bytes] type. Required.
if_match
Required
str

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.

Returns

Type Description
PipelineResource

PipelineResource or the result of cls(response)

Exceptions

Type Description
HttpResponseError

create_run

Creates a run of a pipeline.

create_run(resource_group_name: str, factory_name: str, pipeline_name: str, reference_pipeline_run_id: str | None = None, is_recovery: bool | None = None, start_activity_name: str | None = None, start_from_failure: bool | None = None, parameters: Dict[str, JSON] | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.CreateRunResponse

Parameters

Name Description
resource_group_name
Required
str

The resource group name. Required.
factory_name
Required
str

The factory name. Required.
pipeline_name
Required
str

The pipeline name. Required.
reference_pipeline_run_id
Required
str

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
Required
bool

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
Required
str

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

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
Required
dict[str, <xref:JSON>] or IO[bytes]

Parameters of the pipeline run. These parameters will be used only if the runId is not specified. Is either a {str: JSON} type or a IO[bytes] type. Default value is None.

Returns

Type Description
CreateRunResponse

CreateRunResponse or the result of cls(response)

Exceptions

Type Description
HttpResponseError

delete

Deletes a pipeline.

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

Parameters

Name Description
resource_group_name
Required
str

The resource group name. Required.
factory_name
Required
str

The factory name. Required.
pipeline_name
Required
str

The pipeline name. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Gets a pipeline.

get(resource_group_name: str, factory_name: str, pipeline_name: str, if_none_match: str | None = None, **kwargs: Any) -> PipelineResource | None

Parameters

Name Description
resource_group_name
Required
str

The resource group name. Required.
factory_name
Required
str

The factory name. Required.
pipeline_name
Required
str

The pipeline name. Required.
if_none_match
Required
str

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.

Returns

Type Description
PipelineResource,
None

PipelineResource or None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_factory

Lists pipelines.

list_by_factory(resource_group_name: str, factory_name: str, **kwargs: Any) -> Iterable[PipelineResource]

Parameters

Name Description
resource_group_name
Required
str

The resource group name. Required.
factory_name
Required
str

The factory name. Required.

Returns

Type Description
ItemPaged[PipelineResource]

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

Exceptions

Type Description
HttpResponseError

Attributes

models 

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