Compartir a través de

Groups - Get Groups

Servicio:
Power BI REST APIs
Versión de la API:
v1.0

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

Permissions

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
Con parámetros opcionales: 
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

Devuelve un subconjunto de resultados basado en la condición de parámetro de consulta de filtro de Odata .
$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

OK

Ejemplos

Example
Get a list of workspaces using a filter example

Example

Solicitud de ejemplo

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

Respuesta de muestra

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

Solicitud de ejemplo

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

Respuesta de muestra

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

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

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

Object

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

Nombre Tipo Description
id

string (uuid)

Identificador del recurso en Power BI.
resourceGroup

string

Grupo de recursos dentro de la suscripción donde reside el recurso.
resourceName

string

El nombre del recurso.
subscriptionId

string (uuid)

La suscripción de Azure donde reside el recurso.

DefaultDatasetStorageFormat

Enumeración

Formato de almacenamiento del conjunto de datos predeterminado en el grupo

Valor Description
Small

Formato de almacenamiento de conjunto de datos pequeño
Large

Formato de almacenamiento de conjuntos de datos de gran tamaño

Group

Object

Un grupo de Power BI

Nombre Tipo Description
capacityId

string (uuid)

El identificador de capacidad
dataflowStorageId

string (uuid)

El 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. Se devuelve solo cuando isOnDedicatedCapacity es true
id

string (uuid)

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

Nombre del grupo

Groups

Object

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

Nombre Tipo Description
@odata.context

string

Contexto de OData
value

Group[]

Lista de grupos