We are thrilled to announce the release of Power BI APIs .NET SDK v4!
The new SDK version provides clarity on the properties of Power BI artifacts returned by various APIs and makes it easier to understand which properties are returned by each API.
The new version has some minor breaking changes which can be easily fixed by renaming some types, as explained later in this post.
The Power BI APIs .NET SDK is released as Microsoft.PowerBI.Api NuGet package and wraps the Power BI REST APIs.
The SDK is also available on Github.
What you should know about v4
The main change introduced in the new SDK version 4 is that classes representing Power BI artifacts are now split into multiple classes, depending on the category of the API that returned them.
In v4, each object contains only the subset of properties returned by each API category.
As some classes were renamed in the new version and some properties do not exist in the new classes, the version does have some breaking changes. These changes are minor and can mostly be fixed by type renaming or by modifying the arguments passed to the constructors.
Below is a detailed list of the changes in v4:
The objects Report, Dashboard, Dataset, Tile, and Dataflow were split into 3 classes each:
- An object returned by the User APIs with the object’s name.
- An object returned by the Admin APIs with the prefix “Admin” and the object’s name.
- An object retuned by the Scanner API with the prefix “WorkspaceInfo” and the object’s name.
For example:
- The return type for GetReport is Report
- The return type for GetReportAsAdmin is AdminReport
- GetScanResult is WorkspaceInfoResponse which contains a collection of WorkspaceInfoReport
The Pipeline object was split into 2 classes:
- An object return by the User APIs with the object’s name (Pipeline)
- An object returned by the Admin APIs with the prefix “Admin” and the object’s name (Pipeline).
The Group object was split into 3 classes:
- An object returned by the User APIs with the object’s name (Group).
- An object returned by the Admin APIs with the prefix “Admin” and the object’s name (Group)
- An object returned by GetRefreshable with the prefix “Refreshable”.
That’s all for this post, we hope you found it useful.
We recommend that you start adopting Power BI APIs .NET SDK version 4 as soon as you can to enjoy these changes.
As always, we’re happy to hear from you. Please share your feedback with us and let us know if you have any questions.
You can also read more in the links below: