Partager via

Admin - Users GetUserSubscriptionsAsAdmin

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

Retourne une liste d’abonnements pour l’utilisateur spécifié. Il s’agit d’un appel d’API en préversion.

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.

Étendue requise

Tenant.Read.All ou Tenant.ReadWrite.All

Limites

Maximum 200 requêtes par heure. 

GET https://api.powerbi.com/v1.0/myorg/admin/users/{userId}/subscriptions
Avec des paramètres facultatifs: 
GET https://api.powerbi.com/v1.0/myorg/admin/users/{userId}/subscriptions?continuationToken={continuationToken}

Paramètres URI

Nom Dans Obligatoire Type Description
userId
 path True

string

ID de graphique ou nom d’utilisateur principal (UPN) de l’utilisateur
continuationToken
 query

string

Jeton requis pour obtenir le segment suivant du jeu de résultats

Réponses

Nom Type Description
200 OK

SubscriptionsByUserResponse

Ok

Exemples

Example

Exemple de requête

GET https://api.powerbi.com/v1.0/myorg/admin/users/f089354e-8366-4e18-aea3-4cb4a3a50b48/subscriptions

Exemple de réponse

Code d’état:
200 
{
  "subscriptionEntities": [
    {
      "id": "9225d0bc-9f5e-4819-a637-799c0c4fh3f1",
      "title": "Team Scorecard-test",
      "artifactId": "0b50f0bf-b22b-4685-83b9-b6d17f7f4e46",
      "artifactDisplayName": "Customer Profitability Sample",
      "subArtifactDisplayName": "Team Scorecard",
      "artifactType": "Report",
      "isEnabled": false,
      "frequency": "Daily",
      "startDate": "8/10/2021 12:00:00 AM",
      "endDate": "8/10/2022 12:00:00 AM",
      "linkToContent": false,
      "previewImage": true,
      "attachmentFormat": "PNG",
      "users": []
    }
  ],
  "continuationUri": "https://api.powerbi.com/v1.0/myorg/admin/users/f089354e-8366-4e18-aea3-4cb4a3a50b48/subscriptions?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

Définitions

Nom Description
PrincipalType

Type de principal
ServicePrincipalProfile

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)
SubscriptionsByUserResponse

Wrapper de réponse OData pour un abonnement Power BI pour l’utilisateur
SubscriptionUser

Un utilisateur d’abonnement de messagerie Power BI

PrincipalType

Énumération

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

Object

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

Object

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 Report, Dashboardou Dataset)
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

SubscriptionUser[]

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 .

SubscriptionsByUserResponse

Object

Wrapper de réponse OData pour un abonnement Power BI pour l’utilisateur

Nom Type Description
@odata.context

string

continuationToken

string

Jeton pour obtenir le segment suivant du jeu de résultats
continuationUri

string

URI du segment suivant dans le jeu de résultats
subscriptionEntities

Subscription[]

Abonnements pour l’utilisateur

SubscriptionUser

Object

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 la solution multilocataire Power BI Embedded.
userType

string

Type de l’utilisateur.