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.synapse_artifacts.data_flow_debug_session

Fields

The following fields are returned by SELECT queries:

query_data_flow_debug_sessions_by_workspace

Name	Datatype	Description
	object	Unmatched properties from the message are deserialized to this collection.
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_data_flow_debug_sessions_by_workspace	select	endpoint		Query all active data flow debug sessions.
create_data_flow_debug_session	insert	endpoint		Creates a data flow debug session.
delete_data_flow_debug_session	delete	endpoint		Deletes a data flow debug session.
add_data_flow	exec	endpoint		Add a data flow into debug session.
execute_command	exec	endpoint		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
endpoint	string	The service endpoint host (no scheme). (default: )

SELECT examples

query_data_flow_debug_sessions_by_workspace

Query all active data flow debug sessions.

SELECT
,
computeType,
coreCount,
dataFlowName,
integrationRuntimeName,
lastActivityTime,
nodeCount,
sessionId,
startTime,
timeToLiveInMinutes
FROM azure.synapse_artifacts.data_flow_debug_session
WHERE endpoint = '{{ endpoint }}' -- required
;

INSERT examples

create_data_flow_debug_session

Creates a data flow debug session.

INSERT INTO azure.synapse_artifacts.data_flow_debug_session (
computeType,
coreCount,
timeToLive,
integrationRuntime,
endpoint
)
SELECT 
'{{ computeType }}',
{{ coreCount }},
{{ timeToLive }},
'{{ integrationRuntime }}',
'{{ endpoint }}'
RETURNING
sessionId
;

Manifest

# Description fields are for documentation purposes
- name: data_flow_debug_session
props:
  - name: endpoint
    value: "{{ endpoint }}"
    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_data_flow_debug_session

Deletes a data flow debug session.

DELETE FROM azure.synapse_artifacts.data_flow_debug_session
WHERE endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

add_data_flow

Add a data flow into debug session.

EXEC azure.synapse_artifacts.data_flow_debug_session.add_data_flow 
@endpoint='{{ endpoint }}' --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.synapse_artifacts.data_flow_debug_session.execute_command 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"sessionId": "{{ sessionId }}", 
"command": "{{ command }}", 
"commandPayload": "{{ commandPayload }}"
}'
;