Admin - Groups GetGroupsAsAdmin

Référence

Service:: Power BI REST APIs

Version d'API:: v1.0

Retourne une liste d’espaces de travail pour l’organisation.

Autorisations

L’utilisateur doit être un administrateur Fabric ou s’authentifier à l’aide d’un principal de service.
Les autorisations déléguées sont prises en charge.

Lors de l’exécution sous l’authentification prinicipal du service, une application ne doit pas disposer de prémissions requises par l’administrateur pour Power BI définies sur celui-ci dans le portail Azure.

Étendue requise

Tenant.Read.All ou Tenant.ReadWrite.All

Applicable uniquement lors de l’authentification via un jeton d’accès administrateur délégué standard. Ne doit pas être présent lorsque l’authentification via un principal de service est utilisée.

Limitations

Maximum 50 requêtes par heure ou 15 requêtes par minute, par locataire. Cet appel expirera également après 30 secondes pour empêcher les effets néfastes sur le service Power BI.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
$top	query	True	integer int32	Retourne uniquement les n premiers résultats. Ce paramètre est obligatoire et doit être dans la plage de 1 à 5 000.
$expand	query		string	Accepte une liste séparée par des virgules de types de données, qui sera développée inline dans la réponse. Prend en charge `users`, `reports`, `dashboards`, `datasets`, `dataflows`et `workbooks`.
$filter	query		string	Retourne un sous-ensemble de résultats basés sur condition de paramètre de requête de filtre Odata.
$skip	query		integer int32	Ignore les premiers n résultats. Utilisez avec le haut pour extraire les résultats au-delà des 5 000 premiers.

Réponses

Nom	Type	Description
200 OK	AdminGroups	D’ACCORD

Exemples

Get deleted workspaces example.

Get orphaned workspaces example.

Get workspaces with their 'dashboards' expanded example

Get workspaces with their 'datasets' expanded example

Get workspaces with their 'datasets' expanded example.

Get workspaces with their 'reports' expanded example

Get workspaces with their 'users' expanded example.

Get workspaces with their 'workbooks' expanded example

Get deleted workspaces example.

Exemple de requête

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$filter=state eq 'Deleted'&$top=100

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "Sample Group 2",
      "description": "Deleted sample group",
      "type": "Workspace",
      "state": "Deleted"
    }
  ]
}

Get orphaned workspaces example.

Exemple de requête

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=users&$filter=(not users/any()) or (not users/any(u: u/groupUserAccessRight eq Microsoft.PowerBI.ServiceContracts.Api.GroupUserAccessRight'Admin'))&$top=100

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "id": "d5caa808-8c91-400a-911d-06af08dbcc31",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "Orphaned Group",
      "description": "Sample orphan group",
      "type": "Workspace",
      "state": "Active",
      "hasWorkspaceLevelSettings": false,
      "users": []
    }
  ]
}

Get workspaces with their 'dashboards' expanded example

Exemple de requête

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=dashboards&$top=100

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "id": "94E57E92-CEE2-486D-8CC8-218C97200579",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "capacityMigrationStatus": "Migrated",
      "description": "shorter description",
      "type": "Workspace",
      "state": "Removing",
      "name": "a",
      "hasWorkspaceLevelSettings": false,
      "dashboards": [
        {
          "id": "4668133c-ae3f-42fb-ad7c-214a8623280c",
          "displayName": "SQlAzure-Refresh.pbix",
          "isReadOnly": false
        },
        {
          "id": "a8f18ca7-63e8-4220-bc1c-f576ec180b98",
          "displayName": "cdvc",
          "isReadOnly": false
        }
      ]
    }
  ]
}

Get workspaces with their 'datasets' expanded example

Exemple de requête

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=datasets&$top=100

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "id": "94E57E92-CEE2-486D-8CC8-218C97200579",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "capacityMigrationStatus": "Migrated",
      "description": "shorter description",
      "type": "Workspace",
      "state": "Removing",
      "name": "a",
      "hasWorkspaceLevelSettings": false,
      "datasets": [
        {
          "id": "8ce96c50-85a0-4db3-85c6-7ccc3ed46523",
          "name": "SQlAzure-Refresh",
          "addRowsAPIEnabled": false,
          "configuredBy": "admin@granularcontrols.ccsctp.net",
          "isRefreshable": true,
          "isEffectiveIdentityRequired": false,
          "isEffectiveIdentityRolesRequired": false,
          "isOnPremGatewayRequired": false,
          "targetStorageMode": "Abf",
          "createdDate": "2019-04-30T21:35:15.867-07:00",
          "ContentProviderType": "PbixInImportMode",
          "isInPlaceSharingEnabled": false
        },
        {
          "id": "7d6a4f72-1906-4e08-a469-bd6bc1ab7b69",
          "name": "NESGames",
          "addRowsAPIEnabled": false,
          "configuredBy": "admin@granularcontrols.ccsctp.net",
          "isRefreshable": true,
          "isEffectiveIdentityRequired": false,
          "isEffectiveIdentityRolesRequired": false,
          "isOnPremGatewayRequired": false,
          "targetStorageMode": "Abf",
          "createdDate": "2019-04-30T21:35:15.867-07:00",
          "ContentProviderType": "PbixInImportMode",
          "isInPlaceSharingEnabled": false
        }
      ]
    }
  ]
}

Get workspaces with their 'datasets' expanded example.

Exemple de requête

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=datasets

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "id": "e380d1d0-1fa6-460b-9a90-1a5c6b02414c",
      "isReadOnly": false,
      "isOnDedicatedCapacity": true,
      "capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "defaultDatasetStorageFormat": "Small",
      "name": "Sample Group 1",
      "description": "Sample group",
      "type": "Workspace",
      "state": "Active",
      "hasWorkspaceLevelSettings": true,
      "datasets": [
        {
          "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
          "name": "SalesMarketing",
          "addRowsAPIEnabled": false,
          "configuredBy": "john@contoso.com",
          "isRefreshable": true,
          "isEffectiveIdentityRequired": false,
          "isEffectiveIdentityRolesRequired": false,
          "isOnPremGatewayRequired": false,
          "isInPlaceSharingEnabled": false,
          "encryption": {
            "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
            "encryptionStatus": "InSyncWithWorkspace"
          }
        }
      ]
    },
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "Sample Group 2",
      "description": "Deleted sample group",
      "type": "Workspace",
      "state": "Deleted",
      "datasets": []
    }
  ]
}

Get workspaces with their 'reports' expanded example

Exemple de requête

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=reports&$top=100

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "id": "EC1EE11F-845D-495E-82A3-9DAC2072305A",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "capacityMigrationStatus": "Migrated",
      "description": "cvcv",
      "type": "Workspace",
      "state": "Active",
      "name": "WSv2Test12",
      "hasWorkspaceLevelSettings": true,
      "reports": []
    },
    {
      "id": "94E57E92-CEE2-486D-8CC8-218C97200579",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "capacityMigrationStatus": "Migrated",
      "description": "shorter description",
      "type": "Workspace",
      "state": "Removing",
      "name": "a",
      "hasWorkspaceLevelSettings": false,
      "reports": [
        {
          "id": "5DBA60B0-D9A7-42AE-B12C-6D9D51E7739A",
          "reportType": "PowerBIReport",
          "name": "SQlAzure-Refresh",
          "datasetId": "8ce96c50-85a0-4db3-85c6-7ccc3ed46523"
        },
        {
          "id": "197E5C3C-D2F3-42D8-A536-875FB6D7D48C",
          "reportType": "PowerBIReport",
          "name": "NESGames",
          "datasetId": "7d6a4f72-1906-4e08-a469-bd6bc1ab7b69"
        }
      ]
    }
  ]
}

Get workspaces with their 'users' expanded example.

Exemple de requête

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=users&$top=100

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "id": "e380d1d0-1fa6-460b-9a90-1a5c6b02414c",
      "isReadOnly": false,
      "isOnDedicatedCapacity": true,
      "capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "defaultDatasetStorageFormat": "Small",
      "name": "Sample Group 1",
      "description": "Sample group",
      "type": "Workspace",
      "state": "Active",
      "hasWorkspaceLevelSettings": false,
      "users": [
        {
          "emailAddress": "john@contoso.com",
          "groupUserAccessRight": "Admin"
        }
      ]
    },
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "Sample Group 2",
      "description": "Deleted sample group",
      "type": "Workspace",
      "state": "Deleted",
      "users": []
    }
  ]
}

Get workspaces with their 'workbooks' expanded example

Exemple de requête

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=workbooks&$top=100

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "id": "94E57E92-CEE2-486D-8CC8-218C97200579",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "description": "shorter description",
      "type": "Workspace",
      "state": "Removing",
      "hasWorkspaceLevelSettings": false,
      "name": "a",
      "workbooks": [
        {
          "name": "My Excel sheet",
          "datasetId": "8ce96c50-85a0-4db3-85c6-7ccc3ed46523"
        }
      ]
    }
  ]
}

Définitions

Nom	Description
AdminDashboard	Tableau de bord Power BI retourné par les API d’administration. L’API retourne un sous-ensemble de la liste suivante des propriétés du tableau de bord. Le sous-ensemble dépend de l’API appelée, des autorisations d’appelant et de la disponibilité des données dans la base de données Power BI.
AdminDataflow	Métadonnées d’un dataflow retourné par les API d’administration. Vous trouverez ci-dessous une liste de propriétés qui peuvent être retournées pour un dataflow. Seul un sous-ensemble des propriétés est retourné en fonction de l’API appelée, des autorisations de l’appelant et de la disponibilité des données dans la base de données Power BI.
AdminDataset	Jeu de données Power BI retourné par les API d’administration. L’API retourne un sous-ensemble de la liste suivante des propriétés du jeu de données. Le sous-ensemble dépend de l’API appelée, des autorisations d’appelant et de la disponibilité des données dans la base de données Power BI.
AdminGroup	Un groupe Power BI retourné par les API d’administration
AdminGroups	Wrapper de réponse OData pour une liste de groupes Power BI retournés par les API d’administration
AdminReport	Rapport Power BI retourné par les API d’administration. L’API retourne un sous-ensemble de la liste suivante de propriétés de rapport. Le sous-ensemble dépend de l’API appelée, des autorisations d’appelant et de la disponibilité des données dans la base de données Power BI.
AdminTile	Vignette Power BI retournée par les API d’administration.
AzureResource	Réponse détaillant une ressource Azure appartenant à l’utilisateur, telle qu’un espace de travail Log Analytics.
DashboardUser	Entrée de droit d’accès utilisateur Power BI pour un tableau de bord
DashboardUserAccessRight	Droit d’accès dont dispose l’utilisateur pour le tableau de bord (niveau d’autorisation)
DataflowUser	Entrée de droit d’accès utilisateur Power BI pour un dataflow
DataflowUserAccessRight	Droit d’accès dont dispose un utilisateur pour le dataflow (niveau d’autorisation)
DatasetQueryScaleOutSettings	Interroger les paramètres de scale-out d’un jeu de données
DatasetUser	Entrée de droit d’accès utilisateur Power BI pour un jeu de données
DatasetUserAccessRight	Droit d’accès que l’utilisateur a pour le jeu de données (niveau d’autorisation)
DefaultDatasetStorageFormat	Format de stockage du jeu de données par défaut dans le groupe
DependentDataflow	Flux de données dépendant de Power BI
Encryption	Informations de chiffrement pour un jeu de données
EncryptionStatus	État du chiffrement du jeu de données
GroupType	Type de groupe
GroupUser	Un utilisateur Power BI ayant accès à l’espace de travail
GroupUserAccessRight	Droit d’accès (niveau d’autorisation) qu’un utilisateur a sur l’espace de travail
PrincipalType	Type de principal
ReportUser	Entrée de droit d’accès utilisateur Power BI pour un rapport
ReportUserAccessRight	Droit d’accès dont l’utilisateur dispose pour le rapport (niveau d’autorisation)
ServicePrincipalProfile	Profil de principal du service Power BI. Uniquement pertinent pour solution multilocataire Power BI Embedded.
Subscription	Un abonnement par e-mail pour un élément Power BI (tel qu’un rapport ou un tableau de bord)
SubscriptionUser	Un utilisateur d’abonnement de messagerie Power BI
Workbook	Un classeur Power BI

AdminDashboard

Tableau de bord Power BI retourné par les API d’administration. L’API retourne un sous-ensemble de la liste suivante des propriétés du tableau de bord. Le sous-ensemble dépend de l’API appelée, des autorisations d’appelant et de la disponibilité des données dans la base de données Power BI.

Nom	Type	Description
appId	string	ID d’application, retourné uniquement si le tableau de bord appartient à une application
displayName	string	Nom complet du tableau de bord
embedUrl	string	URL incorporée du tableau de bord
id	string	ID du tableau de bord
isReadOnly	boolean	Indique si le tableau de bord est en lecture seule
subscriptions	Subscription[]	(Valeur vide) Détails de l’abonnement pour un élément Power BI (tel qu’un rapport ou un tableau de bord). Cette propriété sera supprimée de la réponse de charge utile dans une prochaine version. Vous pouvez récupérer des informations d’abonnement pour un rapport Power BI à l’aide de l'Obtenir des abonnements de rapport en tant qu’appel d’API d’administrateur.
tiles	AdminTile[]	Vignettes appartenant au tableau de bord
users	DashboardUser[]	(Valeur vide) Détails de l’accès de l’utilisateur au tableau de bord. Cette propriété sera supprimée de la réponse de charge utile dans une prochaine version. Vous pouvez récupérer des informations utilisateur sur un tableau de bord Power BI à l’aide de l'Obtenir des utilisateurs de tableau de bord en tant qu’appel d’API administrateur, ou l’appel d’API PostWorkspaceInfo avec le paramètre `getArtifactUsers`.
webUrl	string	URL web du tableau de bord
workspaceId	string	ID d’espace de travail (GUID) du tableau de bord. Cette propriété est retournée uniquement dans GetDashboardsAsAdmin.

AdminDataflow

Métadonnées d’un dataflow retourné par les API d’administration. Vous trouverez ci-dessous une liste de propriétés qui peuvent être retournées pour un dataflow. Seul un sous-ensemble des propriétés est retourné en fonction de l’API appelée, des autorisations de l’appelant et de la disponibilité des données dans la base de données Power BI.

Nom	Type	Description
configuredBy	string	Propriétaire du flux de données
description	string	Description du flux de données
modelUrl	string	URL du fichier de définition de flux de données (model.json)
name	string	Nom du dataflow
objectId	string	ID de flux de données
users	DataflowUser[]	(Valeur vide) Détails de l’accès de l’utilisateur du flux de données. Cette propriété sera supprimée de la réponse de charge utile dans une prochaine version. Vous pouvez récupérer des informations utilisateur sur un dataflow Power BI à l’aide de l'Obtenir des utilisateurs de dataflow en tant qu’appel d’API administrateur, ou l’appel d’API PostWorkspaceInfo avec le paramètre `getArtifactUser`.
workspaceId	string	ID de l’espace de travail dataflow.

AdminDataset

Jeu de données Power BI retourné par les API d’administration. L’API retourne un sous-ensemble de la liste suivante des propriétés du jeu de données. Le sous-ensemble dépend de l’API appelée, des autorisations d’appelant et de la disponibilité des données dans la base de données Power BI.

Nom	Type	Description
ContentProviderType	string	Type de fournisseur de contenu pour le jeu de données
CreateReportEmbedURL	string	Le jeu de données crée une URL d’incorporation de rapport
Encryption	Encryption	Informations de chiffrement du jeu de données. Applicable uniquement lorsque `$expand` est spécifié.
IsEffectiveIdentityRequired	boolean	Indique si le jeu de données nécessite une identité effective, que vous devez envoyer dans un appel d’API GenerateToken.
IsEffectiveIdentityRolesRequired	boolean	Indique si la sécurité au niveau des lignes est définie à l’intérieur du fichier .pbix Power BI. Dans ce cas, vous devez spécifier un rôle.
IsInPlaceSharingEnabled	boolean	Indique si le jeu de données peut être partagé avec des utilisateurs externes à consommer dans leur propre locataire
IsOnPremGatewayRequired	boolean	Indique si le jeu de données nécessite une passerelle de données locale
IsRefreshable	boolean	Ce champ retourne `true` lorsque le jeu de données est récemment actualisé ou configuré pour l’actualisation automatique, avec le mode de connexion spécifiquement défini sur « Importer ». La valeur retourne `false` pour d’autres modes de connexion, tels que « DirectQuery » et « LiveConnection », que le jeu de données soit actualisé manuellement ou configuré pour l’actualisation automatique.
QnaEmbedURL	string	Le jeu de données Q&UNE URL incorporée
addRowsAPIEnabled	boolean	Indique si le jeu de données autorise l’ajout de nouvelles lignes
configuredBy	string	Propriétaire du jeu de données
createdDate	string	Date et heure de création du jeu de données
description	string	Description du jeu de données
id	string	ID du jeu de données
name	string	Nom du jeu de données
queryScaleOutSettings	DatasetQueryScaleOutSettings	Interroger les paramètres de scale-out d’un jeu de données
targetStorageMode	string	Mode de stockage du jeu de données
upstreamDataflows	DependentDataflow[]	La liste de tous les flux de données dont dépend cet élément
users	DatasetUser[]	(Valeur vide) Détails de l’accès de l’utilisateur au jeu de données. Cette propriété sera supprimée de la réponse de charge utile dans une prochaine version. Vous pouvez récupérer des informations utilisateur sur un élément Power BI (tel qu’un rapport ou un tableau de bord) à l’aide du Obtenir des utilisateurs de jeu de données en tant qu’API d’administration, ou de l’API PostWorkspaceInfo avec le paramètre `getArtifactUsers`.
webUrl	string	URL web du jeu de données
workspaceId	string	ID de l’espace de travail du jeu de données. Cette propriété est retournée uniquement dans GetDatasetsAsAdmin.

AdminGroup

Un groupe Power BI retourné par les API d’administration

Nom	Type	Description
capacityId	string	ID de capacité
dashboards	AdminDashboard[]	Tableaux de bord appartenant au groupe
dataflowStorageId	string	ID du compte de stockage de flux de données Power BI
dataflows	AdminDataflow[]	Dataflows qui appartiennent au groupe
datasets	AdminDataset[]	Jeux de données appartenant au groupe
defaultDatasetStorageFormat	DefaultDatasetStorageFormat	Format de stockage de jeu de données par défaut dans l’espace de travail. Retourné uniquement lorsque `isOnDedicatedCapacity` est `true`
description	string	Description du groupe
hasWorkspaceLevelSettings	boolean	Indique si l’espace de travail a des paramètres personnalisés
id	string	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
pipelineId	string	ID de pipeline de déploiement auquel l’espace de travail est affecté.
reports	AdminReport[]	Rapports appartenant au groupe
state	string	État du groupe
type	GroupType	Type de groupe retourné.
users	GroupUser[]	(Valeur vide) Utilisateurs appartenant au groupe et à leurs droits d’accès. Cette propriété sera supprimée de la réponse de charge utile dans une prochaine version. Vous pouvez récupérer des informations utilisateur sur un élément Power BI (tel qu’un rapport ou un tableau de bord) à l’aide de l'Obtenir des utilisateurs de groupe en tant qu’appel d’API administrateur, ou de l’appel d’API PostWorkspaceInfo avec le paramètre `getArtifactUsers`.
workbooks	Workbook[]	Classeurs appartenant au groupe

AdminGroups

Wrapper de réponse OData pour une liste de groupes Power BI retournés par les API d’administration

Nom	Type	Description
@odata.context	string	Contexte OData
value	AdminGroup[]	Liste des groupes

AdminReport

Rapport Power BI retourné par les API d’administration. L’API retourne un sous-ensemble de la liste suivante de propriétés de rapport. Le sous-ensemble dépend de l’API appelée, des autorisations d’appelant et de la disponibilité des données dans la base de données Power BI.

Nom	Type	Description
appId	string	ID de l’application, retourné uniquement si le rapport appartient à une application
createdBy	string	Propriétaire du rapport. Disponible uniquement pour les rapports créés après juin 2019.
createdDateTime	string	Date et heure de création du rapport
datasetId	string	ID de jeu de données du rapport
description	string	Description du rapport
embedUrl	string	URL incorporée du rapport
id	string	ID de rapport
isOwnedByMe	boolean	Déterminez si le rapport est créé par l’utilisateur actuel.
modifiedBy	string	Dernier utilisateur qui a modifié le rapport
modifiedDateTime	string	Date et heure de la dernière modification du rapport
name	string	Nom du rapport
originalReportId	string	ID de rapport réel lorsque l’espace de travail est publié en tant qu’application.
reportType	enum: PaginatedReport PowerBIReport	Type de rapport
subscriptions	Subscription[]	(Valeur vide) Détails de l’abonnement pour un élément Power BI (tel qu’un rapport ou un tableau de bord). Cette propriété sera supprimée de la réponse de charge utile dans une prochaine version. Vous pouvez récupérer des informations d’abonnement pour un rapport Power BI à l’aide de l'Obtenir des abonnements de rapport en tant qu’appel d’API d’administrateur.
users	ReportUser[]	(Valeur vide) Les détails de l’accès utilisateur à un rapport Power BI. Cette propriété sera supprimée de la réponse de charge utile dans une prochaine version. Vous pouvez récupérer des informations utilisateur sur un rapport Power BI à l’aide de l'Obtenir des utilisateurs de rapport en tant qu’appel d’API administrateur, ou de l’appel d’API PostWorkspaceInfo avec le paramètre `getArtifactUsers`.
webUrl	string	URL web du rapport
workspaceId	string	ID d’espace de travail (GUID) du rapport. Cette propriété est retournée uniquement dans GetReportsAsAdmin.

AdminTile

Vignette Power BI retournée par les API d’administration.

Nom	Type	Description
colSpan	integer	Nombre de colonnes d’étendue de mosaïques
datasetId	string	ID du jeu de données. Disponible uniquement pour les vignettes créées à partir d’un rapport ou à l’aide d’un jeu de données, comme les vignettes Q&A.
embedData	string	Données incorporées pour la vignette
embedUrl	string	URL incorporée de la vignette
id	string	ID de vignette
reportId	string	ID de rapport. Disponible uniquement pour les vignettes créées à partir d’un rapport.
rowSpan	integer	Nombre de lignes d’étendue de vignette
title	string	Nom complet de la vignette

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 dans l’abonnement où réside la ressource.
resourceName	string	Nom de la ressource.
subscriptionId	string	Abonnement Azure où réside la ressource.

DashboardUser

Entrée de droit d’accès utilisateur Power BI pour un tableau de bord

Nom	Type	Description
dashboardUserAccessRight	DashboardUserAccessRight	Droit d’accès dont dispose l’utilisateur pour le tableau de bord (niveau d’autorisation)
displayName	string	Nom complet du principal
emailAddress	string	Adresse e-mail de l’utilisateur
graphId	string	Identificateur du principal dans Microsoft Graph. Disponible uniquement pour les API d’administration.
identifier	string	Identificateur du principal
principalType	PrincipalType	Type de principal
profile	ServicePrincipalProfile	Profil de principal du service Power BI. Uniquement pertinent pour solution multilocataire Power BI Embedded.
userType	string	Type de l’utilisateur.

DashboardUserAccessRight

Droit d’accès dont dispose l’utilisateur pour le tableau de bord (niveau d’autorisation)

Nom	Type	Description
None	string	Aucune autorisation pour le contenu dans le tableau de bord
Owner	string	Accorde l’accès en lecture, écriture et partage à nouveau au contenu dans le rapport
Read	string	Octroie l’accès en lecture au contenu dans le tableau de bord
ReadCopy	string	Octroie l’accès en lecture et copie au contenu dans le tableau de bord
ReadReshare	string	Accorde l’accès en lecture et repartage au contenu dans le tableau de bord
ReadWrite	string	Octroie l’accès en lecture et écriture au contenu dans le tableau de bord

DataflowUser

Entrée de droit d’accès utilisateur Power BI pour un dataflow

Nom	Type	Description
DataflowUserAccessRight	DataflowUserAccessRight	Droit d’accès dont dispose un utilisateur pour le dataflow (niveau d’autorisation)
displayName	string	Nom complet du principal
emailAddress	string	Adresse e-mail de l’utilisateur
graphId	string	Identificateur du principal dans Microsoft Graph. Disponible uniquement pour les API d’administration.
identifier	string	Identificateur du principal
principalType	PrincipalType	Type de principal
profile	ServicePrincipalProfile	Profil de principal du service Power BI. Uniquement pertinent pour solution multilocataire Power BI Embedded.
userType	string	Type de l’utilisateur.

DataflowUserAccessRight

Droit d’accès dont dispose un utilisateur pour le dataflow (niveau d’autorisation)

Nom	Type	Description
None	string	Supprime l’autorisation de contenu dans le flux de données
Owner	string	Accorde l’accès en lecture, écriture et partage à nouveau au contenu dans le flux de données
Read	string	Octroie l’accès en lecture au contenu dans le flux de données
ReadReshare	string	Accorde l’accès en lecture et repartage au contenu dans le flux de données
ReadWrite	string	Octroie l’accès en lecture et écriture au contenu dans le flux de données

DatasetQueryScaleOutSettings

Interroger les paramètres de scale-out d’un jeu de données

Nom	Type	Description
autoSyncReadOnlyReplicas	boolean	Indique si le jeu de données synchronise automatiquement les réplicas en lecture seule
maxReadOnlyReplicas	integer	Nombre maximal de réplicas en lecture seule pour le jeu de données (0-64, -1 pour le nombre automatique de réplicas)

DatasetUser

Entrée de droit d’accès utilisateur Power BI pour un jeu de données

Nom	Type	Description
datasetUserAccessRight	DatasetUserAccessRight	Droit d’accès que l’utilisateur a pour le jeu de données (niveau d’autorisation)
displayName	string	Nom complet du principal
emailAddress	string	Adresse e-mail de l’utilisateur
graphId	string	Identificateur du principal dans Microsoft Graph. Disponible uniquement pour les API d’administration.
identifier	string	Identificateur du principal
principalType	PrincipalType	Type de principal
profile	ServicePrincipalProfile	Profil de principal du service Power BI. Uniquement pertinent pour solution multilocataire Power BI Embedded.
userType	string	Type de l’utilisateur.

DatasetUserAccessRight

Droit d’accès que l’utilisateur a pour le jeu de données (niveau d’autorisation)

Nom	Type	Description
None	string	Supprime l’autorisation du contenu dans le jeu de données
Read	string	Octroie l’accès en lecture au contenu dans le jeu de données
ReadExplore	string	Octroie l’accès en lecture et explorer au contenu du jeu de données
ReadReshare	string	Accorde l’accès en lecture et repartage au contenu du jeu de données
ReadReshareExplore	string	Accorde l’accès en lecture, repartage et exploration du contenu dans le jeu de données
ReadWrite	string	Octroie l’accès en lecture et écriture au contenu du jeu de données
ReadWriteExplore	string	Accorde l’accès en lecture, écriture et exploration au contenu du jeu de données
ReadWriteReshare	string	Accorde l’accès en lecture, écriture et partage à nouveau au contenu du jeu de données
ReadWriteReshareExplore	string	Accorde l’accès en lecture, écriture, partage et exploration du contenu dans le jeu de données

DefaultDatasetStorageFormat

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

Nom	Type	Description
Large	string	Format de stockage de jeux de données volumineux
Small	string	Format de stockage de petits jeux de données

DependentDataflow

Flux de données dépendant de Power BI

Nom	Type	Description
groupId	string	ID de groupe cible
targetDataflowId	string	ID de flux de données cible

Encryption

Informations de chiffrement pour un jeu de données

Nom	Type	Description
EncryptionStatus	EncryptionStatus	État du chiffrement du jeu de données

EncryptionStatus

État du chiffrement du jeu de données

Nom	Type	Description
InSyncWithWorkspace	string	Le chiffrement est pris en charge et est synchronisé avec les paramètres de chiffrement
NotInSyncWithWorkspace	string	Le chiffrement est pris en charge, mais n’est pas synchronisé avec les paramètres de chiffrement
NotSupported	string	Le chiffrement n’est pas pris en charge pour ce jeu de données
Unknown	string	L’état du chiffrement est inconnu en raison de l’altération du jeu de données

GroupType

Type de groupe

Nom	Type	Description
AdminWorkspace	string	Surveillance des administrateurs d’administration pour les administrateurs fabric
Group	string	Version V1 de l’espace de travail partagé. Ce type d’espaces de travail sera déconseillé, car Microsoft migre tous les espaces de travail vers la dernière version de l’espace de travail partagé
Personal	string	Type spécial d’espace de travail destiné à la liste SharePoint et à l’intégration de OneDrive
PersonalGroup	string	« Mon espace de travail », également appelé espace de travail personnel
Workspace	string	Espace de travail partagé ou espace de travail simple utilisé pour partager du contenu avec d’autres utilisateurs de l’organisation

GroupUser

Un utilisateur Power BI ayant accès à l’espace de travail

Nom	Type	Description
displayName	string	Nom complet du principal
emailAddress	string	Adresse e-mail de l’utilisateur
graphId	string	Identificateur du principal dans Microsoft Graph. Disponible uniquement pour les API d’administration.
groupUserAccessRight	GroupUserAccessRight	Droit d’accès (niveau d’autorisation) qu’un utilisateur a sur l’espace de travail
identifier	string	Identificateur du principal
principalType	PrincipalType	Type de principal
profile	ServicePrincipalProfile	Profil de principal du service Power BI. Uniquement pertinent pour solution multilocataire Power BI Embedded.
userType	string	Type de l’utilisateur.

GroupUserAccessRight

Droit d’accès (niveau d’autorisation) qu’un utilisateur a sur l’espace de travail

Nom	Type	Description
Admin	string	Droits d’administrateur sur le contenu de l’espace de travail
Contributor	string	Accès en lecture et exploration (ReadExplore) au contenu de l’espace de travail
Member	string	Lire, repartager et explorer (ReadReshareExplore) des droits d’accès au contenu de l’espace de travail
None	string	Aucun accès au contenu de l’espace de travail
Viewer	string	Accès en lecture seule (lecture) au contenu de l’espace de travail

PrincipalType

Type de principal

Nom	Type	Description
App	string	Type de principal de service
Group	string	Type de principal de groupe
None	string	Aucun type de principal. Utiliser pour l’ensemble de l’accès au niveau de l’organisation.
User	string	Type de principal de l’utilisateur

ReportUser

Entrée de droit d’accès utilisateur Power BI pour un rapport

Nom	Type	Description
displayName	string	Nom complet du principal
emailAddress	string	Adresse e-mail de l’utilisateur
graphId	string	Identificateur du principal dans Microsoft Graph. Disponible uniquement pour les API d’administration.
identifier	string	Identificateur du principal
principalType	PrincipalType	Type de principal
profile	ServicePrincipalProfile	Profil de principal du service Power BI. Uniquement pertinent pour solution multilocataire Power BI Embedded.
reportUserAccessRight	ReportUserAccessRight	Droit d’accès dont l’utilisateur dispose pour le rapport (niveau d’autorisation)
userType	string	Type de l’utilisateur.

ReportUserAccessRight

Droit d’accès dont l’utilisateur dispose pour le rapport (niveau d’autorisation)

Nom	Type	Description
None	string	Aucune autorisation pour le contenu dans le rapport
Owner	string	Accorde l’accès en lecture, écriture et partage à nouveau au contenu dans le rapport
Read	string	Octroie l’accès en lecture au contenu dans le rapport
ReadCopy	string	Octroie l’accès en lecture et copie au contenu dans le rapport
ReadReshare	string	Accorde l’accès en lecture et repartage au contenu dans le rapport
ReadWrite	string	Octroie l’accès en lecture et écriture au contenu dans le rapport

ServicePrincipalProfile

Profil de principal du service Power BI. Uniquement pertinent pour solution multilocataire Power BI Embedded.

Nom	Type	Description
displayName	string	Nom du profil du principal de service
id	string	ID de profil du principal de service

Subscription

Un abonnement par e-mail pour un élément Power BI (tel qu’un rapport ou un tableau de bord)

Nom	Type	Description
artifactDisplayName	string	Nom de l’élément Power BI abonné (tel qu’un rapport ou un tableau de bord)
artifactId	string	ID de l’élément Power BI abonné (tel qu’un rapport ou un tableau de bord)
artifactType	string	Type d’élément Power BI (par exemple, un `Report`, `Dashboard`ou `Dataset`)
attachmentFormat	string	Format du rapport joint dans l’abonnement par e-mail
endDate	string	Date et heure de fin de l’abonnement par e-mail
frequency	string	Fréquence de l’abonnement par e-mail
id	string	ID d’abonnement
isEnabled	boolean	Indique si l’abonnement par e-mail est activé
linkToContent	boolean	Indique si un lien d’abonnement existe dans l’abonnement par e-mail
previewImage	boolean	Indique si une capture d’écran du rapport existe dans l’abonnement par e-mail
startDate	string	Date et heure de début de l’abonnement par e-mail
subArtifactDisplayName	string	Nom de la page de l’élément Power BI abonné, s’il s’agit d’un rapport.
title	string	Nom de l’application
users	SubscriptionUser[]	Détails de chaque abonné à l’e-mail. Lorsque vous utilisez l'Obtenir des abonnements utilisateur en tant qu’appel d’API administrateur, la valeur retournée est un tableau vide (null). Cette propriété sera supprimée de la réponse de charge utile dans une prochaine version. Vous pouvez récupérer des informations d’abonnement sur un rapport Ou un tableau de bord Power BI à l’aide de l'Obtenir des abonnements de rapport en tant qu’administrateur ou Obtenir des abonnements de tableau de bord en tant qu’appels d’API d’administrateur.

SubscriptionUser

Un utilisateur d’abonnement de messagerie Power BI

Nom	Type	Description
displayName	string	Nom complet du principal
emailAddress	string	Adresse e-mail de l’utilisateur
graphId	string	Identificateur du principal dans Microsoft Graph. Disponible uniquement pour les API d’administration.
identifier	string	Identificateur du principal
principalType	PrincipalType	Type de principal
profile	ServicePrincipalProfile	Profil de principal du service Power BI. Uniquement pertinent pour solution multilocataire Power BI Embedded.
userType	string	Type de l’utilisateur.

Workbook

Un classeur Power BI

Nom	Type	Description
datasetId	string	ID du jeu de données associé à un classeur. S’applique uniquement si le classeur a un jeu de données associé.
name	string	Nom du classeur

Partager via

Admin - Groups GetGroupsAsAdmin

Autorisations

Étendue requise

Limitations

Paramètres URI

Réponses

Exemples

Get deleted workspaces example.

Exemple de requête

Exemple de réponse

Get orphaned workspaces example.

Exemple de requête

Exemple de réponse

Get workspaces with their 'dashboards' expanded example

Exemple de requête

Exemple de réponse

Get workspaces with their 'datasets' expanded example

Exemple de requête

Exemple de réponse

Get workspaces with their 'datasets' expanded example.

Exemple de requête

Exemple de réponse

Get workspaces with their 'reports' expanded example

Exemple de requête

Exemple de réponse

Get workspaces with their 'users' expanded example.

Exemple de requête

Exemple de réponse

Get workspaces with their 'workbooks' expanded example

Exemple de requête

Exemple de réponse

Définitions

AdminDashboard

AdminDataflow

AdminDataset

AdminGroup

AdminGroups

AdminReport

AdminTile

AzureResource

DashboardUser

DashboardUserAccessRight

DataflowUser

DataflowUserAccessRight

DatasetQueryScaleOutSettings

DatasetUser

DatasetUserAccessRight

DefaultDatasetStorageFormat

DependentDataflow

Encryption

EncryptionStatus

GroupType

GroupUser

GroupUserAccessRight

PrincipalType

ReportUser

ReportUserAccessRight

ServicePrincipalProfile

Subscription

SubscriptionUser

Workbook

Ressources supplémentaires