PipelineRunsOperations Class

PipelineRunsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance
builtins.object
PipelineRunsOperations

Constructor

PipelineRunsOperations(client, config, serializer, deserializer)

Parameters

client
Required

Client for service requests.

config
Required

Configuration of service client.

serializer
Required

An object model serializer.

deserializer
Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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, factory_name, run_id, is_recursive=None, **kwargs)

Parameters

resource_group_name
str
Required

The resource group name.

factory_name
str
Required

The factory name.

run_id
str
Required

The pipeline run identifier.

is_recursive
bool
default value: None

If true, cancel all the Child pipelines that are triggered by the current pipeline.

cls
callable

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

Returns

None, or the result of cls(response)

Return type

get

Get a pipeline run by its run ID.

get(resource_group_name, factory_name, run_id, **kwargs)

Parameters

resource_group_name
str
Required

The resource group name.

factory_name
str
Required

The factory name.

run_id
str
Required

The pipeline run identifier.

cls
callable

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

Returns

PipelineRun, or the result of cls(response)

Return type

query_by_factory

Query pipeline runs in the factory based on input filter conditions.

query_by_factory(resource_group_name, factory_name, filter_parameters, **kwargs)

Parameters

resource_group_name
str
Required

The resource group name.

factory_name
str
Required

The factory name.

filter_parameters
RunFilterParameters
Required

Parameters to filter the pipeline run.

cls
callable

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

Returns

PipelineRunsQueryResponse, or the result of cls(response)

Return type

Attributes

models

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