WorkflowTriggersOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

WebSiteManagementClient's

<xref:workflow_triggers> attribute.

Inheritance
builtins.object
WorkflowTriggersOperations

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.

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

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

Exceptions

Type Description

get

Gets a workflow trigger.

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 or the result of cls(response)

Exceptions

Type Description

get_schema_json

Get the trigger schema as JSON.

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 or the result of cls(response)

Exceptions

Type Description

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

Returns

Type Description

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

Exceptions

Type Description

list_callback_url

Get the callback URL for a workflow trigger.

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 or the result of cls(response)

Exceptions

Type Description

Attributes

models

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