Groups - Get Groups

  • Référence
Service:
Power BI REST APIs
API Version:
v1.0

Retourne une liste d’espaces de travail à laquelle l’utilisateur a accès.

Autorisations

Cet appel d’API peut être appelé par un profil de principal de service. Pour plus d’informations, consultez Profils de principal de service dans Power BI Embedded.

Étendue requise

Workspace.Read.All ou Workspace.ReadWrite.All

Limites

  • Les autorisations utilisateur pour les espaces de travail prennent du temps à être mises à jour et peuvent ne pas être immédiatement disponibles lors de l’utilisation des appels d’API. Pour actualiser les autorisations utilisateur, utilisez l’appel d’API Actualiser les autorisations utilisateur . 

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}

Paramètres URI

Nom Dans Obligatoire Type Description
$filter
 query

string

Filtre les résultats, en fonction d’une condition booléenne
$skip
 query

integer

int32

Ignore les n premiers résultats
$top
 query

integer

int32

Retourne uniquement les n premiers résultats

Réponses

Nom Type Description
200 OK

Groups

OK

Exemples

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"
    }
  ]
}

Définitions

Nom Description
AzureResource

Réponse détaillant une ressource Azure appartenant à l’utilisateur, telle qu’un espace de travail Log Analytics.
DefaultDatasetStorageFormat

Format de stockage du jeu de données par défaut dans le groupe
Group

Un groupe Power BI
Groups

Wrapper de réponse OData pour une liste de groupes Power BI

AzureResource

Réponse détaillant une ressource Azure appartenant à l’utilisateur, telle qu’un espace de travail Log Analytics.

Nom Type Description
id

string

Identificateur de la ressource dans Power BI.
resourceGroup

string

Groupe de ressources au sein de l’abonnement où réside la ressource.
resourceName

string

Nom de la ressource.
subscriptionId

string

Abonnement Azure où réside la ressource.

DefaultDatasetStorageFormat

Format de stockage du jeu de données par défaut dans le groupe

Nom Type Description
Large

string

Format de stockage des grands jeux de données
Small

string

Format de stockage de petits jeux de données

Group

Un groupe Power BI

Nom Type Description
capacityId

string

ID de capacité
dataflowStorageId

string

ID de compte de stockage de flux de données Power BI
defaultDatasetStorageFormat

DefaultDatasetStorageFormat

Format de stockage du jeu de données par défaut dans l’espace de travail. Retourné uniquement lorsque isOnDedicatedCapacity est true
id

string

L’ID de l’espace de travail
isOnDedicatedCapacity

boolean

Indique si le groupe est affecté à une capacité dédiée
isReadOnly

boolean

Indique si le groupe est en lecture seule
logAnalyticsWorkspace

AzureResource

Espace de travail Log Analytics affecté au groupe. Cette valeur est retournée uniquement lors de la récupération d’un seul groupe.
name

string

Nom du groupe

Groups

Wrapper de réponse OData pour une liste de groupes Power BI

Nom Type Description
odata.context

string

Contexte OData
value

Group[]

Liste des groupes