• Home
• airflow.providers.microsoft.azure
• airflow.providers.microsoft.azure.operators
• airflow.providers.microsoft.azure.operators.powerbi

airflow.providers.microsoft.azure.operators.powerbi

Classes

PowerBILink	Construct a link to monitor a dataset in Power BI.
PowerBIDatasetRefreshOperator	Refreshes a Power BI dataset.
PowerBIWorkspaceListOperator	Gets a list of workspaces where the service principal from the connection is assigned as admin.
PowerBIDatasetListOperator	Gets a list of datasets where the service principal from the connection is assigned as admin.

Module Contents

class airflow.providers.microsoft.azure.operators.powerbi.PowerBILink

Bases: airflow.sdk.BaseOperatorLink

Construct a link to monitor a dataset in Power BI.

name = 'Monitor PowerBI Dataset'

Name of the link. This will be the button name on the task UI.

get_link(operator, *, ti_key)

Link to external system.

Parameters:

• operator (airflow.models.BaseOperator) – The Airflow operator object this link is associated to.

• ti_key (airflow.models.taskinstancekey.TaskInstanceKey) – TaskInstance ID to return link for.

Returns:

link to external system

class airflow.providers.microsoft.azure.operators.powerbi.PowerBIDatasetRefreshOperator(*, dataset_id, group_id, conn_id=PowerBIHook.default_conn_name, timeout=60 * 60 * 24 * 7, proxies=None, api_version=None, check_interval=60, **kwargs)

Bases: airflow.models.BaseOperator

Refreshes a Power BI dataset.

See also

For more information on how to use this operator, take a look at the guide: PowerBIDatasetRefreshOperator

Parameters:

• dataset_id (str) – The dataset id.

• group_id (str) – The workspace id.

• conn_id (str) – Airflow Connection ID that contains the connection information for the Power BI account used for authentication.

• timeout (float) – Time in seconds to wait for a dataset to reach a terminal status for asynchronous waits. Used only if wait_for_termination is True.

• check_interval (int) – Number of seconds to wait before rechecking the refresh status.

template_fields: collections.abc.Sequence[str] = ('dataset_id', 'group_id')

template_fields_renderers

operator_extra_links

hook

dataset_id

group_id

wait_for_termination = True

conn_id = 'powerbi_default'

timeout = 604800

check_interval = 60

property proxies: dict | None

property api_version: str | None

execute(context)

Refresh the Power BI Dataset.

get_refresh_status(context, event=None)

Push the refresh Id to XCom then runs the Trigger to wait for refresh completion.

execute_complete(context, event)

Return immediately - callback for when the trigger fires.

Relies on trigger to throw an exception, otherwise it assumes execution was successful.

class airflow.providers.microsoft.azure.operators.powerbi.PowerBIWorkspaceListOperator(*, conn_id=PowerBIHook.default_conn_name, timeout=60 * 60 * 24 * 7, proxies=None, api_version=None, **kwargs)

Bases: airflow.models.BaseOperator

Gets a list of workspaces where the service principal from the connection is assigned as admin.

See also

For more information on how to use this operator, take a look at the guide: PowerBIWorkspaceListOperator

Parameters:

• conn_id (str) – The connection Id to connect to PowerBI.

• timeout (float) – The HTTP timeout being used by the KiotaRequestAdapter. Default is 1 week (60s * 60m * 24h * 7d). When no timeout is specified or set to None then there is no HTTP timeout on each request.

• proxies (dict | None) – A dict defining the HTTP proxies to be used (default is None).

• api_version (msgraph_core.APIVersion | str | None) – The API version of the Microsoft Graph API to be used (default is v1). You can pass an enum named APIVersion which has 2 possible members v1 and beta, or you can pass a string as v1.0 or beta.

hook

conn_id = 'powerbi_default'

timeout = 604800

property proxies: dict | None

property api_version: str | None

execute(context)

List visible PowerBI Workspaces.

execute_complete(context, event)

Return immediately - callback for when the trigger fires.

Relies on trigger to throw an exception, otherwise it assumes execution was successful.

class airflow.providers.microsoft.azure.operators.powerbi.PowerBIDatasetListOperator(*, group_id, conn_id=PowerBIHook.default_conn_name, timeout=60 * 60 * 24 * 7, proxies=None, api_version=None, **kwargs)

Bases: airflow.models.BaseOperator

Gets a list of datasets where the service principal from the connection is assigned as admin.

See also

For more information on how to use this operator, take a look at the guide: PowerBIDatasetListOperator

Parameters:

• conn_id (str) – The connection Id to connect to PowerBI.

• group_id (str) – The group Id to list discoverable datasets.

• timeout (float) – The HTTP timeout being used by the KiotaRequestAdapter. Default is 1 week (60s * 60m * 24h * 7d). When no timeout is specified or set to None then there is no HTTP timeout on each request.

• proxies (dict | None) – A dict defining the HTTP proxies to be used (default is None).

• api_version (msgraph_core.APIVersion | str | None) – The API version of the Microsoft Graph API to be used (default is v1). You can pass an enum named APIVersion which has 2 possible members v1 and beta, or you can pass a string as v1.0 or beta.

hook

conn_id = 'powerbi_default'

group_id

timeout = 604800

property proxies: dict | None

property api_version: str | None

execute(context)

List visible PowerBI datasets within group (Workspace).

execute_complete(context, event)

Return immediately - callback for when the trigger fires.

Relies on trigger to throw an exception, otherwise it assumes execution was successful.

Previous Next

Was this entry helpful?