workflow_versions

Creates, updates, deletes, gets or lists a workflow_versions resource.

Overview

Name	workflow_versions
Type	Resource
Id	azure.workload_orchestration.workflow_versions

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.
configuration	string	Resolved configuration values.
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)
reviewId	string	Review id of resolved config for this workflow version.
revision	integer	Revision number of resolved config for this workflow version.
specification	object	Execution specification.
stageSpec	array	A list of stage specs. Required.
state	string	State of workflow version. Known values are: "InReview", "UpgradeInReview", "ReadyToDeploy", "ReadyToUpgrade", "Deploying", "Deployed", "Failed", "Undeployed", "PendingExternalValidation", "ExternalValidationFailed", and "Staging". (InReview, UpgradeInReview, ReadyToDeploy, ReadyToUpgrade, Deploying, Deployed, Failed, Undeployed, PendingExternalValidation, ExternalValidationFailed, Staging)
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".

list_by_workflow

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.
configuration	string	Resolved configuration values.
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)
reviewId	string	Review id of resolved config for this workflow version.
revision	integer	Revision number of resolved config for this workflow version.
specification	object	Execution specification.
stageSpec	array	A list of stage specs. Required.
state	string	State of workflow version. Known values are: "InReview", "UpgradeInReview", "ReadyToDeploy", "ReadyToUpgrade", "Deploying", "Deployed", "Failed", "Undeployed", "PendingExternalValidation", "ExternalValidationFailed", and "Staging". (InReview, UpgradeInReview, ReadyToDeploy, ReadyToUpgrade, Deploying, Deployed, Failed, Undeployed, PendingExternalValidation, ExternalValidationFailed, Staging)
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".

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, subscription_id		Get a Workflow Version Resource.
list_by_workflow	select	resource_group_name, context_name, workflow_name, subscription_id		List Workflow Version Resources.
create_or_update	insert	resource_group_name, context_name, workflow_name, version_name, subscription_id		Create or update a Workflow Version Resource.
update	update	resource_group_name, context_name, workflow_name, version_name, subscription_id		update an WorkflowVersion Resource.
create_or_update	replace	resource_group_name, context_name, workflow_name, version_name, subscription_id		Create or update a Workflow Version Resource.
delete	delete	resource_group_name, context_name, workflow_name, version_name, subscription_id		Delete a Workflow Version 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.
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 a Workflow Version Resource.

SELECT
id,
name,
configuration,
eTag,
extendedLocation,
provisioningState,
reviewId,
revision,
specification,
stageSpec,
state,
systemData,
type
FROM azure.workload_orchestration.workflow_versions
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
;

list_by_workflow

List Workflow Version Resources.

SELECT
id,
name,
configuration,
eTag,
extendedLocation,
provisioningState,
reviewId,
revision,
specification,
stageSpec,
state,
systemData,
type
FROM azure.workload_orchestration.workflow_versions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND context_name = '{{ context_name }}' -- required
AND workflow_name = '{{ workflow_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a Workflow Version Resource.

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

Manifest

# Description fields are for documentation purposes
- name: workflow_versions
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the workflow_versions resource.
  - name: context_name
    value: "{{ context_name }}"
    description: Required parameter for the workflow_versions resource.
  - name: workflow_name
    value: "{{ workflow_name }}"
    description: Required parameter for the workflow_versions resource.
  - name: version_name
    value: "{{ version_name }}"
    description: Required parameter for the workflow_versions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workflow_versions resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      revision: {{ revision }}
      configuration: "{{ configuration }}"
      stageSpec:
        - name: "{{ name }}"
          specification: "{{ specification }}"
          tasks: "{{ tasks }}"
          taskOption:
            concurrency: {{ concurrency }}
            errorAction:
              mode: "{{ mode }}"
              maxToleratedFailures: {{ maxToleratedFailures }}
      reviewId: "{{ reviewId }}"
      state: "{{ state }}"
      specification: "{{ specification }}"
      provisioningState: "{{ provisioningState }}"
  - name: extendedLocation
    description: |
      :vartype extended_location: ~azure.mgmt.workloadorchestration.models.ExtendedLocation
    value:
      name: "{{ name }}"
      type: "{{ type }}"

UPDATE examples

update

update an WorkflowVersion Resource.

UPDATE azure.workload_orchestration.workflow_versions
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 subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
eTag,
extendedLocation,
properties,
systemData,
type;

REPLACE examples

create_or_update

Create or update a Workflow Version Resource.

REPLACE azure.workload_orchestration.workflow_versions
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 subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
eTag,
extendedLocation,
properties,
systemData,
type;

DELETE examples

delete

Delete a Workflow Version Resource.

DELETE FROM azure.workload_orchestration.workflow_versions
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
;