WorkflowsOperations Class

WorkflowsOperations 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

WorkflowsOperations

Constructor

WorkflowsOperations(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

begin_move	Moves an existing workflow.
create_or_update	Creates or updates a workflow.
delete	Deletes a workflow.
disable	Disables a workflow.
enable	Enables a workflow.
generate_upgraded_definition	Generates the upgraded definition for a workflow.
get	Gets a workflow.
list_by_resource_group	Gets a list of workflows by resource group.
list_by_subscription	Gets a list of workflows by subscription.
list_callback_url	Get the workflow callback Url.
list_swagger	Gets an OpenAPI definition for the workflow.
regenerate_access_key	Regenerates the callback URL access key for request triggers.
update	Updates a workflow.
validate_by_location	Validates the workflow definition.
validate_by_resource_group	Validates the workflow.

begin_move

Moves an existing workflow.

begin_move(resource_group_name: str, workflow_name: str, move: WorkflowReference, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The resource group name.
workflow_name Required	str The workflow name.
move Required	WorkflowReference The workflow to move.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

create_or_update

Creates or updates a workflow.

create_or_update(resource_group_name: str, workflow_name: str, workflow: Workflow, **kwargs: Any) -> Workflow

Parameters

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

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

delete

Deletes a workflow.

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

Parameters

Name	Description
resource_group_name Required	str The resource group name.
workflow_name Required	str The workflow 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

disable

Disables a workflow.

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

Parameters

Name	Description
resource_group_name Required	str The resource group name.
workflow_name Required	str The workflow 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

enable

Enables a workflow.

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

Parameters

Name	Description
resource_group_name Required	str The resource group name.
workflow_name Required	str The workflow 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

generate_upgraded_definition

Generates the upgraded definition for a workflow.

generate_upgraded_definition(resource_group_name: str, workflow_name: str, parameters: GenerateUpgradedDefinitionParameters, **kwargs: Any) -> Any

Parameters

Name	Description
resource_group_name Required	str The resource group name.
workflow_name Required	str The workflow name.
parameters Required	GenerateUpgradedDefinitionParameters Parameters for generating an upgraded definition.

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Gets a workflow.

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

Parameters

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

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Gets a list of workflows by resource group.

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

Parameters

Name	Description
resource_group_name Required	str The resource group 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: State, Trigger, and ReferencedResourceId. 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[WorkflowListResult]	An iterator like instance of either WorkflowListResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_subscription

Gets a list of workflows by subscription.

list_by_subscription(top: int | None = None, filter: str | None = None, **kwargs: Any) -> Iterable[WorkflowListResult]

Parameters

Name	Description
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: State, Trigger, and ReferencedResourceId. 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[WorkflowListResult]	An iterator like instance of either WorkflowListResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_callback_url

Get the workflow callback Url.

list_callback_url(resource_group_name: str, workflow_name: str, list_callback_url: GetCallbackUrlParameters, **kwargs: Any) -> WorkflowTriggerCallbackUrl

Parameters

Name	Description
resource_group_name Required	str The resource group name.
workflow_name Required	str The workflow name.
list_callback_url Required	GetCallbackUrlParameters Which callback url to list.

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

list_swagger

Gets an OpenAPI definition for the workflow.

list_swagger(resource_group_name: str, workflow_name: str, **kwargs: Any) -> Any

Parameters

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

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

regenerate_access_key

Regenerates the callback URL access key for request triggers.

regenerate_access_key(resource_group_name: str, workflow_name: str, key_type: RegenerateActionParameter, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The resource group name.
workflow_name Required	str The workflow name.
key_type Required	RegenerateActionParameter The access key type.

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

update

Updates a workflow.

update(resource_group_name: str, workflow_name: str, **kwargs: Any) -> Workflow

Parameters

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

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

validate_by_location

Validates the workflow definition.

validate_by_location(resource_group_name: str, location: str, workflow_name: str, validate: Workflow, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The resource group name.
location Required	str The workflow location.
workflow_name Required	str The workflow name.
validate Required	Workflow The workflow.

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

validate_by_resource_group

Validates the workflow.

validate_by_resource_group(resource_group_name: str, workflow_name: str, validate: Workflow, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The resource group name.
workflow_name Required	str The workflow name.
validate Required	Workflow The workflow.

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

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