Share via

DataFlowDebugSessionOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

DataFactoryManagementClient's

<xref:data_flow_debug_session> attribute.

Constructor

DataFlowDebugSessionOperations(*args, **kwargs)

Methods

add_data_flow

Add a data flow into debug session.
begin_create

Creates a data flow debug session.
begin_execute_command

Execute a data flow debug command.
delete

Deletes a data flow debug session.
query_by_factory

Query all active data flow debug sessions.

add_data_flow

Add a data flow into debug session.

async add_data_flow(resource_group_name: str, factory_name: str, request: _models.DataFlowDebugPackage, *, content_type: str = 'application/json', **kwargs: Any) -> _models.AddDataFlowToDebugSessionResponse

Parameters

Name Description
resource_group_name
Required
str

The resource group name. Required.
factory_name
Required
str

The factory name. Required.
request
Required
DataFlowDebugPackage or IO[bytes]

Data flow debug session definition with debug content. Is either a DataFlowDebugPackage type or a IO[bytes] type. Required.

Returns

Type Description
AddDataFlowToDebugSessionResponse

AddDataFlowToDebugSessionResponse or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_create

Creates a data flow debug session.

async begin_create(resource_group_name: str, factory_name: str, request: _models.CreateDataFlowDebugSessionRequest, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.CreateDataFlowDebugSessionResponse]

Parameters

Name Description
resource_group_name
Required
str

The resource group name. Required.
factory_name
Required
str

The factory name. Required.
request
Required
CreateDataFlowDebugSessionRequest or IO[bytes]

Data flow debug session definition. Is either a CreateDataFlowDebugSessionRequest type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[CreateDataFlowDebugSessionResponse]

An instance of AsyncLROPoller that returns either CreateDataFlowDebugSessionResponse or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_execute_command

Execute a data flow debug command.

async begin_execute_command(resource_group_name: str, factory_name: str, request: _models.DataFlowDebugCommandRequest, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.DataFlowDebugCommandResponse]

Parameters

Name Description
resource_group_name
Required
str

The resource group name. Required.
factory_name
Required
str

The factory name. Required.
request
Required
DataFlowDebugCommandRequest or IO[bytes]

Data flow debug command definition. Is either a DataFlowDebugCommandRequest type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[DataFlowDebugCommandResponse]

An instance of AsyncLROPoller that returns either DataFlowDebugCommandResponse or the result of cls(response)

Exceptions

Type Description
HttpResponseError

delete

Deletes a data flow debug session.

async delete(resource_group_name: str, factory_name: str, request: _models.DeleteDataFlowDebugSessionRequest, *, content_type: str = 'application/json', **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

The resource group name. Required.
factory_name
Required
str

The factory name. Required.
request
Required
DeleteDataFlowDebugSessionRequest or IO[bytes]

Data flow debug session definition for deletion. Is either a DeleteDataFlowDebugSessionRequest type or a IO[bytes] type. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

query_by_factory

Query all active data flow debug sessions.

query_by_factory(resource_group_name: str, factory_name: str, **kwargs: Any) -> AsyncIterable[DataFlowDebugSessionInfo]

Parameters

Name Description
resource_group_name
Required
str

The resource group name. Required.
factory_name
Required
str

The factory name. Required.

Returns

Type Description
AsyncItemPaged[DataFlowDebugSessionInfo]

An iterator like instance of either DataFlowDebugSessionInfo or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.datafactory.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv110\\Lib\\site-packages\\azure\\mgmt\\datafactory\\models\\__init__.py'>