DataFlowDebugSessionOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

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

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 name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
request Required	DataFlowDebugPackage or 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. The AddDataFlowToDebugSessionResponse is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_create

Creates a data flow debug session.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
request Required	CreateDataFlowDebugSessionRequest or CreateDataFlowDebugSessionRequest or IO[bytes] Data flow debug session definition. Is either a CreateDataFlowDebugSessionRequest type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[CreateDataFlowDebugSessionResponse]	An instance of LROPoller that returns CreateDataFlowDebugSessionResponse. The CreateDataFlowDebugSessionResponse is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_execute_command

Execute a data flow debug command.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
request Required	DataFlowDebugCommandRequest or DataFlowDebugCommandRequest or IO[bytes] Data flow debug command definition. Is either a DataFlowDebugCommandRequest type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[DataFlowDebugCommandResponse]	An instance of LROPoller that returns DataFlowDebugCommandResponse. The DataFlowDebugCommandResponse is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

delete

Deletes a data flow debug session.

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 name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
request Required	DeleteDataFlowDebugSessionRequest or 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

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) -> ItemPaged[DataFlowDebugSessionInfo]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.

Returns

Type	Description
ItemPaged[DataFlowDebugSessionInfo]	An iterator like instance of DataFlowDebugSessionInfo

Exceptions

Type	Description
HttpResponseError

Feedback

Was this page helpful?