data_flow

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

Overview

Name	data_flow
Type	Resource
Id	azure.synapse_artifacts.data_flow

Fields

The following fields are returned by SELECT queries:

get_data_flow

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
annotations	array	List of tags that can be used for describing the data flow.
description	string	The description of the data flow.
etag	string	Resource Etag.
folder	object	The folder that this data flow is in. If not specified, Data flow will appear at the root level.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_data_flows_by_workspace

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
annotations	array	List of tags that can be used for describing the data flow.
description	string	The description of the data flow.
etag	string	Resource Etag.
folder	object	The folder that this data flow is in. If not specified, Data flow will appear at the root level.
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_data_flow	select	data_flow_name, endpoint	If-None-Match	Gets a data flow.
get_data_flows_by_workspace	select	endpoint		Lists data flows.
create_or_update_data_flow	insert	data_flow_name, endpoint, type	If-Match	Creates or updates a data flow.
create_or_update_data_flow	replace	data_flow_name, endpoint, type	If-Match	Creates or updates a data flow.
delete_data_flow	delete	data_flow_name, endpoint		Deletes a data flow.
rename_data_flow	exec	data_flow_name, endpoint		Renames a dataflow.

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
data_flow_name	string	The data flow name. Required.
endpoint	string	The service endpoint host (no scheme). (default: )
If-Match	string	ETag of the data flow entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. Default value is None.
If-None-Match	string	ETag of the data flow entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. Default value is None.

SELECT examples

get_data_flow

Gets a data flow.

SELECT
id,
name,
annotations,
description,
etag,
folder,
type
FROM azure.synapse_artifacts.data_flow
WHERE data_flow_name = '{{ data_flow_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND If-None-Match = '{{ If-None-Match }}'
;

get_data_flows_by_workspace

Lists data flows.

SELECT
id,
name,
annotations,
description,
etag,
folder,
type
FROM azure.synapse_artifacts.data_flow
WHERE endpoint = '{{ endpoint }}' -- required
;

INSERT examples

create_or_update_data_flow

Creates or updates a data flow.

INSERT INTO azure.synapse_artifacts.data_flow (
type,
description,
annotations,
folder,
data_flow_name,
endpoint,
If-Match
)
SELECT 
'{{ type }}' /* required */,
'{{ description }}',
'{{ annotations }}',
'{{ folder }}',
'{{ data_flow_name }}',
'{{ endpoint }}',
'{{ If-Match }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: data_flow
props:
  - name: data_flow_name
    value: "{{ data_flow_name }}"
    description: Required parameter for the data_flow resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the data_flow resource.
  - name: type
    value: "{{ type }}"
    description: |
      Type of data flow. Required.
  - name: description
    value: "{{ description }}"
    description: |
      The description of the data flow.
  - name: annotations
    value: "{{ annotations }}"
    description: |
      List of tags that can be used for describing the data flow.
  - name: folder
    description: |
      The folder that this data flow is in. If not specified, Data flow will appear at the root level.
    value:
      name: "{{ name }}"
  - name: If-Match
    value: "{{ If-Match }}"
    description: ETag of the data flow entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. Default value is None.
    description: ETag of the data flow entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. Default value is None.

REPLACE examples

create_or_update_data_flow

Creates or updates a data flow.

REPLACE azure.synapse_artifacts.data_flow
SET 
type = '{{ type }}',
description = '{{ description }}',
annotations = '{{ annotations }}',
folder = '{{ folder }}'
WHERE 
data_flow_name = '{{ data_flow_name }}' --required
AND endpoint = '{{ endpoint }}' --required
AND type = '{{ type }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
id,
name,
etag,
properties,
type;

DELETE examples

delete_data_flow

Deletes a data flow.

DELETE FROM azure.synapse_artifacts.data_flow
WHERE data_flow_name = '{{ data_flow_name }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

rename_data_flow

Renames a dataflow.

EXEC azure.synapse_artifacts.data_flow.rename_data_flow 
@data_flow_name='{{ data_flow_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;