Skip to main content

workspaces

Creates, updates, deletes, gets or lists a workspaces resource.

Overview

Nameworkspaces
TypeResource
Idazure.powerbi_embedded.workspaces

Fields

The following fields are returned by SELECT queries:

Get workspaces completed successfully

NameDatatypeDescription
idstringWorkspace id
namestringWorkspace name
propertiesobjectProperty bag
typestringResource type

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectsubscriptionId, resourceGroupName, workspaceCollectionNameRetrieves 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.

NameDatatypeDescription
resourceGroupNamestringAzure resource group
subscriptionIdstringGets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
workspaceCollectionNamestringPower BI Embedded Workspace Collection name

SELECT examples

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
;