DataflowsClient

Attributes

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'OnRefreshComplete': {'operation_id': 'OnRefreshComplete', 'path': '/{connectionId}/api/groups/{groupIdForOnRefreshComplete}/dataflows/{dataflowIdForOnRefreshComplete}/onrefreshcomplete', 'method': 'get', 'required_parameters': ['workspaceType', 'groupIdForOnRefreshComplete', 'dataflowIdForOnRefreshComplete'], 'callback_payload_type': 'RefreshModel'}}

Classes

DataflowModel dataclass

DataflowModel(*, dataflow_name: Optional[str] = None, dataflow_id: Optional[str] = None)

Response for Refresh a dataflow

Attributes

dataflow_name class-attribute instance-attribute

dataflow_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'dataflowName'})

Name of the dataflow

dataflow_id class-attribute instance-attribute

dataflow_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'dataflowId'})

Id of the dataflow

RefreshModel dataclass

RefreshModel(*, dataflow_id: Optional[str] = None, dataflow_name: Optional[str] = None, refresh_type: Optional[str] = None, start_time: Optional[str] = None, end_time: Optional[str] = None, status: Optional[str] = None)

Response for When a dataflow refresh completes

Attributes

dataflow_id class-attribute instance-attribute

dataflow_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'dataflowId'})

Id of the dataflow

dataflow_name class-attribute instance-attribute

dataflow_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'dataflowName'})

Name of the dataflow

refresh_type class-attribute instance-attribute

refresh_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'refreshType'})

Type of the dataflow refresh

start_time class-attribute instance-attribute

start_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'startTime'})

Start time of the dataflow refresh

end_time class-attribute instance-attribute

end_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'endTime'})

Completion time of the dataflow refresh

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True)

Status of the dataflow refresh. Possible values are: 'Success', 'Failed', 'Cancelled'

Groups dataclass

Groups(*, value: Optional[List[Dict[str, Any]]] = None)

Response for ListGroupsForRefreshDataflow

Dataflows dataclass

Dataflows(*, value: Optional[List[Dict[str, Any]]] = None)

Response for ListDataflowsForRefreshDataflow

DataflowsClient

DataflowsClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

Bases: ConnectorClientBase

Typed client for dataflows connector.

Initialize a DataflowsClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
credential	AsyncTokenCredential | AzureKeyCredential	Caller-owned Azure Core credential.	required
max_retry_attempts	int	The maximum number of request attempts.	3
timeout	float	The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.	30.0
use_exponential_backoff	bool	Whether retries use exponential backoff.	True
initial_retry_delay_seconds	float	The initial retry delay in seconds.	0.5
maximum_retry_delay_seconds	float	The maximum retry delay in seconds.	120.0
retry_jitter_factor	float	The jitter fraction applied to retry delays.	0.1
retry_unsafe_http_methods	bool	Whether unsafe HTTP methods may be retried.	False
transport	Optional[AsyncHttpTransport]	Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.	None
**kwargs	Any	Optional Azure Core pipeline policy settings.	{}

Methods:

refresh_dataflow async

refresh_dataflow(group_id_for_refresh_dataflow: str, dataflow_id_for_refresh_dataflow: str, workspace_type: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Refresh a dataflow

Initiate a dataflow refresh operation.

Swagger operation ID: RefreshDataflow.

Parameters:

Name	Type	Description	Default
group_id_for_refresh_dataflow	str	The unique identifier of the workspace or environment.	required
dataflow_id_for_refresh_dataflow	str	The unique identifier of the dataflow.	required
workspace_type	str	Select workspace or environment.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_groups_for_refresh_dataflow

list_groups_for_refresh_dataflow(workspace_type: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

ListGroupsForRefreshDataflow

Get workspaces or environments

Returns a single-page Azure Core async collection.

Swagger operation ID: ListGroupsForRefreshDataflow.

Parameters:

Name	Type	Description	Default
workspace_type	str	Select workspace or environment.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_dataflows_for_refresh_dataflow

list_dataflows_for_refresh_dataflow(group_id_for_refresh_dataflow: str, workspace_type: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

ListDataflowsForRefreshDataflow

Get dataflows

Returns a single-page Azure Core async collection.

Swagger operation ID: ListDataflowsForRefreshDataflow.

Parameters:

Name	Type	Description	Default
group_id_for_refresh_dataflow	str	The unique identifier of the workspace or environment.	required
workspace_type	str	Select workspace or environment.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_groups_for_on_refresh_complete

list_groups_for_on_refresh_complete(workspace_type: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

ListGroupsForOnRefreshComplete

Get workspaces or environments

Returns a single-page Azure Core async collection.

Swagger operation ID: ListGroupsForOnRefreshComplete.

Parameters:

Name	Type	Description	Default
workspace_type	str	Select workspace or environment.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_dataflows_for_on_refresh_complete

list_dataflows_for_on_refresh_complete(group_id_for_on_refresh_complete: str, workspace_type: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

ListDataflowsForOnRefreshComplete

Get dataflows

Returns a single-page Azure Core async collection.

Swagger operation ID: ListDataflowsForOnRefreshComplete.

Parameters:

Name	Type	Description	Default
group_id_for_on_refresh_complete	str	The unique identifier of the workspace or environment.	required
workspace_type	str	Select workspace or environment.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.