PipelineRunsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:pipeline_runs> attribute.
Constructor
PipelineRunsOperations(*args, **kwargs)Methods
| cancel |
Cancel a pipeline run by its run ID. |
| get |
Get a pipeline run by its run ID. |
| query_by_factory |
Query pipeline runs in the factory based on input filter conditions. |
cancel
Cancel a pipeline run by its run ID.
cancel(resource_group_name: str, factory_name: str, run_id: str, is_recursive: bool | None = None, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The resource group name. Required. |
|
factory_name
Required
|
The factory name. Required. |
|
run_id
Required
|
The pipeline run identifier. Required. |
|
is_recursive
|
If true, cancel all the Child pipelines that are triggered by the current pipeline. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Get a pipeline run by its run ID.
get(resource_group_name: str, factory_name: str, run_id: str, **kwargs: Any) -> PipelineRunParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The resource group name. Required. |
|
factory_name
Required
|
The factory name. Required. |
|
run_id
Required
|
The pipeline run identifier. Required. |
Returns
| Type | Description |
|---|---|
|
PipelineRun or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
query_by_factory
Query pipeline runs in the factory based on input filter conditions.
query_by_factory(resource_group_name: str, factory_name: str, filter_parameters: _models.RunFilterParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PipelineRunsQueryResponseParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The resource group name. Required. |
|
factory_name
Required
|
The factory name. Required. |
|
filter_parameters
Required
|
Parameters to filter the pipeline run. Is either a RunFilterParameters type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
PipelineRunsQueryResponse or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.datafactory.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv105\\Lib\\site-packages\\azure\\mgmt\\datafactory\\models\\__init__.py'>