Microsoft Power BI - Trigger Refresh

info

This Blueprint is classified as "Free" and does not incur billable runtime. Learn more.

Overview

Shipyard's low-code Microsoft Power BI Trigger Refresh blueprint allows users to refresh a dataset or a dataflow on a Microsoft Power BI workspace. The dataset or dataflow must be located in a workspace that the service principal account has access to and cannot be "My Workspace".

Microsoft limits the number of dataflow refreshes that can be triggered to 8 within 24 hours. If you are using this blueprint to refresh a dataflow, please ensure that you are not exceeding this limit.

Variables

Name	Reference	Type	Required	Default	Options	Description
Client ID	MICROSOFT_POWER_BI_CLIENT_ID	Alphanumeric	✅	-	-	The Client ID of the service principal account
Client Secret	MICROSOFT_POWER_BI_CLIENT_SECRET	Password	✅	-	-	The client secret value for the service principal account
Tenant ID	MICROSOFT_POWER_BI_TENANT_ID	Alphanumeric	✅	-	-	The tenant ID that can be retrieved from Azure directory when creating the service principal account.
Workspace ID	MICROSOFT_POWER_BI_GROUP_ID	Alphanumeric	✅	-	-	The workspace/group ID where the dataset/dataflow is located
Refresh Object Type	MICROSOFT_POWER_BI_OBJECT_TYPE	Select	✅	dataset	Dataset: dataset Dataflow: dataflow	The object type you wish to be refreshed
Object ID	MICROSOFT_POWER_BI_OBJECT_ID	Alphanumeric	✅	-	-	The dataset ID or dataflow ID you wish to refresh.
Wait For Completion	MICROSOFT_POWER_BI_WAIT_FOR_COMPLETION	Boolean	✅	TRUE	-	Whether the blueprint should wait for the refresh to finish. It is recommended to set this to TRUE.

YAML

Below is the YAML template for this Blueprint and can be used in the Fleet YAML Editor.

source:
    blueprint: Microsoft Power BI - Trigger Refresh
    inputs:
        MICROSOFT_POWER_BI_CLIENT_ID: null  ## REQUIRED
        MICROSOFT_POWER_BI_CLIENT_SECRET: null ## REQUIRED
        MICROSOFT_POWER_BI_TENANT_ID: null ## REQUIRED
        MICROSOFT_POWER_BI_GROUP_ID: null ## REQUIRED
        MICROSOFT_POWER_BI_OBJECT_TYPE: dataset ## REQUIRED
        MICROSOFT_POWER_BI_OBJECT_ID: null ## REQUIRED
        MICROSOFT_POWER_BI_WAIT_FOR_COMPLETION: 'TRUE' ## REQUIRED
    type: BLUEPRINT
guardrails:
    retry_count: 1
    retry_wait: 0h0m0s
    runtime_cutoff: 1h0m0s
    exclude_exit_code_ranges:
    -   101
    -   201
    -   202
    -   206