PipelinesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:pipelines> attribute.

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, *, content_type: str = 'application/json', etag: str | None = None, match_condition: MatchConditions | None = None, **kwargs: Any) -> _models.PipelineResource

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
pipeline_name Required	str The pipeline name. Required.
pipeline Required	PipelineResource or PipelineResource or IO[bytes] Pipeline resource definition. Is either a PipelineResource type or a IO[bytes] type. Required.

Keyword-Only Parameters

Name	Description
etag	str check if resource is changed. Set None to skip checking etag. Default value is None. Default value: None
match_condition	MatchConditions The match condition to use upon the etag. Default value is None. Default value: None

Returns

Type	Description
PipelineResource	PipelineResource. The PipelineResource is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

create_run

Creates a run of a pipeline.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
pipeline_name Required	str The pipeline name. Required.
parameters	dict[str, any] or IO[bytes] Parameters of the pipeline run. These parameters will be used only if the runId is not specified. Is either a {str: Any} type or a IO[bytes] type. Default value is None. Default value: None

Keyword-Only Parameters

Name	Description
reference_pipeline_run_id	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. Default value: None
is_recovery	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. Default value: None
start_activity_name	str In recovery mode, the rerun will start from this activity. If not specified, all activities will run. Default value is None. Default value: None
start_from_failure	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. Default value: None

Returns

Type	Description
CreateRunResponse	CreateRunResponse. The CreateRunResponse is compatible with MutableMapping

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 name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
pipeline_name Required	str The pipeline name. Required.

Returns

Type	Description
None	None

Exceptions

Type	Description
HttpResponseError

get

Gets a pipeline.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
pipeline_name Required	str The pipeline name. Required.

Keyword-Only Parameters

Name	Description
etag	str check if resource is changed. Set None to skip checking etag. Default value is None. Default value: None
match_condition	MatchConditions The match condition to use upon the etag. Default value is None. Default value: None

Returns

Type	Description
PipelineResource, None	PipelineResource or None. The PipelineResource is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list_by_factory

Lists pipelines.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.

Returns

Type	Description
ItemPaged[PipelineResource]	An iterator like instance of PipelineResource

Exceptions

Type	Description
HttpResponseError

Feedback

Was this page helpful?