workspaces
Creates, updates, deletes, gets or lists a workspaces resource.
Overview
| Name | workspaces |
| Type | Resource |
| Id | azure.powerbi_embedded.workspaces |
Fields
The following fields are returned by SELECT queries:
- list
Get workspaces completed successfully
| Name | Datatype | Description |
|---|---|---|
id | string | Workspace id |
name | string | Workspace name |
properties | object | Property bag |
type | string | Resource type |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | subscriptionId, resourceGroupName, workspaceCollectionName | Retrieves all existing Power BI workspaces in the specified workspace collection. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
resourceGroupName | string | Azure resource group |
subscriptionId | string | Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
workspaceCollectionName | string | Power BI Embedded Workspace Collection name |
SELECT examples
- list
Retrieves all existing Power BI workspaces in the specified workspace collection.
SELECT
id,
name,
properties,
type
FROM azure.powerbi_embedded.workspaces
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceCollectionName = '{{ workspaceCollectionName }}' -- required
;