Groups - Create Group
Creates a new workspace.
Permissions
This API call can be called by a service principal profile. For more information see: Service principal profiles in Power BI Embedded.
Required Scope
Workspace.ReadWrite.All
POST https://api.powerbi.com/v1.0/myorg/groups
POST https://api.powerbi.com/v1.0/myorg/groups?workspaceV2={workspaceV2}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
workspaceV2
|
query |
boolean |
(Preview feature) Whether to create a workspace. The only supported value is |
Request Body
Name | Required | Type | Description |
---|---|---|---|
name | True |
string |
The name of the newly created group |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
Examples
Create a workspace example |
Example |
Create a workspace example
Sample request
POST https://api.powerbi.com/v1.0/myorg/groups?workspaceV2=True
{
"name": "sample workspace"
}
Sample response
{
"value": [
{
"id": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"isOnDedicatedCapacity": false,
"name": "sample workspace"
}
]
}
Example
Sample request
POST https://api.powerbi.com/v1.0/myorg/groups
{
"name": "sample group"
}
Sample response
{
"value": [
{
"id": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"isReadOnly": false,
"isOnDedicatedCapacity": false,
"name": "sample group"
}
]
}
Definitions
Name | Description |
---|---|
Azure |
A response detailing a user-owned Azure resource such as a Log Analytics workspace. |
Default |
The default dataset storage format in the group |
Group |
A Power BI group |
Group |
A Power BI request to create a new group |
AzureResource
A response detailing a user-owned Azure resource such as a Log Analytics workspace.
Name | Type | Description |
---|---|---|
id |
string |
An identifier for the resource within Power BI. |
resourceGroup |
string |
The resource group within the subscription where the resource resides. |
resourceName |
string |
The name of the resource. |
subscriptionId |
string |
The Azure subscription where the resource resides. |
DefaultDatasetStorageFormat
The default dataset storage format in the group
Name | Type | Description |
---|---|---|
Large |
string |
Large dataset storage format |
Small |
string |
Small dataset storage format |
Group
A Power BI group
Name | Type | Description |
---|---|---|
capacityId |
string |
The capacity ID |
dataflowStorageId |
string |
The Power BI dataflow storage account ID |
defaultDatasetStorageFormat |
The default dataset storage format in the workspace. Returned only when |
|
id |
string |
The workspace ID |
isOnDedicatedCapacity |
boolean |
Whether the group is assigned to a dedicated capacity |
isReadOnly |
boolean |
Whether the group is read-only |
logAnalyticsWorkspace |
The Log Analytics workspace assigned to the group. This is returned only when retrieving a single group. |
|
name |
string |
The group name |
GroupCreationRequest
A Power BI request to create a new group
Name | Type | Description |
---|---|---|
name |
string |
The name of the newly created group |