data_flow_debug_sessions

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

Overview

Name	data_flow_debug_sessions
Type	Resource
Id	azure.data_factory.data_flow_debug_sessions

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create	insert	subscriptionId, resourceGroupName, factoryName	api-version	Creates a data flow debug session.
query_by_factory	exec	subscriptionId, resourceGroupName, factoryName	api-version	Query all active data flow debug sessions.
add_data_flow	exec	subscriptionId, resourceGroupName, factoryName	api-version	Add a data flow into debug session.
delete	exec	subscriptionId, resourceGroupName, factoryName	api-version	Deletes a data flow debug session.
execute_command	exec	subscriptionId, resourceGroupName, factoryName	api-version	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
factoryName	string	The factory name.
resourceGroupName	string	The resource group name.
subscriptionId	string	The subscription identifier.
api-version	string	The API version.

INSERT examples

create

Creates a data flow debug session.

INSERT INTO azure.data_factory.data_flow_debug_sessions (
data__computeType,
data__coreCount,
data__timeToLive,
data__integrationRuntime,
subscriptionId,
resourceGroupName,
factoryName,
api-version
)
SELECT 
'{{ computeType }}',
{{ coreCount }},
{{ timeToLive }},
'{{ integrationRuntime }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ factoryName }}',
'{{ api-version }}'
RETURNING
sessionId,
status
;

Manifest

# Description fields are for documentation purposes
- name: data_flow_debug_sessions
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the data_flow_debug_sessions resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the data_flow_debug_sessions resource.
    - name: factoryName
      value: string
      description: Required parameter for the data_flow_debug_sessions resource.
    - name: computeType
      value: string
      description: |
        Compute type of the cluster. The value will be overwritten by the same setting in integration runtime if provided.
    - name: coreCount
      value: integer
      description: |
        Core count of the cluster. The value will be overwritten by the same setting in integration runtime if provided.
    - name: timeToLive
      value: integer
      description: |
        Time to live setting of the cluster in minutes.
    - name: integrationRuntime
      value: object
      description: |
        Set to use integration runtime setting for data flow debug session.
    - name: api-version
      value: string
      description: The API version.

Lifecycle Methods

query_by_factory

Query all active data flow debug sessions.

EXEC azure.data_factory.data_flow_debug_sessions.query_by_factory 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@factoryName='{{ factoryName }}' --required, 
@api-version='{{ api-version }}'
;

add_data_flow

Add a data flow into debug session.

EXEC azure.data_factory.data_flow_debug_sessions.add_data_flow 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@factoryName='{{ factoryName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"sessionId": "{{ sessionId }}", 
"dataFlow": "{{ dataFlow }}", 
"dataFlows": "{{ dataFlows }}", 
"datasets": "{{ datasets }}", 
"linkedServices": "{{ linkedServices }}", 
"staging": "{{ staging }}", 
"debugSettings": "{{ debugSettings }}"
}'
;

delete

Deletes a data flow debug session.

EXEC azure.data_factory.data_flow_debug_sessions.delete 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@factoryName='{{ factoryName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"sessionId": "{{ sessionId }}"
}'
;

execute_command

Execute a data flow debug command.

EXEC azure.data_factory.data_flow_debug_sessions.execute_command 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@factoryName='{{ factoryName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"sessionId": "{{ sessionId }}", 
"command": "{{ command }}", 
"commandPayload": "{{ commandPayload }}"
}'
;