data_flow_debug_session

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

Overview

Name	data_flow_debug_session
Type	Resource
Id	azure.data_factory.data_flow_debug_session

Fields

The following fields are returned by SELECT queries:

query_by_factory

Name	Datatype	Description
computeType	string	Compute type of the cluster.
coreCount	integer	Core count of the cluster.
dataFlowName	string	The name of the data flow.
integrationRuntimeName	string	Attached integration runtime name of data flow debug session.
lastActivityTime	string	Last activity time of data flow debug session.
nodeCount	integer	Node count of the cluster. (deprecated property).
sessionId	string	The ID of data flow debug session.
startTime	string	Start time of data flow debug session.
timeToLiveInMinutes	integer	Compute type of the cluster.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
query_by_factory	select	resource_group_name, factory_name, subscription_id		Query all active data flow debug sessions.
create	insert	resource_group_name, factory_name, subscription_id		Creates a data flow debug session.
delete	delete	resource_group_name, factory_name, subscription_id		Deletes a data flow debug session.
add_data_flow	exec	resource_group_name, factory_name, subscription_id		Add a data flow into debug session.
execute_command	exec	resource_group_name, factory_name, subscription_id		Execute a data flow debug command.

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
factory_name	string	The factory name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

query_by_factory

Query all active data flow debug sessions.

SELECT
computeType,
coreCount,
dataFlowName,
integrationRuntimeName,
lastActivityTime,
nodeCount,
sessionId,
startTime,
timeToLiveInMinutes
FROM azure.data_factory.data_flow_debug_session
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND factory_name = '{{ factory_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates a data flow debug session.

INSERT INTO azure.data_factory.data_flow_debug_session (
computeType,
coreCount,
timeToLive,
integrationRuntime,
resource_group_name,
factory_name,
subscription_id
)
SELECT 
'{{ computeType }}',
{{ coreCount }},
{{ timeToLive }},
'{{ integrationRuntime }}',
'{{ resource_group_name }}',
'{{ factory_name }}',
'{{ subscription_id }}'
RETURNING
sessionId,
status
;

Manifest

# Description fields are for documentation purposes
- name: data_flow_debug_session
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the data_flow_debug_session resource.
  - name: factory_name
    value: "{{ factory_name }}"
    description: Required parameter for the data_flow_debug_session resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the data_flow_debug_session resource.
  - name: computeType
    value: "{{ computeType }}"
    description: |
      Compute type of the cluster. The value will be overwritten by the same setting in integration runtime if provided.
  - name: coreCount
    value: {{ coreCount }}
    description: |
      Core count of the cluster. The value will be overwritten by the same setting in integration runtime if provided.
  - name: timeToLive
    value: {{ timeToLive }}
    description: |
      Time to live setting of the cluster in minutes.
  - name: integrationRuntime
    description: |
      Set to use integration runtime setting for data flow debug session.
    value:
      name: "{{ name }}"
      properties:
        type: "{{ type }}"
        description: "{{ description }}"

DELETE examples

delete

Deletes a data flow debug session.

DELETE FROM azure.data_factory.data_flow_debug_session
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND factory_name = '{{ factory_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

add_data_flow

Add a data flow into debug session.

EXEC azure.data_factory.data_flow_debug_session.add_data_flow 
@resource_group_name='{{ resource_group_name }}' --required, 
@factory_name='{{ factory_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"sessionId": "{{ sessionId }}", 
"dataFlow": "{{ dataFlow }}", 
"dataFlows": "{{ dataFlows }}", 
"datasets": "{{ datasets }}", 
"linkedServices": "{{ linkedServices }}", 
"staging": "{{ staging }}", 
"debugSettings": "{{ debugSettings }}"
}'
;

execute_command

Execute a data flow debug command.

EXEC azure.data_factory.data_flow_debug_session.execute_command 
@resource_group_name='{{ resource_group_name }}' --required, 
@factory_name='{{ factory_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"sessionId": "{{ sessionId }}", 
"command": "{{ command }}", 
"commandPayload": "{{ commandPayload }}"
}'
;