Azure Powerbiembedded
Azure Power BI Embedded is a Microsoft Azure service for embedding Power BI reports and dashboards into custom applications.
- Base URL:
https://management.azure.com - Auth:
bearer(pass your key via theapiKeyinput)
Operations
getavailableoperations— GET /providers/Microsoft.PowerBI/operations — Indicates which operations can be performed by the Power BI Resource Provider.workspacecollections_listbysubscription— GET /subscriptions/{subscriptionId}/providers/Microsoft.PowerBI/workspaceCollections — Retrieves all existing Power BI workspace collections in the specified subscriptworkspacecollections_listbyresourcegroup— GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections — Retrieves all existing Power BI workspace collections in the specified resourceworkspacecollections_getbyname— GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName} — Retrieves an existing Power BI Workspace Collection.workspaces_list— GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}/workspaces — Retrieves all existing Power BI workspaces in the specified workspace collectionworkspacecollections_checknameavailability— POST /subscriptions/{subscriptionId}/providers/Microsoft.PowerBI/locations/{location}/checkNameAvailability — Verify the specified Power BI Workspace Collection name is valid and not already
Inputs
apiKey— your azure-powerbiembedded API keyoperation— one of the operations above- path parameters when an operation's path contains
{...} query— optional JSON object of query paramsbody— JSON object for create/update ops
Example
operation: getavailableoperations
apiKey: <your key>
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
erroroperationresultstatus
Input Properties
Every property this tool accepts, from its own tool.iml.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
apiKey |
string | yes | — | DEPRECATED — bind an API Key credential to the task with credentialName instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change. |
operation |
string | yes | — | One of: getavailableoperations, workspacecollections_listbysubscription, workspacecollections_listbyresourcegroup, workspacecollections_getbyname, workspaces_list, workspacecollections_checknameavailability |
location |
string | no | — | Path parameter location (required by some operations). |
resourceGroupName |
string | no | — | Path parameter resourceGroupName (required by some operations). |
subscriptionId |
string | no | — | Path parameter subscriptionId (required by some operations). |
workspaceCollectionName |
string | no | — | Path parameter workspaceCollectionName (required by some operations). |
body |
string | no | — | Request body as a JSON object string (for create/update operations). |
query |
string | no | — | Query-string parameters as a JSON object string, e.g. {"limit": 50}. Parsed and url-encoded onto the request. |