PowerbiClient
Attributes
module-attribute
TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'GoalsAssignedTrigger': {'operation_id': 'GoalsAssignedTrigger', 'path': '/{connectionId}/internalFlowTriggerGoalChange/v1.0/myOrg/groups/{groupid}/internalScorecards({scorecardId})/goals', 'method': 'get', 'required_parameters': ['groupid', 'scorecardId', 'pollingInterval'], 'callback_payload_type': 'GoalsAssigned'}, 'GoalChangeTrigger': {'operation_id': 'GoalChangeTrigger', 'path': '/{connectionId}/internalFlowTriggerGoalChange/v1.0/myOrg/groups/{groupid}/internalScorecards({scorecardId})/goals({goalId})', 'method': 'get', 'required_parameters': ['groupid', 'scorecardId', 'goalId', 'pollingInterval'], 'callback_payload_type': 'GoalChanged'}, 'GoalStatusChangeTrigger': {'operation_id': 'GoalStatusChangeTrigger', 'path': '/{connectionId}/internalFlowTriggerGoalChange/v1.0/myOrg/groups/{groupid}/internalScorecards({scorecardId})/goals({goalId})/GetFlowTriggerStatus', 'method': 'get', 'required_parameters': ['groupid', 'scorecardId', 'goalId', 'pollingInterval'], 'callback_payload_type': 'GoalStatusChanged'}, 'GoalValueChangeTrigger': {'operation_id': 'GoalValueChangeTrigger', 'path': '/{connectionId}/internalFlowTriggerGoalChange/v1.0/myOrg/groups/{groupid}/internalScorecards({scorecardId})/goals({goalId})/GetFlowTriggerValue', 'method': 'get', 'required_parameters': ['groupid', 'scorecardId', 'goalId', 'pollingInterval'], 'callback_payload_type': 'GoalValueChanged'}, 'GoalRefreshFailedTrigger': {'operation_id': 'GoalRefreshFailedTrigger', 'path': '/{connectionId}/internalFlowTriggerGoalChange/v1.0/myOrg/groups/{groupid}/internalScorecards({scorecardId})/goals({goalId})/GetRefreshHistory', 'method': 'get', 'required_parameters': ['groupid', 'scorecardId', 'goalId', 'trackTargetSource', 'trackValueSource', 'pollingInterval'], 'callback_payload_type': 'GoalRefreshIssues'}, 'GoalValueOrNoteUpsertTrigger': {'operation_id': 'GoalValueOrNoteUpsertTrigger', 'path': '/{connectionId}/internalFlowTriggerGoalChange/v1.0/myOrg/groups/{groupid}/internalScorecards({scorecardId})/goals({goalId})/goalValues', 'method': 'get', 'required_parameters': ['groupid', 'scorecardId', 'goalId', 'pollingInterval'], 'callback_payload_type': 'GoalValueOrNoteUpserted'}, 'CheckAlertStatus': {'operation_id': 'CheckAlertStatus', 'path': '/{connectionId}/metadata/v201606/alerts/{alertId}/status', 'method': 'get', 'required_parameters': ['alertId'], 'callback_payload_type': 'EvaluatedAlert'}}
Classes
dataclass
dataclass
dataclass
dataclass
dataclass
FetchedGoal(id: str, name: str, *, owner: Optional[str] = None, start_date: Optional[str] = None, completion_date: Optional[str] = None, parent_id: Optional[str] = None, current_value: Optional[float] = None, current_value_timestamp: Optional[str] = None, target_value: Optional[float] = None, target_value_timestamp: Optional[str] = None, status: Optional[str] = None, status_timestamp: Optional[str] = None, cycle: Optional[str] = None, cycle_period: Optional[str] = None)
Response for Get a goal
Attributes
class-attribute
instance-attribute
The email address of the goal's owner.
class-attribute
instance-attribute
start_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'startDate'})
The start date for the goal. Example: 2021-07-15.
class-attribute
instance-attribute
completion_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'completionDate'})
The due date for the goal to be completed by. Example: 2021-07-29.
class-attribute
instance-attribute
parent_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'parentId'})
If this goal is a subgoal, the unique id of its parent goal.
class-attribute
instance-attribute
current_value: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'currentValue'})
The current value of the goal being tracked.
class-attribute
instance-attribute
current_value_timestamp: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'currentValueTimestamp'})
The timestamp when the current value of the goal was set.
class-attribute
instance-attribute
target_value: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'targetValue'})
The target value of the goal.
class-attribute
instance-attribute
target_value_timestamp: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'targetValueTimestamp'})
The timestamp when the target value of the goal was set.
class-attribute
instance-attribute
The status of the goal.
class-attribute
instance-attribute
status_timestamp: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'statusTimestamp'})
The timestamp when the status of the goal was set.
class-attribute
instance-attribute
Tracking cycle frequency interval shown on this goal's visuals.
dataclass
dataclass
GoalChanged(id: str, *, old_name: Optional[str] = None, old_owner: Optional[str] = None, old_start_date: Optional[str] = None, old_completion_date: Optional[str] = None, old_parent_id: Optional[str] = None, old_current_value: Optional[float] = None, old_target_value: Optional[float] = None, old_status: Optional[str] = None, old_cycle: Optional[str] = None, old_cycle_period: Optional[str] = None, new_name: Optional[str] = None, new_owner: Optional[str] = None, new_start_date: Optional[str] = None, new_completion_date: Optional[str] = None, new_parent_id: Optional[str] = None, new_current_value: Optional[float] = None, new_target_value: Optional[float] = None, new_status: Optional[str] = None, new_cycle: Optional[str] = None, new_cycle_period: Optional[str] = None, change_list: Optional[str] = None)
Response for When a goal changes
Attributes
class-attribute
instance-attribute
old_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'oldName'})
The name of the goal.
class-attribute
instance-attribute
old_owner: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'oldOwner'})
The email address of the goal's owner.
class-attribute
instance-attribute
old_start_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'oldStartDate'})
The start date for the goal. Example: 2021-07-15.
class-attribute
instance-attribute
old_completion_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'oldCompletionDate'})
The due date for the goal to be completed by. Example: 2021-07-29.
class-attribute
instance-attribute
old_parent_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'oldParentId'})
If this goal is a subgoal, the unique id of its parent goal.
class-attribute
instance-attribute
old_current_value: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'oldCurrentValue'})
The current value of the goal being tracked.
class-attribute
instance-attribute
old_target_value: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'oldTargetValue'})
The target value of the goal.
class-attribute
instance-attribute
old_status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'oldStatus'})
The status of the goal.
class-attribute
instance-attribute
old_cycle: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'oldCycle'})
Old tracking cycle frequency interval shown on this goal's visuals.
class-attribute
instance-attribute
old_cycle_period: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'oldCyclePeriod'})
Old date to find out extra properties of tracking cycle.
class-attribute
instance-attribute
new_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'newName'})
The name of the goal.
class-attribute
instance-attribute
new_owner: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'newOwner'})
The email address of the goal's owner.
class-attribute
instance-attribute
new_start_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'newStartDate'})
The start date for the goal.
class-attribute
instance-attribute
new_completion_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'newCompletionDate'})
The due date for the goal to be completed by.
class-attribute
instance-attribute
new_parent_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'newParentId'})
If this goal is a subgoal, the unique id of its parent goal.
class-attribute
instance-attribute
new_current_value: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'newCurrentValue'})
The current value of the goal being tracked.
class-attribute
instance-attribute
new_target_value: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'newTargetValue'})
The target value of the goal.
class-attribute
instance-attribute
new_status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'newStatus'})
The status of the goal.
class-attribute
instance-attribute
new_cycle: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'newCycle'})
New tracking cycle interval shown on this goal's visuals.
dataclass
dataclass
GoalValueChanged(id: str, *, old_current_value: Optional[float] = None, new_current_value: Optional[float] = None)
dataclass
dataclass
dataclass
EvaluatedAlert(*, alert_title: Optional[str] = None, alert_threshold: Optional[float] = None, is_alert_triggered: Optional[bool] = None, tile_url: Optional[str] = None, tile_value: Optional[Any] = None)
Response for When a data driven alert is triggered
Attributes
class-attribute
instance-attribute
alert_title: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'alertTitle'})
The title of the alert.
class-attribute
instance-attribute
alert_threshold: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'alertThreshold'})
The threshold at which the alert is triggered.
class-attribute
instance-attribute
is_alert_triggered: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isAlertTriggered'})
A boolean value (true, false) determining Whether or not the alert was triggered.
dataclass
dataclass
dataclass
dataclass
dataclass
GetGoalCheckinResponse(*, timestamp: Optional[str] = None, value: Optional[float] = None, status: Optional[str] = None, notes: Optional[GoalNotes] = None)
Response for Get a goal check-in
Attributes
class-attribute
instance-attribute
The date that the check-in was made.
class-attribute
instance-attribute
The value at the time of check in, if set.
dataclass
Alert(*, alert_id: Optional[str] = None, alert_title: Optional[str] = None, group_id: Optional[str] = None)
Response for Get alerts from Power BI
Attributes
class-attribute
instance-attribute
alert_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'alertId'})
The ID of the alert.
dataclass
Response for ListDatasets
dataclass
dataclass
QuerySpecification(query: str, *, serializer_settings: Optional[Dict[str, Any]] = None, impersonated_user_name: Optional[str] = None)
Definition: QuerySpecification
Attributes
dataclass
dataclass
Definition: ListedScorecard
dataclass
CreateGoalRequest(name: str, *, owner: Optional[str] = None, value: Optional[str] = None, target: Optional[str] = None, status: Optional[str] = None, start_date: Optional[str] = None, completion_date: Optional[str] = None, note: Optional[str] = None, parent_id: Optional[str] = None)
Definition: CreateGoalRequest
Attributes
class-attribute
instance-attribute
The email address of the goal's owner. Example: foo@bar.com
class-attribute
instance-attribute
The current value of the goal being tracked.
class-attribute
instance-attribute
The target value of the goal.
class-attribute
instance-attribute
The current status the goal.
class-attribute
instance-attribute
start_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'startDate'})
The start date for the goal. Example: 2021-07-15.
class-attribute
instance-attribute
completion_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'completionDate'})
The date for the goal to be completed by. Example: 2021-07-29.
class-attribute
instance-attribute
Note to attach to the initial check-in on goal creation. Can be multiline text
dataclass
UpdateGoalRequest(*, name: Optional[str] = None, owner: Optional[str] = None, value: Optional[float] = None, target: Optional[float] = None, status: Optional[str] = None, start_date: Optional[str] = None, completion_date: Optional[str] = None)
Definition: UpdateGoalRequest
Attributes
class-attribute
instance-attribute
If provided, the new name of the goal.
class-attribute
instance-attribute
If provided, the email address of the new goal owner.
class-attribute
instance-attribute
If provided, sets the new value of the goal.
class-attribute
instance-attribute
If provided, sets the new goal target.
class-attribute
instance-attribute
If provided, sets the new status of the goal.
dataclass
GoalRefreshIssue(*, connection_type: Optional[str] = None, timestamp: Optional[str] = None, message: Optional[str] = None)
Definition: GoalRefreshIssue
Attributes
class-attribute
instance-attribute
connection_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'connectionType'})
The connection type, either Current or Target.
class-attribute
instance-attribute
The timestamp of when the failed refresh happened.
dataclass
GoalValueCheckinRequest(timestamp: str, *, value: Optional[float] = None, status: Optional[str] = None, note: Optional[str] = None)
Definition: GoalValueCheckinRequest
Attributes
class-attribute
instance-attribute
Status of the goal.
dataclass
dataclass
dataclass
ExportPayloadPowerBIReport(format: str, *, power_b_i_report_export_configuration: Optional[Dict[str, Any]] = None)
Definition: ExportPayloadPowerBIReport
Attributes
instance-attribute
The export format for the Power BI report. The supported formats are: PPTX (PowerPoint), PDF, and PNG
dataclass
ExportPayloadPaginatedReport(format: str, *, paginated_report_configuration: Optional[Dict[str, Any]] = None)
Definition: ExportPayloadPaginatedReport
Attributes
instance-attribute
The export format for the paginated report. The supported formats are: PPTX (PowerPoint), PDF, ACCESSIBLEPDF (Accessible PDF), XLSX (Excel), DOCX (Word), CSV, XML, MHTML, and Image (BMP, EMF, GIF, JPEG, PNG, or TIFF).
dataclass
Definition: ExportReportSettings
Attributes
class-attribute
instance-attribute
The locale to apply
class-attribute
instance-attribute
include_hidden_pages: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'includeHiddenPages'})
A flag indicating whether to include hidden pages when exporting the entire report (when passing specific pages this property will be ignored). If not provided, the default behavior is to exclude hidden pages
dataclass
dataclass
dataclass
ExportReportPage(*, page_name: Optional[str] = None, visual_name: Optional[str] = None, bookmark: Optional[PageBookmark | Mapping[str, Any]] = None)
Definition: ExportReportPage
Attributes
class-attribute
instance-attribute
page_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageName'})
The page name
dataclass
EffectiveIdentity(username: str, *, datasets: Optional[List[str]] = None, roles: Optional[List[str]] = None, custom_data: Optional[str] = None, identity_blob: Optional[IdentityBlob | Mapping[str, Any]] = None, reports: Optional[List[str]] = None)
Definition: EffectiveIdentity
Attributes
instance-attribute
The effective username reflected by a token for applying RLS rules (For OnPrem model, username can be composed of alpha-numerical characters or any of the following characters '.', '-', '_', '!', '#', '^', '~', '\', '@', also username cannot contain spaces. For Cloud model, username can be composed of all ASCII characters. username must be up to 256 characters)
class-attribute
instance-attribute
An array of datasets for which this identity applies
class-attribute
instance-attribute
An array of RLS roles reflected by a token when applying RLS rules (identity can contain up to 50 roles, role can be composed of any character besides ',' and must be up to 50 characters)
class-attribute
instance-attribute
custom_data: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'customData'})
The value of customdata to be used for applying RLS rules. Only supported for live connections to Azure Analysis Services.
dataclass
dataclass
dataclass
Definition: PowerBiButtonClickedOutputs
PowerbiClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)
Bases: ConnectorClientBase
Typed client for powerbi connector.
Initialize a PowerbiClient.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_runtime_url
|
str
|
The connection runtime URL from Azure Portal. |
required |
credential
|
AsyncTokenCredential | AzureKeyCredential
|
Caller-owned Azure Core credential. |
required |
max_retry_attempts
|
int
|
The maximum number of request attempts. |
3
|
timeout
|
float
|
The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. |
30.0
|
use_exponential_backoff
|
bool
|
Whether retries use exponential backoff. |
True
|
initial_retry_delay_seconds
|
float
|
The initial retry delay in seconds. |
0.5
|
maximum_retry_delay_seconds
|
float
|
The maximum retry delay in seconds. |
120.0
|
retry_jitter_factor
|
float
|
The jitter fraction applied to retry delays. |
0.1
|
retry_unsafe_http_methods
|
bool
|
Whether unsafe HTTP methods may be retried. |
False
|
transport
|
Optional[AsyncHttpTransport]
|
Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle. |
None
|
**kwargs
|
Any
|
Optional Azure Core pipeline policy settings. |
{}
|
Methods:
list_scorecards(groupid: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get scorecards
Gets a list of Power BI scorecards in the specified workspace.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetScorecards.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
groupid
|
str
|
The unique identifier of the workspace. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
create_scorecard(input: CreateScorecardRequest | Mapping[str, Any], groupid: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create a scorecard
Creates a scorecard for Power BI goals.
Swagger operation ID: CreateScorecard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateScorecardRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
groupid
|
str
|
The unique identifier of the workspace. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_multiple_goals(groupid: str, scorecard_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get multiple goals
Get a list of Power BI goals in the specified scorecard.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetMultipleGoals.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
groupid
|
str
|
The unique identifier of the workspace. |
required |
scorecard_id
|
str
|
The unique identifier of the scorecard. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
create_goal(input: CreateGoalRequest | Mapping[str, Any], groupid: str, scorecard_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create a goal
Creates a Power BI goal on the specified scorecard.
Swagger operation ID: CreateGoal.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateGoalRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
groupid
|
str
|
The unique identifier of the workspace. |
required |
scorecard_id
|
str
|
The unique identifier of the scorecard. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
get_goal(groupid: str, scorecard_id: str, goal_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get a goal
Gets the specified Power BI goal on a scorecard.
Swagger operation ID: GetGoal.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
groupid
|
str
|
The unique identifier of the workspace. |
required |
scorecard_id
|
str
|
The unique identifier of the scorecard. |
required |
goal_id
|
str
|
The unique identifier of the goal. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
update_goal(input: UpdateGoalRequest | Mapping[str, Any], groupid: str, scorecard_id: str, goal_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Update a goal
Updates the Power BI goal's state.
Swagger operation ID: UpdateGoal.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateGoalRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
groupid
|
str
|
The unique identifier of the workspace. |
required |
scorecard_id
|
str
|
The unique identifier of the scorecard. |
required |
goal_id
|
str
|
The unique identifier of the goal. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
execute_dataset_query(input: QuerySpecification | Mapping[str, Any], groupid: str, datasetid: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Run a query against a dataset
Use the Power BI REST API to run a query.
Swagger operation ID: ExecuteDatasetQuery.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
QuerySpecification | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
groupid
|
str
|
The unique identifier of the workspace. |
required |
datasetid
|
str
|
The unique identifier of the dataset. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
execute_dataset_queries_json(input: ExecuteDatasetQueriesJsonInput | Mapping[str, Any], groupid: str, datasetid: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Run a json query against a dataset
Use the Power BI REST API to run a query in json format.
Swagger operation ID: ExecuteDatasetQueriesJson.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ExecuteDatasetQueriesJsonInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
groupid
|
str
|
The unique identifier of the workspace. |
required |
datasetid
|
str
|
The unique identifier of the dataset. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
add_rows(input: Payload | Mapping[str, Any], groupid: str, datasetid: str, tablename: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Add rows to a dataset
Use Power BI REST API to add rows to a dataset.
Swagger operation ID: AddRows.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
Payload | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
groupid
|
str
|
The unique identifier of the workspace. |
required |
datasetid
|
str
|
The unique identifier of the dataset. |
required |
tablename
|
str
|
The name of the table. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
goal_value_checkin_note(input: GoalValueCheckinNoteInput, groupid: str, scorecard_id: str, goal_id: str, goal_checkin: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Add a note to a check-in
Appends a new note to a check-in of a Power BI goal.
Swagger operation ID: GoalValueCheckinNote.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GoalValueCheckinNoteInput
|
The request body. |
required |
groupid
|
str
|
The unique identifier of the workspace. |
required |
scorecard_id
|
str
|
The unique identifier of the scorecard. |
required |
goal_id
|
str
|
The unique identifier of the goal. |
required |
goal_checkin
|
str
|
Example: 2021-07-21. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
goal_value_checkin(input: GoalValueCheckinRequest | Mapping[str, Any], groupid: str, scorecard_id: str, goal_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Create a check-in
Creates a Power BI goal check-in.
Swagger operation ID: GoalValueCheckin.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GoalValueCheckinRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
groupid
|
str
|
The unique identifier of the workspace. |
required |
scorecard_id
|
str
|
The unique identifier of the scorecard. |
required |
goal_id
|
str
|
The unique identifier of the goal. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_goal_checkins(groupid: str, scorecard_id: str, goal_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get goal check-ins
Get all check-ins on a Power BI goal.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetGoalCheckins.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
groupid
|
str
|
The unique identifier of the workspace. |
required |
scorecard_id
|
str
|
The unique identifier of the scorecard. |
required |
goal_id
|
str
|
The unique identifier of the goal. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
update_goal_checkin(input: GoalValueCheckinUpdateRequest | Mapping[str, Any], groupid: str, scorecard_id: str, goal_id: str, goal_checkin: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Update a check-in
Updates a Power BI goal check-in.
Swagger operation ID: UpdateGoalCheckin.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GoalValueCheckinUpdateRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
groupid
|
str
|
The unique identifier of the workspace. |
required |
scorecard_id
|
str
|
The unique identifier of the scorecard. |
required |
goal_id
|
str
|
The unique identifier of the goal. |
required |
goal_checkin
|
str
|
Example: 2021-07-21. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
get_goal_checkin(groupid: str, scorecard_id: str, goal_id: str, goal_checkin: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get a goal check-in
Get a check-in on a Power BI goal.
Swagger operation ID: GetGoalCheckin.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
groupid
|
str
|
The unique identifier of the workspace. |
required |
scorecard_id
|
str
|
The unique identifier of the scorecard. |
required |
goal_id
|
str
|
The unique identifier of the goal. |
required |
goal_checkin
|
str
|
Example: 2021-07-21. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
refresh_dataset(groupid: str, datasetid: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Refresh a dataset
Use Power BI REST API to refresh a powerbi dataset.
Swagger operation ID: RefreshDataset.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
groupid
|
str
|
The unique identifier of the workspace. |
required |
datasetid
|
str
|
The unique identifier of the dataset. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
initiate_export_to_file_for_pbi_reports(input: ExportPayloadPowerBIReport | Mapping[str, Any], groupid: str, reportid: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes
Export To File for Power BI Reports
Use Power BI Rest API to inititate export for Power BI reports
Swagger operation ID: InitiateExportToFileForPbiReports.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ExportPayloadPowerBIReport | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
groupid
|
str
|
The unique identifier of the workspace. |
required |
reportid
|
str
|
The unique identifier of a pbi report. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
bytes |
bytes
|
The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
initiate_export_to_file_for_paginated_reports(input: ExportPayloadPaginatedReport | Mapping[str, Any], groupid: str, reportid: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes
Export To File for Paginated Reports
Use Power BI Rest API to inititate export for paginated reports
Swagger operation ID: InitiateExportToFileForPaginatedReports.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ExportPayloadPaginatedReport | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
groupid
|
str
|
The unique identifier of the workspace. |
required |
reportid
|
str
|
The unique identifier of a paginated report. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
bytes |
bytes
|
The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_groups(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
ListGroups
Get Groups for Power BI.
Returns a single-page Azure Core async collection.
Swagger operation ID: ListGroups.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_alerts(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get alerts from Power BI
Return a list of alerts for a signed in user.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetAlerts.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_datasets(groupid: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
ListDatasets
Get datasets for Power BI group.
Returns a single-page Azure Core async collection.
Swagger operation ID: ListDatasets.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
groupid
|
str
|
The unique identifier of the workspace. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_tables(groupid: str, datasetid: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
ListTables
Get tables for Power BI dataset.
Returns a single-page Azure Core async collection.
Swagger operation ID: ListTables.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
groupid
|
str
|
The unique identifier of the workspace. |
required |
datasetid
|
str
|
The unique identifier of the dataset. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_reports_in_group(groupid: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get Reports in Group
Returns a list of reports from the specified workspace.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetReportsInGroup.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
groupid
|
str
|
The unique identifier of the workspace. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
get_columns(groupid: str, datasetid: str, tablename: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
GetColumns
Get columns for Power BI dataset table.
Swagger operation ID: GetColumns.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
groupid
|
str
|
The unique identifier of the workspace. |
required |
datasetid
|
str
|
The unique identifier of the dataset. |
required |
tablename
|
str
|
The name of the table. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |