Share via

WorkflowRunsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

WebSiteManagementClient's

<xref:workflow_runs> attribute.

Constructor

WorkflowRunsOperations(*args, **kwargs)

Methods

cancel

Cancels a workflow run.
get

Gets a workflow run.
list

Gets a list of workflow runs.

cancel

Cancels a workflow run.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.
name
Required
str

Site name. Required.
workflow_name
Required
str

The workflow name. Required.
run_name
Required
str

The workflow run name. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Gets a workflow run.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.
name
Required
str

Site name. Required.
workflow_name
Required
str

The workflow name. Required.
run_name
Required
str

The workflow run name. Required.

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, name: str, workflow_name: str, top: int | None = None, filter: str | None = None, **kwargs: Any) -> AsyncItemPaged[WorkflowRun]

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.
name
Required
str

Site name. Required.
workflow_name
Required
str

The workflow name. Required.
top
int

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

Default value: None
filter
str

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

Default value: None

Returns

Type Description
AsyncItemPaged[WorkflowRun]

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

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.web.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv239\\Lib\\site-packages\\azure\\mgmt\\web\\models\\__init__.py'>