flows

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

Overview

Name	flows
Type	Resource
Id	azure.data_transfer.flows

Fields

vw_flows

Name	Datatype	Description
connection	text	field from the properties object
connectionName	text	field from the properties object
data_type	text	field from the properties object
flowName	text	field from the properties object
flow_id	text	field from the properties object
flow_type	text	field from the properties object
identity	text	Managed service identity (system assigned and/or user assigned identities)
key_vault_uri	text	field from the properties object
link_status	text	field from the properties object
linked_flow_id	text	field from the properties object
location	text	The geo-location where the resource lives
messaging_options	text	field from the properties object
plan	text	Plan for the resource.
policies	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
schema	text	field from the properties object
service_bus_queue_id	text	field from the properties object
status	text	field from the properties object
storage_account_id	text	field from the properties object
storage_account_name	text	field from the properties object
storage_container_name	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.

flows

Name	Datatype	Description
identity	object	Managed service identity (system assigned and/or user assigned identities)
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

Name	Accessible by	Required Params	Description
get	SELECT	connectionName, flowName, resourceGroupName, subscriptionId	Gets flow resource.
list_by_connection	SELECT	connectionName, resourceGroupName, subscriptionId	Gets flows in a connection.
create_or_update	INSERT	connectionName, flowName, resourceGroupName, subscriptionId, data__location	Creates or updates the flow resource.
delete	DELETE	connectionName, flowName, resourceGroupName, subscriptionId	Deletes the flow resource.
update	UPDATE	connectionName, flowName, resourceGroupName, subscriptionId	Updates the flow resource.
disable	EXEC	connectionName, flowName, resourceGroupName, subscriptionId	Disables the specified flow
enable	EXEC	connectionName, flowName, resourceGroupName, subscriptionId	Enables the specified flow.
link	EXEC	connectionName, flowName, resourceGroupName, subscriptionId, data__id	Links the specified flow.

SELECT examples

Gets flows in a connection.

vw_flows

SELECT
connection,
connectionName,
data_type,
flowName,
flow_id,
flow_type,
identity,
key_vault_uri,
link_status,
linked_flow_id,
location,
messaging_options,
plan,
policies,
provisioning_state,
resourceGroupName,
schema,
service_bus_queue_id,
status,
storage_account_id,
storage_account_name,
storage_container_name,
subscriptionId,
tags
FROM azure.data_transfer.vw_flows
WHERE connectionName = '{{ connectionName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

flows

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

INSERT example

Use the following StackQL query and manifest file to create a new flows resource.

All Properties

/*+ create */
INSERT INTO azure.data_transfer.flows (
connectionName,
flowName,
resourceGroupName,
subscriptionId,
data__location,
properties,
plan,
identity,
tags,
location
)
SELECT 
'{{ connectionName }}',
'{{ flowName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__location }}',
'{{ properties }}',
'{{ plan }}',
'{{ identity }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: connection
          value:
            - name: name
              value: string
            - name: id
              value: string
            - name: location
              value: string
            - name: subscriptionName
              value: string
        - name: flowId
          value: string
        - name: keyVaultUri
          value: string
        - name: linkStatus
          value: string
        - name: linkedFlowId
          value: string
        - name: status
          value: string
        - name: storageAccountName
          value: string
        - name: storageAccountId
          value: string
        - name: storageContainerName
          value: string
        - name: serviceBusQueueId
          value: string
        - name: flowType
          value: []
        - name: dataType
          value: string
        - name: provisioningState
          value: string
        - name: policies
          value:
            - string
        - name: schema
          value:
            - name: id
              value: string
            - name: connectionId
              value: string
            - name: status
              value: string
            - name: name
              value: string
            - name: content
              value: string
            - name: direction
              value: string
        - name: messagingOptions
          value:
            - name: billingTier
              value: string
    - name: plan
      value:
        - name: name
          value: string
        - name: publisher
          value: string
        - name: product
          value: string
        - name: promotionCode
          value: string
        - name: version
          value: string
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: []
        - name: userAssignedIdentities
          value: []
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a flows resource.

/*+ update */
UPDATE azure.data_transfer.flows
SET 
identity = '{{ identity }}',
tags = '{{ tags }}'
WHERE 
connectionName = '{{ connectionName }}'
AND flowName = '{{ flowName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified flows resource.

/*+ delete */
DELETE FROM azure.data_transfer.flows
WHERE connectionName = '{{ connectionName }}'
AND flowName = '{{ flowName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';