Admin - Reports GetReportSubscriptionsAsAdmin

Référence

Service:: Power BI REST APIs

API Version:: v1.0

Retourne une liste d’abonnements aux rapports avec les détails de l’abonné. Il s’agit d’un appel d’API en préversion.

Autorisations

L’utilisateur doit disposer de droits d’administrateur (par exemple, 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.

Étendue requise

Tenant.Read.All ou Tenant.ReadWrite.All

Limites

Maximum 200 demandes par heure.

GET https://api.powerbi.com/v1.0/myorg/admin/reports/{reportId}/subscriptions

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
reportId	path	True	string uuid	ID de rapport

Réponses

Nom	Type	Description
200 OK	Subscriptions	Ok

Exemples

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/reports/{reportId}/subscriptions

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "18b746fe-c6d5-4a00-9523-05dc91424274",
      "title": "TestReportSubscription-1",
      "artifactId": "7b71b90a-a333-4006-b12c-ef3d767fa4e9",
      "artifactDisplayName": "Customer Profitability Sample",
      "subArtifactDisplayName": "Team Scorecard",
      "artifactType": "Report",
      "isEnabled": true,
      "frequency": "Daily",
      "startDate": "10/13/2021 12:00:00 AM",
      "endDate": "10/13/2022 12:00:00 AM",
      "linkToContent": true,
      "previewImage": true,
      "attachmentFormat": "PNG",
      "users": [
        {
          "displayName": "John Nick",
          "emailAddress": "john@contoso.com",
          "identifier": "john@contoso.com",
          "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
          "principalType": "User"
        }
      ]
    }
  ]
}

Définitions

Nom	Description
PrincipalType	Type principal
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)
Subscriptions	Wrapper de réponse OData pour un abonnement Power BI
SubscriptionUser	Un utilisateur d’abonnement de messagerie Power BI

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

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.

Subscriptions

Wrapper de réponse OData pour un abonnement Power BI

Nom	Type	Description
odata.context	string
value	Subscription[]	Abonnement par e-mail Power BI

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. Concerne uniquement Power BI Embedded solution mutualisée.
userType	string	Type de l’utilisateur.

Partager via