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

Name	Description
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

Name	Description
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

Name	Description
resource_group_name Required	str The resource group name.
workflow_name Required	str The workflow name.
run_name Required	str The workflow run name.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
None	None, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets a workflow run.

get(resource_group_name: str, workflow_name: str, run_name: str, **kwargs: Any) -> WorkflowRun

Parameters

Name	Description
resource_group_name Required	str The resource group name.
workflow_name Required	str The workflow name.
run_name Required	str The workflow run name.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
WorkflowRun	WorkflowRun, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Gets a list of workflow runs.

list(resource_group_name: str, workflow_name: str, top: int | None = None, filter: str | None = None, **kwargs: Any) -> Iterable[WorkflowRunListResult]

Parameters

Name	Description
resource_group_name Required	str The resource group name.
workflow_name Required	str The workflow name.
top Required	int The number of items to be included in the result. Default value is None.
filter Required	str The filter to apply on the operation. Options for filters include: Status, StartTime, and ClientTrackingId. Default value is None.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[WorkflowRunListResult]	An iterator like instance of either WorkflowRunListResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

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