Admin - Dashboards GetDashboardsAsAdmin
Retourne une liste de tableaux de bord 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 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. Prise en charge de |
|
$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 |
Ok |
Exemples
Example
Sample Request
GET https://api.powerbi.com/v1.0/myorg/admin/dashboards
Sample Response
{
"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 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. |
Admin |
Wrapper de réponse OData pour une collection de tableaux de bord Power BI |
Admin |
Vignette Power BI retournée par Administration API. |
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 principal |
Service |
Profil principal service Power BI. Ne concerne que Power BI Embedded solution multilocataire. |
Subscription |
Un abonnement de messagerie 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 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 d’affichage 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 |
(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 version à venir. Vous pouvez récupérer des informations d’abonnement pour un rapport Power BI à l’aide de l’option Obtenir des abonnements de rapport en tant qu’appel d’API Administration. |
|
tiles |
Vignettes qui appartiennent 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 version à venir. 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 comme Administration appel d’API, ou de l’appel d’API PostWorkspaceInfo avec le |
|
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. |
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 Administration API.
Nom | Type | Description |
---|---|---|
colSpan |
integer |
Nombre de colonnes d’étendue de vignettes |
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 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 mosaïque |
title |
string |
Nom d’affichage 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 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 |
Type principal |
|
profile |
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 |
PrincipalType
Type principal
Nom | Type | Description |
---|---|---|
App |
string |
Type de principal de service |
Group |
string |
Type de principal de groupe |
None |
string |
Aucun type principal. Utilisez pour un accès de niveau organization entier. |
User |
string |
Type de principal d’utilisateur |
ServicePrincipalProfile
Profil principal service Power BI. Ne concerne que Power BI Embedded solution multilocataire.
Nom | Type | Description |
---|---|---|
displayName |
string |
Nom du profil principal de service |
id |
string |
ID de profil du principal de service |
Subscription
Un abonnement de messagerie 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 |
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 |
Si l’abonnement de messagerie 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 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. 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 version à venir. 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 Get Report Subscriptions As Administration ou Get Dashboard Subscriptions As 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 |
Type principal |
|
profile |
Profil principal service Power BI. Ne concerne que Power BI Embedded solution multilocataire. |
|
userType |
string |
Type de l’utilisateur. |