flows

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

Overview

Name	flows
Type	Resource
Id	azure.data_transfer.flows

Fields

The following fields are returned by SELECT queries:

get

Retrieved the flows resource.

Name	Datatype	Description
identity	object	The managed identity of the flow resource, if configured.
location	string	The geo-location where the resource lives
plan	object	Plan for the resource.
properties	object	Properties of flow
tags	object	Resource tags.

list_by_connection

Listed all flows under the resource group.

Name	Datatype	Description
identity	object	The managed identity of the flow resource, if configured.
location	string	The geo-location where the resource lives
plan	object	Plan for the resource.
properties	object	Properties of flow
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, connectionName, flowName		Gets flow resource.
list_by_connection	select	subscriptionId, resourceGroupName, connectionName		Gets flows in a connection.
create_or_update	insert	subscriptionId, resourceGroupName, connectionName, flowName, data__location		Creates or updates the flow resource.
update	update	subscriptionId, resourceGroupName, connectionName, flowName		Updates the flow resource.
delete	delete	subscriptionId, resourceGroupName, connectionName, flowName		Deletes the flow resource.
enable	exec	subscriptionId, resourceGroupName, connectionName, flowName		Enables the specified flow.
disable	exec	subscriptionId, resourceGroupName, connectionName, flowName		Disables the specified flow
link	exec	subscriptionId, resourceGroupName, connectionName, flowName, id		Links the specified 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
connectionName	string	The name for the connection that is to be requested.
flowName	string	The name for the flow that is to be onboarded.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets flow resource.

SELECT
identity,
location,
plan,
properties,
tags
FROM azure.data_transfer.flows
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND connectionName = '{{ connectionName }}' -- required
AND flowName = '{{ flowName }}' -- required
;

list_by_connection

Gets flows in a connection.

SELECT
identity,
location,
plan,
properties,
tags
FROM azure.data_transfer.flows
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND connectionName = '{{ connectionName }}' -- required
;

INSERT examples

create_or_update

Creates or updates the flow resource.

INSERT INTO azure.data_transfer.flows (
data__properties,
data__plan,
data__identity,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
connectionName,
flowName
)
SELECT 
'{{ properties }}',
'{{ plan }}',
'{{ identity }}',
'{{ tags }}',
'{{ location }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ connectionName }}',
'{{ flowName }}'
RETURNING
identity,
location,
plan,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: flows
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the flows resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the flows resource.
    - name: connectionName
      value: string
      description: Required parameter for the flows resource.
    - name: flowName
      value: string
      description: Required parameter for the flows resource.
    - name: properties
      value: object
      description: |
        Properties of flow
    - name: plan
      value: object
      description: |
        Plan for the resource.
    - name: identity
      value: object
      description: |
        The managed identity of the flow resource, if configured.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Updates the flow resource.

UPDATE azure.data_transfer.flows
SET 
data__identity = '{{ identity }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND connectionName = '{{ connectionName }}' --required
AND flowName = '{{ flowName }}' --required
RETURNING
identity,
location,
plan,
properties,
tags;

DELETE examples

delete

Deletes the flow resource.

DELETE FROM azure.data_transfer.flows
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND connectionName = '{{ connectionName }}' --required
AND flowName = '{{ flowName }}' --required
;

Lifecycle Methods

enable

Enables the specified flow.

EXEC azure.data_transfer.flows.enable 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@connectionName='{{ connectionName }}' --required, 
@flowName='{{ flowName }}' --required
;

disable

Disables the specified flow

EXEC azure.data_transfer.flows.disable 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@connectionName='{{ connectionName }}' --required, 
@flowName='{{ flowName }}' --required
;

link

Links the specified flow.

EXEC azure.data_transfer.flows.link 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@connectionName='{{ connectionName }}' --required, 
@flowName='{{ flowName }}' --required 
@@json=
'{
"id": "{{ id }}", 
"statusReason": "{{ statusReason }}"
}'
;