workflows

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

Overview

Name	workflows
Type	Resource
Id	azure.workload_orchestration.workflows

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)
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".
workflowTemplateId	string	Workflow template Id.

list_by_context

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)
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".
workflowTemplateId	string	Workflow template Id.

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, subscription_id		Get a Workflow resource.
list_by_context	select	resource_group_name, context_name, subscription_id		List Workflow resources.
create_or_update	insert	resource_group_name, context_name, workflow_name, subscription_id		Create or update a Workflow resource.
update	update	resource_group_name, context_name, workflow_name, subscription_id		update a Workflow resource.
create_or_update	replace	resource_group_name, context_name, workflow_name, subscription_id		Create or update a Workflow resource.
delete	delete	resource_group_name, context_name, workflow_name, subscription_id		Delete a Workflow 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
workflow_name	string	Name of the workflow. Required.

SELECT examples

get

Get a Workflow resource.

SELECT
id,
name,
eTag,
extendedLocation,
provisioningState,
systemData,
type,
workflowTemplateId
FROM azure.workload_orchestration.workflows
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
;

list_by_context

List Workflow resources.

SELECT
id,
name,
eTag,
extendedLocation,
provisioningState,
systemData,
type,
workflowTemplateId
FROM azure.workload_orchestration.workflows
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND context_name = '{{ context_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a Workflow resource.

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

Manifest

# Description fields are for documentation purposes
- name: workflows
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the workflows resource.
  - name: context_name
    value: "{{ context_name }}"
    description: Required parameter for the workflows resource.
  - name: workflow_name
    value: "{{ workflow_name }}"
    description: Required parameter for the workflows resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workflows resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      workflowTemplateId: "{{ workflowTemplateId }}"
      provisioningState: "{{ provisioningState }}"
  - name: extendedLocation
    description: |
      :vartype extended_location: ~azure.mgmt.workloadorchestration.models.ExtendedLocation
    value:
      name: "{{ name }}"
      type: "{{ type }}"

UPDATE examples

update

update a Workflow resource.

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

REPLACE examples

create_or_update

Create or update a Workflow resource.

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

DELETE examples

delete

Delete a Workflow resource.

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