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.objectWorkflowsOperations
Constructor
WorkflowsOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- 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: azure.mgmt.logic.models._models_py3.WorkflowReference, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]Parameters
- 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
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
create_or_update
Creates or updates a workflow.
create_or_update(resource_group_name: str, workflow_name: str, workflow: azure.mgmt.logic.models._models_py3.Workflow, **kwargs: Any) -> azure.mgmt.logic.models._models_py3.WorkflowParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Workflow, or the result of cls(response)
Return type
Exceptions
delete
Deletes a workflow.
delete(resource_group_name: str, workflow_name: str, **kwargs: Any) -> NoneParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
disable
Disables a workflow.
disable(resource_group_name: str, workflow_name: str, **kwargs: Any) -> NoneParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
enable
Enables a workflow.
enable(resource_group_name: str, workflow_name: str, **kwargs: Any) -> NoneParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
generate_upgraded_definition
Generates the upgraded definition for a workflow.
generate_upgraded_definition(resource_group_name: str, workflow_name: str, parameters: azure.mgmt.logic.models._models_py3.GenerateUpgradedDefinitionParameters, **kwargs: Any) -> AnyParameters
- parameters
- GenerateUpgradedDefinitionParameters
Parameters for generating an upgraded definition.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
any, or the result of cls(response)
Return type
Exceptions
get
Gets a workflow.
get(resource_group_name: str, workflow_name: str, **kwargs: Any) -> azure.mgmt.logic.models._models_py3.WorkflowParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Workflow, or the result of cls(response)
Return type
Exceptions
list_by_resource_group
Gets a list of workflows by resource group.
list_by_resource_group(resource_group_name: str, top: Optional[int] = None, filter: Optional[str] = None, **kwargs: Any) -> Iterable[azure.mgmt.logic.models._models_py3.WorkflowListResult]Parameters
- filter
- str
The filter to apply on the operation. Options for filters include: State, Trigger, and ReferencedResourceId. Default value is None.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either WorkflowListResult or the result of cls(response)
Return type
Exceptions
list_by_subscription
Gets a list of workflows by subscription.
list_by_subscription(top: Optional[int] = None, filter: Optional[str] = None, **kwargs: Any) -> Iterable[azure.mgmt.logic.models._models_py3.WorkflowListResult]Parameters
- filter
- str
The filter to apply on the operation. Options for filters include: State, Trigger, and ReferencedResourceId. Default value is None.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either WorkflowListResult or the result of cls(response)
Return type
Exceptions
list_callback_url
Get the workflow callback Url.
list_callback_url(resource_group_name: str, workflow_name: str, list_callback_url: azure.mgmt.logic.models._models_py3.GetCallbackUrlParameters, **kwargs: Any) -> azure.mgmt.logic.models._models_py3.WorkflowTriggerCallbackUrlParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
WorkflowTriggerCallbackUrl, or the result of cls(response)
Return type
Exceptions
list_swagger
Gets an OpenAPI definition for the workflow.
list_swagger(resource_group_name: str, workflow_name: str, **kwargs: Any) -> AnyParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
any, or the result of cls(response)
Return type
Exceptions
regenerate_access_key
Regenerates the callback URL access key for request triggers.
regenerate_access_key(resource_group_name: str, workflow_name: str, key_type: azure.mgmt.logic.models._models_py3.RegenerateActionParameter, **kwargs: Any) -> NoneParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
update
Updates a workflow.
update(resource_group_name: str, workflow_name: str, **kwargs: Any) -> azure.mgmt.logic.models._models_py3.WorkflowParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Workflow, or the result of cls(response)
Return type
Exceptions
validate_by_location
Validates the workflow definition.
validate_by_location(resource_group_name: str, location: str, workflow_name: str, validate: azure.mgmt.logic.models._models_py3.Workflow, **kwargs: Any) -> NoneParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
validate_by_resource_group
Validates the workflow.
validate_by_resource_group(resource_group_name: str, workflow_name: str, validate: azure.mgmt.logic.models._models_py3.Workflow, **kwargs: Any) -> NoneParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.logic.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\logic\\models\\__init__.py'>Feedback
Submit and view feedback for