Admin - Users GetUserSubscriptionsAsAdmin

Referencia

Service:: Power BI REST APIs

API Version:: v1.0

Devuelve una lista de suscripciones para el usuario especificado. Se trata de una llamada API en versión preliminar.

Permisos

El usuario debe tener derechos de administrador (como Office 365 administrador global o administrador del servicio Power BI) o autenticarse mediante una entidad de servicio.
Se admiten permisos delegados.

Ámbito requerido

Tenant.Read.All o Tenant.ReadWrite.All

Limitaciones

Máximo de 200 solicitudes por hora.

GET https://api.powerbi.com/v1.0/myorg/admin/users/{userId}/subscriptions

With optional parameters:

GET https://api.powerbi.com/v1.0/myorg/admin/users/{userId}/subscriptions?continuationToken={continuationToken}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
userId	path	True	string	Identificador de grafo o nombre principal de usuario (UPN) del usuario
continuationToken	query		string	Token necesario para obtener el siguiente fragmento del conjunto de resultados

Respuestas

Nombre	Tipo	Description
200 OK	SubscriptionsByUserResponse	Aceptar

Ejemplos

Example

Sample Request

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

Sample Response

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

Definiciones

Nombre	Description
PrincipalType	El tipo de entidad de seguridad
ServicePrincipalProfile	Un perfil principal de servicio Power BI. Solo es relevante para Power BI Embedded solución multiinquilino.
Subscription	Una suscripción de correo electrónico para un elemento de Power BI (por ejemplo, un informe o un panel)
SubscriptionsByUserResponse	Contenedor de respuesta de OData para suscripciones de Power BI para el usuario
SubscriptionUser	Un usuario de suscripción de correo electrónico de Power BI

PrincipalType

El tipo de entidad de seguridad

Nombre	Tipo	Description
App	string	Tipo de entidad de servicio
Group	string	Tipo de entidad de seguridad de grupo
None	string	No hay ningún tipo de entidad de seguridad. Se usa para el acceso de nivel de organización completo.
User	string	Tipo de entidad de seguridad de usuario

ServicePrincipalProfile

Un perfil principal de servicio Power BI. Solo es relevante para Power BI Embedded solución multiinquilino.

Nombre	Tipo	Description
displayName	string	Nombre del perfil de entidad de servicio
id	string	Identificador del perfil de entidad de servicio

Subscription

Una suscripción de correo electrónico para un elemento de Power BI (por ejemplo, un informe o un panel)

Nombre	Tipo	Description
artifactDisplayName	string	Nombre del elemento de Power BI suscrito (por ejemplo, un informe o un panel)
artifactId	string	Identificador del elemento de Power BI suscrito (por ejemplo, un informe o un panel)
artifactType	string	Tipo de elemento de Power BI (por ejemplo, `Dashboard`, `Report`o `Dataset`).
attachmentFormat	string	Formato del informe adjunto en la suscripción de correo electrónico
endDate	string	Fecha y hora de finalización de la suscripción de correo electrónico
frequency	string	Frecuencia de la suscripción de correo electrónico
id	string	Identificador de suscripción
isEnabled	boolean	Si la suscripción de correo electrónico está habilitada
linkToContent	boolean	Si existe un vínculo de suscripción en la suscripción de correo electrónico
previewImage	boolean	Si existe una captura de pantalla del informe en la suscripción de correo electrónico
startDate	string	Fecha y hora de inicio de la suscripción de correo electrónico
subArtifactDisplayName	string	Nombre de página del elemento de Power BI suscrito, si es un informe.
title	string	El nombre de la aplicación
users	SubscriptionUser[]	Los detalles de cada suscriptor de correo electrónico. Al usar la llamada API Get User Subscriptions As Administración, el valor devuelto es una matriz vacía (null). Esta propiedad se quitará de la respuesta de carga en una próxima versión. Puede recuperar información de suscripción en un informe o panel de Power BI mediante las llamadas api obtener suscripciones de informe como Administración o Obtener suscripciones de panel como Administración llamadas API.

SubscriptionsByUserResponse

Contenedor de respuesta de OData para suscripciones de Power BI para el usuario

Nombre	Tipo	Description
continuationToken	string	Token para obtener el siguiente fragmento del conjunto de resultados
continuationUri	string	URI del siguiente fragmento del conjunto de resultados
odata.context	string
subscriptionEntities	Subscription[]	Las suscripciones para el usuario

SubscriptionUser

Un usuario de suscripción de correo electrónico de Power BI

Nombre	Tipo	Description
displayName	string	Nombre para mostrar de la entidad de seguridad
emailAddress	string	Dirección de correo electrónico del usuario
graphId	string	Identificador de la entidad de seguridad en Microsoft Graph. Solo está disponible para las API de administrador.
identifier	string	Identificador de la entidad de seguridad
principalType	PrincipalType	El tipo de entidad de seguridad
profile	ServicePrincipalProfile	Un perfil principal de servicio Power BI. Solo es relevante para Power BI Embedded solución multiinquilino.
userType	string	Tipo del usuario.

Compartir a través de