Groups - Get Groups

Service:

Power BI REST APIs

API Version:

v1.0

Devuelve una lista de áreas de trabajo a las que tiene acceso el usuario.

Permisos

Un perfil de entidad de servicio puede llamar a esta llamada API. Para obtener más información, consulte: Perfiles de entidad de servicio en Power BI Embedded.

Ámbito requerido

Workspace.Read.All o Workspace.ReadWrite.All

Limitaciones

• Los permisos de usuario para las áreas de trabajo tardan tiempo en actualizarse y es posible que no estén disponibles inmediatamente al usar llamadas API. Para actualizar los permisos de usuario, use la llamada API Actualizar permisos de usuario .
  
  

GET https://api.powerbi.com/v1.0/myorg/groups

With optional parameters:

GET https://api.powerbi.com/v1.0/myorg/groups?$filter={$filter}&$top={$top}&$skip={$skip}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
$filter	query		string	Filtra los resultados, en función de una condición booleana.
$skip	query		integer int32	Omite los primeros n resultados
$top	query		integer int32	Devuelve solo los primeros n resultados.

Respuestas

Nombre	Tipo	Description
200 OK	Groups	Aceptar

Ejemplos

Example

Get a list of workspaces using a filter example

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "sample group"
    },
    {
      "id": "3d9b93c6-7b6d-4801-a491-1738910904fd",
      "isReadOnly": false,
      "isOnDedicatedCapacity": true,
      "capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "defaultDatasetStorageFormat": "Small",
      "name": "marketing group"
    },
    {
      "id": "a2f89923-421a-464e-bf4c-25eab39bb09f",
      "isReadOnly": false,
      "isOnDedicatedCapacity": true,
      "capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "defaultDatasetStorageFormat": "Large",
      "name": "contoso",
      "dataflowStorageId": "d692ae06-708c-485e-9987-06ff0fbdbb1f"
    }
  ]
}

Get a list of workspaces using a filter example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups?$filter=contains(name,'marketing')%20or%20name%20eq%20'contoso'

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "3d9b93c6-7b6d-4801-a491-1738910904fd",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "marketing group"
    },
    {
      "id": "a2f89923-421a-464e-bf4c-25eab39bb09f",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "contoso",
      "dataflowStorageId": "d692ae06-708c-485e-9987-06ff0fbdbb1f"
    }
  ]
}

Definiciones

Nombre	Description
AzureResource	Respuesta que detalla un recurso de Azure propiedad del usuario, como un área de trabajo de Log Analytics.
DefaultDatasetStorageFormat	El formato de almacenamiento del conjunto de datos predeterminado en el grupo
Group	Un grupo de Power BI
Groups	Contenedor de respuesta de OData para una lista de grupos de Power BI

AzureResource

Respuesta que detalla un recurso de Azure propiedad del usuario, como un área de trabajo de Log Analytics.

Nombre	Tipo	Description
id	string	Identificador del recurso en Power BI.
resourceGroup	string	El grupo de recursos dentro de la suscripción donde reside el recurso.
resourceName	string	Nombre del recurso.
subscriptionId	string	La suscripción de Azure donde reside el recurso.

DefaultDatasetStorageFormat

El formato de almacenamiento del conjunto de datos predeterminado en el grupo

Nombre	Tipo	Description
Large	string	Formato de almacenamiento de conjunto de datos de gran tamaño
Small	string	Formato de almacenamiento de conjunto de datos pequeño

Group

Un grupo de Power BI

Nombre	Tipo	Description
capacityId	string	Identificador de capacidad
dataflowStorageId	string	Identificador de la cuenta de almacenamiento de flujo de datos de Power BI
defaultDatasetStorageFormat	DefaultDatasetStorageFormat	Formato de almacenamiento del conjunto de datos predeterminado en el área de trabajo. Solo se devuelve cuando isOnDedicatedCapacity es true
id	string	Identificador del área de trabajo
isOnDedicatedCapacity	boolean	Si el grupo está asignado a una capacidad dedicada
isReadOnly	boolean	Si el grupo es de solo lectura
logAnalyticsWorkspace	AzureResource	Área de trabajo de Log Analytics asignada al grupo. Solo se devuelve cuando se recupera un único grupo.
name	string	El nombre del grupo

Groups

Contenedor de respuesta de OData para una lista de grupos de Power BI

Nombre	Tipo	Description
odata.context	string	Contexto de OData
value	Group[]	La lista de grupos