workflow_run
Creates, updates, deletes, gets or lists a workflow_run resource.
Overview
| Name | workflow_run |
| Type | Resource |
| Id | azure.purview_workflow.workflow_run |
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 |
|---|---|---|---|---|
get_raw | exec | workflow_run_id, endpoint | Get a workflow run. | |
cancel | exec | workflow_run_id, endpoint | Cancel a workflow run. |
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_run_id | string | The workflow run id. Required. |
Lifecycle Methods
- get_raw
- cancel
Get a workflow run.
EXEC azure.purview_workflow.workflow_run.get_raw
@workflow_run_id='{{ workflow_run_id }}' --required,
@endpoint='{{ endpoint }}' --required
;
Cancel a workflow run.
EXEC azure.purview_workflow.workflow_run.cancel
@workflow_run_id='{{ workflow_run_id }}' --required,
@endpoint='{{ endpoint }}' --required
;