executions

Creates, updates, deletes, gets or lists an executions resource.

Overview

Name	executions
Type	Resource
Id	azure.workload_orchestration.executions

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
eTag	string	If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
extendedLocation	object	:vartype extended_location: ~azure.mgmt.workloadorchestration.models.ExtendedLocation
provisioningState	string	Provisioning state of resource. Known values are: "Succeeded", "Failed", "Canceled", "Initialized", "InProgress", and "Deleting". (Succeeded, Failed, Canceled, Initialized, InProgress, Deleting)
specification	object	Execution specification.
status	object	Status of Execution.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workflowVersionId	string	Workflow version of execution. Required.

list_by_workflow_version

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
eTag	string	If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
extendedLocation	object	:vartype extended_location: ~azure.mgmt.workloadorchestration.models.ExtendedLocation
provisioningState	string	Provisioning state of resource. Known values are: "Succeeded", "Failed", "Canceled", "Initialized", "InProgress", and "Deleting". (Succeeded, Failed, Canceled, Initialized, InProgress, Deleting)
specification	object	Execution specification.
status	object	Status of Execution.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workflowVersionId	string	Workflow version of execution. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, context_name, workflow_name, version_name, execution_name, subscription_id		Get Execution Resource.
list_by_workflow_version	select	resource_group_name, context_name, workflow_name, version_name, subscription_id		List Execution Resources.
create_or_update	insert	resource_group_name, context_name, workflow_name, version_name, execution_name, subscription_id		Create or update Execution Resource.
update	update	resource_group_name, context_name, workflow_name, version_name, execution_name, subscription_id		update an Execution Resource.
create_or_update	replace	resource_group_name, context_name, workflow_name, version_name, execution_name, subscription_id		Create or update Execution Resource.
delete	delete	resource_group_name, context_name, workflow_name, version_name, execution_name, subscription_id		Delete Execution Resource.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
context_name	string	The name of the Context. Required.
execution_name	string	The name of the Execution. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
version_name	string	The name of the workflowVersion. Required.
workflow_name	string	Name of the workflow. Required.

SELECT examples

get

Get Execution Resource.

SELECT
id,
name,
eTag,
extendedLocation,
provisioningState,
specification,
status,
systemData,
type,
workflowVersionId
FROM azure.workload_orchestration.executions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND context_name = '{{ context_name }}' -- required
AND workflow_name = '{{ workflow_name }}' -- required
AND version_name = '{{ version_name }}' -- required
AND execution_name = '{{ execution_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_workflow_version

List Execution Resources.

SELECT
id,
name,
eTag,
extendedLocation,
provisioningState,
specification,
status,
systemData,
type,
workflowVersionId
FROM azure.workload_orchestration.executions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND context_name = '{{ context_name }}' -- required
AND workflow_name = '{{ workflow_name }}' -- required
AND version_name = '{{ version_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update Execution Resource.

INSERT INTO azure.workload_orchestration.executions (
properties,
extendedLocation,
resource_group_name,
context_name,
workflow_name,
version_name,
execution_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ extendedLocation }}',
'{{ resource_group_name }}',
'{{ context_name }}',
'{{ workflow_name }}',
'{{ version_name }}',
'{{ execution_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
eTag,
extendedLocation,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: executions
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the executions resource.
  - name: context_name
    value: "{{ context_name }}"
    description: Required parameter for the executions resource.
  - name: workflow_name
    value: "{{ workflow_name }}"
    description: Required parameter for the executions resource.
  - name: version_name
    value: "{{ version_name }}"
    description: Required parameter for the executions resource.
  - name: execution_name
    value: "{{ execution_name }}"
    description: Required parameter for the executions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the executions resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      workflowVersionId: "{{ workflowVersionId }}"
      specification: "{{ specification }}"
      status:
        updateTime: "{{ updateTime }}"
        status: {{ status }}
        statusMessage: "{{ statusMessage }}"
        stageHistory:
          - status: {{ status }}
            statusMessage: "{{ statusMessage }}"
            stage: "{{ stage }}"
            nextstage: "{{ nextstage }}"
            errorMessage: "{{ errorMessage }}"
            isActive: "{{ isActive }}"
            inputs: "{{ inputs }}"
            outputs: "{{ outputs }}"
      provisioningState: "{{ provisioningState }}"
  - name: extendedLocation
    description: |
      :vartype extended_location: ~azure.mgmt.workloadorchestration.models.ExtendedLocation
    value:
      name: "{{ name }}"
      type: "{{ type }}"

UPDATE examples

update

update an Execution Resource.

UPDATE azure.workload_orchestration.executions
SET 
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND context_name = '{{ context_name }}' --required
AND workflow_name = '{{ workflow_name }}' --required
AND version_name = '{{ version_name }}' --required
AND execution_name = '{{ execution_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
eTag,
extendedLocation,
properties,
systemData,
type;

REPLACE examples

create_or_update

Create or update Execution Resource.

REPLACE azure.workload_orchestration.executions
SET 
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND context_name = '{{ context_name }}' --required
AND workflow_name = '{{ workflow_name }}' --required
AND version_name = '{{ version_name }}' --required
AND execution_name = '{{ execution_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
eTag,
extendedLocation,
properties,
systemData,
type;

DELETE examples

delete

Delete Execution Resource.

DELETE FROM azure.workload_orchestration.executions
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND context_name = '{{ context_name }}' --required
AND workflow_name = '{{ workflow_name }}' --required
AND version_name = '{{ version_name }}' --required
AND execution_name = '{{ execution_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;