The PBIEmbedConfig type is used hold information about a power bi dashboard so it can be embedded in the UX that can be passed between the UX and APIs.
Below are the properties and their purpose.
- string AccessToken
- Default Value: Empty string.
- Intended Value: The token used to access the power bi workspace.
- DateTimeOffset AccessTokenExpiry
- Default Value: Minimum DateTime with a zero offset.
- Intended Value: The date and time that the access token will expire.
- string DataSetId
- Default Value: Empty string.
- Intended Value: The ID for the dashboards dataset.
- Guid ReportId
- Default Value: Empty Guid.
- Intended Value: The guid of the dashboard.
- Guid WorkspaceId
- Default Value: Empty Guid.
- Intended Value: The guid of the power bi workspace the dashboard is in.
- string EmbedUrl
- Default Value: Empty string.
- Intended Value: The URL used to embed the dashboard.
- Guid UserGUID
- Default Value: Empty Guid.
- Intended Value: The guid of the current user.
- EmbedToken EmbedToken
- Default Value: Empty EmbedToken.
- Intended Value: The token to authorize the embed in the clients browser.
- int MinutesToExpiration
- Default Value: The number of minutes remaining until the authorization tokens are invalid.
- Intended Value: Currently not being used.
- bool? IsEffectiveIdentityRolesRequired
- Default Value: null.
- Intended Value: Currently not being used.
- bool? IsEffectiveIdentityRequired
- Default Value: null.
- Intended Value: Currently not being used.
- bool EnableRLS
- Default Value: false.
- Intended Value: Currently not being used.
- string Username
- Default Value: Empty string.
- Intended Value: Currently not being used.
- string Roles
- Default Value: Empty string.
- Intended Value: Currently not being used.
- string ErrorMessage
- Default Value: Empty string.
- Intended Value: Contains an error message if something failed in the API so it can be properly handled in the UX.
- DateTime? LastRefreshStartDate
- Default Value: Minimum datetime value.
- Intended Value: Contains the start date and time of the latest refresh attempt of the dataset.
- DateTime? LastRefreshEndDate
- Default Value: Minimum datetime value.
- Intended Value: Contains the end date and time of the latest refresh attempt of the dataset.
- string LastRefreshStatus
- Default Value: Empty string.
- Intended Value: Contains the status of the latest refresh attempt.
- int NumberOfRecentRefreshes
- Default Value: 0.
- Intended Value: The number of attempted refreshes of the dataset in the past 24 hours.
