Admin - Groups GetGroupsAsAdmin

Référence

Service:: Power BI REST APIs

API Version:: v1.0

Retourne une liste d’espaces de travail pour le organization.

Autorisations

L’utilisateur doit disposer de droits d’administrateur (tels que Office 365 administrateur général ou administrateur de service Power BI) 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 de service, une application ne doit pas avoir de prémissions requises de consentement administrateur pour Power BI définies sur elle dans le Portail Azure.

Étendue requise

Tenant.Read.All ou Tenant.ReadWrite.All

Pertinent 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.

Limites

Maximum 50 demandes par heure ou 15 demandes par minute, par locataire. Cet appel expire également après 30 secondes pour éviter tout effet négatif sur le service Power BI.

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

With optional parameters:

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 comprise entre 1 et 5 000.
$expand	query		string	Accepte une liste de types de données séparées par des virgules, qui sera développée inline dans la réponse. Prend en charge `users`, `reportsdashboards`, `datasets`, `dataflows`, et `workbooks`.
$filter	query		string	Filtre les résultats en fonction d’une condition booléenne
$skip	query		integer int32	Ignore les n premiers 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	Ok

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.

Sample Request

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

Sample Response

Status code:: 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.

Sample Request

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

Sample Response

Status code:: 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

Sample Request

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

Sample Response

Status code:: 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

Sample Request

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

Sample Response

Status code:: 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.

Sample Request

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

Sample Response

Status code:: 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

Sample Request

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

Sample Response

Status code:: 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.

Sample Request

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

Sample Response

Status code:: 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

Sample Request

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

Sample Response

Status code:: 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 Administration API. L’API retourne un sous-ensemble de la liste suivante de propriétés de tableau de bord. Le sous-ensemble dépend 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.
AdminDataflow	Métadonnées d’un flux de données retourné par Administration API. Vous trouverez ci-dessous la liste des propriétés qui peuvent être retournées pour un flux de données. 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	Un jeu de données Power BI retourné par Administration API. L’API retourne un sous-ensemble de la liste suivante de propriétés de jeu de données. Le sous-ensemble dépend 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.
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 Administration API
AdminReport	Un rapport Power BI retourné par Administration API. 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 de l’appelant et de la disponibilité des données dans la base de données Power BI.
AdminTile	Vignette Power BI retournée par Administration API.
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 flux de données
DataflowUserAccessRight	Droit d’accès d’un utilisateur au flux de données (niveau d’autorisation)
DatasetQueryScaleOutSettings	Paramètres de scale-out de requête 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 dont dispose l’utilisateur 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	Un flux de données dépendant de Power BI
Encryption	Informations de chiffrement pour un jeu de données
EncryptionStatus	status de chiffrement de jeu de données
GroupType	Type de groupe
GroupUser	Un utilisateur Power BI ayant accès à l’espace de travail
GroupUserAccessRight	Le droit d’accès (niveau d’autorisation) d’un utilisateur sur l’espace de travail
PrincipalType	Type principal
ReportUser	Entrée de droit d’accès utilisateur Power BI pour un rapport
ReportUserAccessRight	Droit d’accès dont dispose l’utilisateur pour le rapport (niveau d’autorisation)
ServicePrincipalProfile	Profil principal service Power BI. Concerne uniquement Power BI Embedded solution mutualisée.
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 Administration API. L’API retourne un sous-ensemble de la liste suivante de propriétés de tableau de bord. Le sous-ensemble dépend 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
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 (par exemple, 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 les informations d’abonnement d’un rapport Power BI à l’aide de l’appel d’API Get Report Subscriptions as Administration.
tiles	AdminTile[]	Vignettes qui appartiennent au tableau de bord
users	DashboardUser[]	(Valeur vide) Détails de l’accès 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’appel d’API Obtenir des utilisateurs du tableau de bord en tant qu’appel d’API Administration, ou de l’appel d’API PostWorkspaceInfo avec le `getArtifactUsers` paramètre .
webUrl	string	URL web du tableau de bord
workspaceId	string	ID d’espace de travail (GUID) du tableau de bord. Cette propriété sera retournée uniquement dans GetDashboardsAsAdmin.

AdminDataflow

Métadonnées d’un flux de données retourné par Administration API. Vous trouverez ci-dessous la liste des propriétés qui peuvent être retournées pour un flux de données. 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)
modifiedBy	string	Utilisateur qui a modifié le flux de données
modifiedDateTime	string	Date et heure de la dernière modification du flux de données
name	string	Nom du flux de données
objectId	string	ID de flux de données
users	DataflowUser[]	(Valeur vide) Détails de l’accès utilisateur au 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 flux de données Power BI à l’aide de l’appel d’API Obtenir des utilisateurs de flux de données en tant qu’appel d’API Administration, ou de l’appel d’API PostWorkspaceInfo avec le `getArtifactUser` paramètre .
workspaceId	string	ID de l’espace de travail de flux de données.

AdminDataset

Un jeu de données Power BI retourné par Administration API. L’API retourne un sous-ensemble de la liste suivante de propriétés de jeu de données. Le sous-ensemble dépend 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
ContentProviderType	string	Type de fournisseur de contenu pour le jeu de données
CreateReportEmbedURL	string	URL d’incorporation du jeu de données de création de rapport
CreatedDate	string	Date et heure de création du jeu de données
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é efficace, que vous devez envoyer dans un appel d’API GenerateToken .
IsEffectiveIdentityRolesRequired	boolean	Indique si la sécurité au niveau des lignes est définie dans le fichier .pbix Power BI. Si c’est le cas, vous devez spécifier un rôle.
IsInPlaceSharingEnabled	boolean	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	Indique si le jeu de données est actualisable ou non. Un jeu de données actualisable Power BI est un jeu de données qui a été actualisé au moins une fois ou pour lequel une planification d’actualisation valide existe.
QnaEmbedURL	string	URL incorporée du jeu de données Q&A
addRowsAPIEnabled	boolean	Si le jeu de données autorise l’ajout de nouvelles lignes
configuredBy	string	Propriétaire 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 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 de l’API Get Dataset Users as Administration ou de l’API PostWorkspaceInfo avec le `getArtifactUsers` paramètre .
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[]	Les tableaux de bord qui appartiennent au groupe
dataflowStorageId	string	ID de compte de stockage de flux de données Power BI
dataflows	AdminDataflow[]	Flux de données qui appartiennent au groupe
datasets	AdminDataset[]	Jeux de données qui appartiennent au groupe
defaultDatasetStorageFormat	DefaultDatasetStorageFormat	Format de stockage du 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	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
pipelineId	string	ID de pipeline de déploiement auquel l’espace de travail est affecté.
reports	AdminReport[]	Les rapports qui appartiennent au groupe
state	string	État du groupe
type	GroupType	Type de groupe retourné.
users	GroupUser[]	(Valeur vide) Utilisateurs qui appartiennent 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’appel d’API Get Group Users As Administration ou de l’appel d’API PostWorkspaceInfo avec le `getArtifactUsers` paramètre .
workbooks	Workbook[]	Classeurs appartenant au groupe

AdminGroups

Wrapper de réponse OData pour une liste de groupes Power BI retournés par Administration API

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

AdminReport

Un rapport Power BI retourné par Administration API. 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 de l’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 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 du 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 (par exemple, 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 les informations d’abonnement d’un rapport Power BI à l’aide de l’appel d’API Get Report Subscriptions as Administration.
users	ReportUser[]	(Valeur vide) Détails d’accès utilisateur pour 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’appel d’API Get Report Users as Administration, ou de l’appel d’API PostWorkspaceInfo avec le `getArtifactUsers` paramètre .
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 Administration API.

Nom	Type	Description
colSpan	integer	Nombre de colonnes d’étendue de vignette
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, telles que les vignettes Q&R.
embedData	string	Données incorporées pour la vignette
embedUrl	string	URL d’incorporation 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 vignettes
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 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.

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 d’affichage 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 principal
profile	ServicePrincipalProfile	Profil principal service Power BI. Ne concerne que Power BI Embedded solution multilocataire.
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 sur le contenu dans le tableau de bord
Owner	string	Octroie l’accès en lecture, écriture et repartage au contenu du 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	Octroie l’accès en lecture et repartage au contenu dans le tableau de bord
ReadWrite	string	Octroie l’accès en lecture et en écriture au contenu dans le tableau de bord

DataflowUser

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

Nom	Type	Description
DataflowUserAccessRight	DataflowUserAccessRight	Droit d’accès d’un utilisateur au flux de données (niveau d’autorisation)
displayName	string	Nom d’affichage 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 principal
profile	ServicePrincipalProfile	Profil principal service Power BI. Ne concerne que Power BI Embedded solution multilocataire.
userType	string	Type de l’utilisateur.

DataflowUserAccessRight

Droit d’accès d’un utilisateur au flux de données (niveau d’autorisation)

Nom	Type	Description
None	string	Supprime l’autorisation d’accès au contenu dans le flux de données
Owner	string	Octroie l’accès en lecture, écriture et repartage 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	Octroie l’accès en lecture et repartage au contenu dans le flux de données
ReadWrite	string	Octroie l’accès en lecture et en écriture au contenu dans le flux de données

DatasetQueryScaleOutSettings

Paramètres de scale-out de requête 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 dont dispose l’utilisateur pour le jeu de données (niveau d’autorisation)
displayName	string	Nom d’affichage 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 principal
profile	ServicePrincipalProfile	Profil principal service Power BI. Ne concerne que Power BI Embedded solution multilocataire.
userType	string	Type de l’utilisateur.

DatasetUserAccessRight

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

Nom	Type	Description
None	string	Supprime l’autorisation sur le 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 lecture et exploration au contenu dans le jeu de données
ReadReshare	string	Octroie l’accès en lecture et en partage au contenu dans le jeu de données
ReadReshareExplore	string	Octroie l’accès en lecture, partage et exploration au contenu du jeu de données
ReadWrite	string	Octroie l’accès en lecture et en écriture au contenu du jeu de données
ReadWriteExplore	string	Octroie l’accès en lecture, écriture et exploration au contenu du jeu de données
ReadWriteReshare	string	Octroie l’accès en lecture, écriture et repartage au contenu du jeu de données
ReadWriteReshareExplore	string	Octroie l’accès en lecture, écriture, partage et exploration au contenu du 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 des grands jeux de données
Small	string	Format de stockage de petits jeux de données

DependentDataflow

Un flux de données dépendant de Power BI

Nom	Type	Description
groupId	string	ID du 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	status de chiffrement de jeu de données

EncryptionStatus

status de chiffrement de 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	Le status de chiffrement est inconnu en raison d’une altération du jeu de données

GroupType

Type de groupe

Nom	Type	Description
Group	string	Version V1 de l’espace de travail partagé. Ce type d’espaces de travail sera déprécié à mesure que Microsoft migrera 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é à l’intégration à la liste SharePoint et à 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 dans le organization

GroupUser

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

Nom	Type	Description
displayName	string	Nom d’affichage 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	Le droit d’accès (niveau d’autorisation) d’un utilisateur sur l’espace de travail
identifier	string	Identificateur du principal
principalType	PrincipalType	Type principal
profile	ServicePrincipalProfile	Profil principal service Power BI. Concerne uniquement Power BI Embedded solution mutualisée.
userType	string	Type de l’utilisateur.

GroupUserAccessRight

Le droit d’accès (niveau d’autorisation) d’un utilisateur 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) les 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 au contenu de l’espace de travail

PrincipalType

Type principal

Nom	Type	Description
App	string	Type de principal de service
Group	string	Type de principal de groupe
None	string	Aucun type de principal. Utilisez pour un accès entier organization niveau.
User	string	Type de principal d’utilisateur

ReportUser

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

Nom	Type	Description
displayName	string	Nom d’affichage 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 principal
profile	ServicePrincipalProfile	Profil principal service Power BI. Concerne uniquement Power BI Embedded solution mutualisée.
reportUserAccessRight	ReportUserAccessRight	Droit d’accès dont dispose l’utilisateur pour le rapport (niveau d’autorisation)
userType	string	Type de l’utilisateur.

ReportUserAccessRight

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

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

ServicePrincipalProfile

Profil principal service Power BI. Concerne uniquement Power BI Embedded solution mutualisée.

Nom	Type	Description
displayName	string	Nom du profil de 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é (par exemple, 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 , `ReportDashboard`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	Si un lien d’abonnement existe dans l’abonnement par e-mail
previewImage	boolean	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. Lors de l’utilisation de l’appel d’API Get User Subscriptions As Administration, 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 des appels d’API Obtenir des abonnements aux rapports en tant que Administration ou Obtenir des abonnements au tableau de bord en tant que Administration.

SubscriptionUser

Un utilisateur d’abonnement de messagerie Power BI

Nom	Type	Description
displayName	string	Nom d’affichage 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 principal
profile	ServicePrincipalProfile	Profil principal service Power BI. Ne concerne que Power BI Embedded solution multilocataire.
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

Limites

Paramètres URI

Réponses

Exemples

Get deleted workspaces example.

Sample Request

Sample Response

Get orphaned workspaces example.

Sample Request

Sample Response

Get workspaces with their 'dashboards' expanded example

Sample Request

Sample Response

Get workspaces with their 'datasets' expanded example

Sample Request

Sample Response

Get workspaces with their 'datasets' expanded example.

Sample Request

Sample Response

Get workspaces with their 'reports' expanded example

Sample Request

Sample Response

Get workspaces with their 'users' expanded example.

Sample Request

Sample Response

Get workspaces with their 'workbooks' expanded example

Sample Request

Sample Response

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