workflow

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

Overview

Name	workflow
Type	Resource
Id	azure.purview_workflow.workflow

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_or_replace	insert	workflow_id, endpoint		Create or replace a workflow.
create_or_replace	replace	workflow_id, endpoint		Create or replace a workflow.
delete	delete	workflow_id, endpoint		Delete a workflow.
get_raw	exec	workflow_id, endpoint		Get a specific workflow.
validate	exec	workflow_id, endpoint		Validate a workflow.

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
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
workflow_id	string	The workflow id. Required.

INSERT examples

create_or_replace

Create or replace a workflow.

INSERT INTO azure.purview_workflow.workflow (
workflow_id,
endpoint
)
SELECT 
'{{ workflow_id }}',
'{{ endpoint }}'
;

Manifest

# Description fields are for documentation purposes
- name: workflow
props:
  - name: workflow_id
    value: "{{ workflow_id }}"
    description: Required parameter for the workflow resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the workflow resource.

REPLACE examples

create_or_replace

Create or replace a workflow.

REPLACE azure.purview_workflow.workflow
SET 
-- No updatable properties
WHERE 
workflow_id = '{{ workflow_id }}' --required
AND endpoint = '{{ endpoint }}' --required;

DELETE examples

delete

Delete a workflow.

DELETE FROM azure.purview_workflow.workflow
WHERE workflow_id = '{{ workflow_id }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

get_raw

Get a specific workflow.

EXEC azure.purview_workflow.workflow.get_raw 
@workflow_id='{{ workflow_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

validate

Validate a workflow.

EXEC azure.purview_workflow.workflow.validate 
@workflow_id='{{ workflow_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;