Share via

WorkflowTriggersOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

WebSiteManagementClient's

<xref:workflow_triggers> attribute.

Constructor

WorkflowTriggersOperations(*args, **kwargs)

Methods

begin_run

Runs a workflow trigger.
get

Gets a workflow trigger.
get_schema_json

Get the trigger schema as JSON.
list

Gets a list of workflow triggers.
list_callback_url

Get the callback URL for a workflow trigger.

begin_run

Runs a workflow trigger.

async begin_run(resource_group_name: str, name: str, workflow_name: str, trigger_name: str, **kwargs: Any) -> AsyncLROPoller[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.
trigger_name
Required
str

The workflow trigger name. Required.

Returns

Type Description
AsyncLROPoller[None]

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Gets a workflow trigger.

async get(resource_group_name: str, name: str, workflow_name: str, trigger_name: str, **kwargs: Any) -> WorkflowTrigger

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.
trigger_name
Required
str

The workflow trigger name. Required.

Returns

Type Description
WorkflowTrigger

WorkflowTrigger or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get_schema_json

Get the trigger schema as JSON.

async get_schema_json(resource_group_name: str, name: str, workflow_name: str, trigger_name: str, **kwargs: Any) -> JsonSchema

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.
trigger_name
Required
str

The workflow trigger name. Required.

Returns

Type Description
JsonSchema

JsonSchema or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Gets a list of workflow triggers.

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

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. Default value is None.

Default value: None

Returns

Type Description
AsyncItemPaged[WorkflowTrigger]

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

Exceptions

Type Description
HttpResponseError

list_callback_url

Get the callback URL for a workflow trigger.

async list_callback_url(resource_group_name: str, name: str, workflow_name: str, trigger_name: str, **kwargs: Any) -> WorkflowTriggerCallbackUrl

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.
trigger_name
Required
str

The workflow trigger name. Required.

Returns

Type Description
WorkflowTriggerCallbackUrl

WorkflowTriggerCallbackUrl 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'>