data_flows

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

Overview

Name	data_flows
Type	Resource
Id	azure.data_factory.data_flows

Fields

The following fields are returned by SELECT queries:

get

OK.

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
etag	string	Etag identifies change in the resource.
properties	object	Data flow properties.
type	string	The resource type.

list_by_factory

OK.

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
etag	string	Etag identifies change in the resource.
properties	object	Data flow properties.
type	string	The resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, factoryName, dataFlowName	api-version, If-None-Match	Gets a data flow.
list_by_factory	select	subscriptionId, resourceGroupName, factoryName	api-version	Lists data flows.
create_or_update	insert	subscriptionId, resourceGroupName, factoryName, dataFlowName, data__properties	api-version, If-Match	Creates or updates a data flow.
delete	delete	subscriptionId, resourceGroupName, factoryName, dataFlowName	api-version	Deletes a data flow.

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
dataFlowName	string	The data flow name.
factoryName	string	The factory name.
resourceGroupName	string	The resource group name.
subscriptionId	string	The subscription identifier.
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.
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.
api-version	string	The API version.

SELECT examples

get

Gets a data flow.

SELECT
id,
name,
etag,
properties,
type
FROM azure.data_factory.data_flows
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND factoryName = '{{ factoryName }}' -- required
AND dataFlowName = '{{ dataFlowName }}' -- required
AND api-version = '{{ api-version }}'
AND If-None-Match = '{{ If-None-Match }}'
;

list_by_factory

Lists data flows.

SELECT
id,
name,
etag,
properties,
type
FROM azure.data_factory.data_flows
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND factoryName = '{{ factoryName }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create_or_update

Creates or updates a data flow.

INSERT INTO azure.data_factory.data_flows (
data__properties,
subscriptionId,
resourceGroupName,
factoryName,
dataFlowName,
api-version,
If-Match
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ factoryName }}',
'{{ dataFlowName }}',
'{{ api-version }}',
'{{ If-Match }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: data_flows
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the data_flows resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the data_flows resource.
    - name: factoryName
      value: string
      description: Required parameter for the data_flows resource.
    - name: dataFlowName
      value: string
      description: Required parameter for the data_flows resource.
    - name: properties
      value: object
      description: |
        Data flow properties.
    - name: api-version
      value: string
      description: The API version.
    - name: If-Match
      value: string
      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.

DELETE examples

delete

Deletes a data flow.

DELETE FROM azure.data_factory.data_flows
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND factoryName = '{{ factoryName }}' --required
AND dataFlowName = '{{ dataFlowName }}' --required
AND api-version = '{{ api-version }}'
;