WorkflowRunsOperations Class

WorkflowRunsOperations 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

WorkflowRunsOperations

Constructor

WorkflowRunsOperations(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	Cancels a workflow run.
get	Gets a workflow run.
list	Gets a list of workflow runs.

cancel

Cancels a workflow run.

cancel(resource_group_name: str, workflow_name: str, run_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

The resource group name.

workflow_name

str

Required

The workflow name.

run_name

str

Required

The workflow run 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 workflow run.

get(resource_group_name: str, workflow_name: str, run_name: str, **kwargs: Any) -> azure.mgmt.logic.models._models_py3.WorkflowRun

Parameters

resource_group_name

str

Required

The resource group name.

workflow_name

str

Required

The workflow name.

run_name

str

Required

The workflow run name.

cls

callable

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

Returns

WorkflowRun, or the result of cls(response)

Return type

WorkflowRun

Exceptions

HttpResponseError

list

Gets a list of workflow runs.

list(resource_group_name: str, workflow_name: str, top: Optional[int] = None, filter: Optional[str] = None, **kwargs: Any) -> Iterable[azure.mgmt.logic.models._models_py3.WorkflowRunListResult]

Parameters

resource_group_name

str

Required

The resource group name.

workflow_name

str

Required

The workflow name.

top

int

Required

The number of items to be included in the result. Default value is None.

filter

str

Required

The filter to apply on the operation. Options for filters include: Status, StartTime, and ClientTrackingId. Default value is None.

cls

callable

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

Returns

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

Return type

ItemPaged[WorkflowRunListResult]

Exceptions

HttpResponseError

Attributes

models

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