Admin - Dashboards GetDashboardsAsAdmin
Retourne une liste de tableaux de bord pour l’organisation.
Permissions
- 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 avoir de prémissions requises par l’administrateur pour Power BI définie sur celle-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.
Limites
Maximum 50 requêtes par heure ou 5 requêtes par minute, par locataire.
GET https://api.powerbi.com/v1.0/myorg/admin/dashboards
GET https://api.powerbi.com/v1.0/myorg/admin/dashboards?$expand={$expand}&$filter={$filter}&$top={$top}&$skip={$skip}
Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
$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 |
|
|
$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 |
Ok |
Exemples
Example
Exemple de requête
GET https://api.powerbi.com/v1.0/myorg/admin/dashboards
Exemple de réponse
{
"value": [
{
"id": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
"displayName": "SalesMarketing",
"embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
"isReadOnly": false,
"workspaceId": "abfbdc89-2659-43c1-9142-93e8378eac96"
}
]
}
Définitions
| Nom | Description |
|---|---|
|
Admin |
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. |
|
Admin |
Wrapper de réponse OData pour une collection de tableaux de bord Power BI |
|
Admin |
Vignette Power BI retournée par les API d’administration. |
|
Dashboard |
Entrée de droit d’accès utilisateur Power BI pour un tableau de bord |
|
Dashboard |
Droit d’accès dont dispose l’utilisateur pour le tableau de bord (niveau d’autorisation) |
|
Principal |
Type de principal |
|
Service |
Profil de principal du service Power BI. Uniquement pertinent pour la 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) |
|
Subscription |
Un utilisateur d’abonnement de messagerie 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 (uuid) |
ID du tableau de bord |
| isReadOnly |
boolean |
Indique si le tableau de bord est en lecture seule |
| subscriptions |
(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’appel d’API d’administration obtenir des abonnements de rapport . |
|
| tiles |
Vignettes appartenant au tableau de bord |
|
| users |
(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’appel d’API Get Dashboard Users as Admin API call, ou de l’appel de l’API PostWorkspaceInfo avec le |
|
| webUrl |
string |
URL web du tableau de bord |
| workspaceId |
string (uuid) |
ID d’espace de travail (GUID) du tableau de bord. Cette propriété est retournée uniquement dans GetDashboardsAsAdmin. |
AdminDashboards
Wrapper de réponse OData pour une collection de tableaux de bord Power BI
| Nom | Type | Description |
|---|---|---|
| @odata.context |
string |
Contexte OData |
| value |
Collection de tableaux de bord |
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 (uuid) |
ID de vignette |
| reportId |
string (uuid) |
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 |
DashboardUser
Entrée de droit d’accès utilisateur Power BI pour un tableau de bord
| Nom | Type | Description |
|---|---|---|
| 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 |
Type de principal |
|
| profile |
Profil de principal du service Power BI. Uniquement pertinent pour la 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)
| Valeur | Description |
|---|---|
| None |
Aucune autorisation pour le contenu dans le tableau de bord |
| Read |
Octroie l’accès en lecture au contenu dans le tableau de bord |
| ReadWrite |
Octroie l’accès en lecture et écriture au contenu dans le tableau de bord |
| ReadReshare |
Accorde l’accès en lecture et repartage au contenu dans le tableau de bord |
| ReadCopy |
Octroie l’accès en lecture et copie au contenu dans le tableau de bord |
| Owner |
Accorde l’accès en lecture, écriture et partage à nouveau au contenu dans le rapport |
PrincipalType
Type de principal
| Valeur | Description |
|---|---|
| None |
Aucun type de principal. Utiliser pour l’ensemble de l’accès au niveau de l’organisation. |
| User |
Type de principal de l’utilisateur |
| Group |
Type de principal de groupe |
| App |
Type de principal de service |
ServicePrincipalProfile
Profil de principal du service Power BI. Uniquement pertinent pour la solution multilocataire Power BI Embedded.
| Nom | Type | Description |
|---|---|---|
| displayName |
string |
Nom du profil du principal de service |
| id |
string (uuid) |
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 (uuid) |
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 |
| attachmentFormat |
string |
Format du rapport joint dans l’abonnement par e-mail |
| endDate |
string (date-time) |
Date et heure de fin de l’abonnement par e-mail |
| frequency |
string |
Fréquence de l’abonnement par e-mail |
| id |
string (uuid) |
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-time) |
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 |
Détails de chaque abonné à l’e-mail. Lorsque vous utilisez l’appel d’API Get User Subscriptions As Admin , 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 de rapport en tant qu’administrateur ou Obtenir des abonnements de tableau de bord en tant qu’API d’administration . |
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 |
Type de principal |
|
| profile |
Profil de principal du service Power BI. Uniquement pertinent pour la solution multilocataire Power BI Embedded. |
|
| userType |
string |
Type de l’utilisateur. |