Power BI RefreshGroupDataset

Power BI RefreshGroupDataset

Certified

Refresh a Power BI dataset

Starts an asynchronous refresh for a dataset in a workspace. Optionally waits for completion, polling every 5 seconds by default until completion or a 10-minute timeout. Requires a service principal with refresh permissions on the target workspace and dataset.

yaml
type: io.kestra.plugin.powerbi.RefreshGroupDataset

Refresh a workspace dataset

yaml
id: refresh-powerbi-dataset
namespace: company.team

tasks:
  - id: refresh_sales_model
    type: io.kestra.plugin.powerbi.RefreshGroupDataset
    tenantId: "{{ secret('AZURE_TENANT_ID') }}"
    clientId: "{{ secret('AZURE_CLIENT_ID') }}"
    clientSecret: "{{ secret('AZURE_CLIENT_SECRET') }}"
    groupId: "9f1c2b8c-12ab-4f3e-9bcd-0af2c5e6d123"
    datasetId: "5c8b4a1e-7f89-4c33-9dd8-1f23c4567890"
    wait: true
    pollDuration: "PT5S"
    waitDuration: "PT10M"
Properties
Min length1

Azure client ID

Min length1

Azure client secret

Min length1

Azure tenant ID

Dataset ID

GUID of the dataset to refresh.

Workspace (group) ID

GUID of the workspace containing the dataset.

The http client configuration

Definitions
allowFailedbooleanstring
Defaultfalse

If true, allow a failed response code (response code >= 400)

allowedResponseCodesarray
SubTypeinteger

List of response code allowed for this request

auth

The authentication to use.

type*Requiredobject
passwordstring

The password for HTTP basic authentication.

usernamestring

The username for HTTP basic authentication.

type*Requiredobject
tokenstring

The token for bearer token authentication.

type*Requiredobject
passwordstring

The password for HTTP Digest authentication.

usernamestring

The username for HTTP Digest authentication.

basicAuthPasswordDeprecatedstring

The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.

basicAuthUserDeprecatedstring

The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.

connectTimeoutDeprecatedstring
Formatduration

The time allowed to establish a connection to the server before failing.

connectionPoolIdleTimeoutDeprecatedstring
Formatduration

The time an idle connection can remain in the client's connection pool before being closed.

defaultCharsetstring
DefaultUTF-8

The default charset for the request.

enabledTcpExtendedKeepAlivebooleanstring
Defaulttrue

Whether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).

Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.

followRedirectsbooleanstring
Defaulttrue

Whether redirects should be followed automatically.

logLevelDeprecatedstring
Possible Values
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIED

The log level for the HTTP client.

logsarray
SubTypestring
Possible Values
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODY

The enabled log.

maxContentLengthDeprecatedinteger

The maximum content length of the response.

proxy

The proxy configuration.

addressstring

The address of the proxy server.

passwordstring

The password for proxy authentication.

portintegerstring

The port of the proxy server.

typestring
DefaultDIRECT
Possible Values
DIRECTHTTPSOCKS

The type of proxy to use.

usernamestring

The username for proxy authentication.

proxyAddressDeprecatedstring

The address of the proxy server.

proxyPasswordDeprecatedstring

The password for proxy authentication.

proxyPortDeprecatedinteger

The port of the proxy server.

proxyTypeDeprecatedstring
Possible Values
DIRECTHTTPSOCKS

The type of proxy to use.

proxyUsernameDeprecatedstring

The username for proxy authentication.

readIdleTimeoutDeprecatedstring
Formatduration

The time allowed for a read connection to remain idle before closing it.

readTimeoutDeprecatedstring
Formatduration

The maximum time allowed for reading data from the server before failing.

ssl

The SSL request options

insecureTrustAllCertificatesbooleanstring

Whether to disable checking of the remote SSL certificate.

Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.

timeout

The timeout configuration.

connectTimeoutstring

The time allowed to establish a connection to the server before failing.

readIdleTimeoutstring
DefaultPT5M

The time allowed for a read connection to remain idle before closing it.

Reference (ref) of the pluginDefaults to apply to this task.

DefaultPT5S

Polling interval

Delay between status checks when wait is true; defaults to 5 seconds.

Defaultfalse

Wait for refresh completion

Defaults to false. When true, polls the refresh status and fails if the final status is not Completed.

DefaultPT10M

Refresh wait timeout

Maximum time to wait for completion when wait is true; defaults to 10 minutes.

Formatdate-time

Refresh end time

Returned only when wait is true.

Refresh extended status

Returned only when wait is true.

Refresh type

Returned only when wait is true.

Refresh request ID

Always returned, even when wait is false.

Formatdate-time

Refresh start time

Returned only when wait is true.

Refresh status

Returned only when wait is true; task fails if the final status is not Completed.

More Plugins in this Category

Liquibase
Liquibase

Tasks that run Liquibase change management commands.

Data

2 tasks

PostgreSQL
PostgreSQL

Tasks that connect to PostgreSQL via JDBC to run queries and loads.

Data

6 tasks

25 blueprints