Partager via

Groups - Get Groups

Service:
Power BI REST APIs
Version d'API:
v1.0

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

Permissions

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 pour être mis à jour et peuvent ne pas être immédiatement disponibles lors de l’utilisation d’appels d’API. Pour actualiser les autorisations utilisateur, utilisez l’appel de l’API Actualiser les autorisations utilisateur . 

GET https://api.powerbi.com/v1.0/myorg/groups
Avec des paramètres facultatifs: 
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

Retourne un sous-ensemble de résultats en fonction de la condition de paramètre de requête de filtre Odata .
$skip
 query

integer (int32)

Ignore les premiers n résultats
$top
 query

integer (int32)

Retourne uniquement les premiers n résultats

Réponses

Nom Type Description
200 OK

Groups

Ok

Exemples

Example
Get a list of workspaces using a filter example

Example

Exemple de requête

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

Exemple de réponse

Code d’état:
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

Exemple de requête

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

Exemple de réponse

Code d’état:
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

Object

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

Nom Type Description
id

string (uuid)

Identificateur de la ressource dans Power BI.
resourceGroup

string

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

string

Nom de la ressource.
subscriptionId

string (uuid)

Abonnement Azure où réside la ressource.

DefaultDatasetStorageFormat

Énumération

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

Valeur Description
Small

Format de stockage de petits jeux de données
Large

Format de stockage de jeux de données volumineux

Group

Object

Un groupe Power BI

Nom Type Description
capacityId

string (uuid)

ID de capacité
dataflowStorageId

string (uuid)

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

DefaultDatasetStorageFormat

Format de stockage de jeu de données par défaut dans l’espace de travail. Retourné uniquement lorsqu’il isOnDedicatedCapacity s’agit de true
id

string (uuid)

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 opération est retournée uniquement lors de la récupération d’un seul groupe.
name

string

Nom du groupe

Groups

Object

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