Admin - Users GetUserSubscriptionsAsAdmin

Ссылка

Service:: Power BI REST APIs

API Version:: v1.0

Возвращает список подписок для указанного пользователя. Это вызов API предварительной версии.

Разрешения

Пользователь должен иметь права администратора (например, Office 365 глобального администратора или администратора службы Power BI) или пройти проверку подлинности с помощью субъекта-службы.
Поддерживаются делегированные разрешения.

Требуемая область

Tenant.Read.All или Tenant.ReadWrite.All

Ограничения

Максимум 200 запросов в час.

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}

Параметры URI

Имя	В	Обязательно	Тип	Описание
userId	path	True	string	Идентификатор графа или имя участника-пользователя (UPN) пользователя
continuationToken	query		string	Маркер, необходимый для получения следующего блока результирующих наборов

Ответы

Имя	Тип	Описание
200 OK	SubscriptionsByUserResponse	ОК

Примеры

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"
}

Определения

Имя	Описание
PrincipalType	Тип субъекта
ServicePrincipalProfile	Профиль субъекта служба Power BI. Применимо только для Power BI Embedded мультитенантного решения.
Subscription	Подписка электронной почты на элемент Power BI (например, отчет или панель мониторинга)
SubscriptionsByUserResponse	Оболочка ответа OData для подписок Power BI для пользователя
SubscriptionUser	Пользователь подписки на электронную почту Power BI

PrincipalType

Тип субъекта

Имя	Тип	Описание
App	string	Тип субъекта-службы
Group	string	Тип субъекта-группы
None	string	Нет основного типа. Используйте для доступа на уровне всей организации.
User	string	Тип субъекта-пользователя

ServicePrincipalProfile

Профиль субъекта служба Power BI. Применимо только для Power BI Embedded мультитенантного решения.

Имя	Тип	Описание
displayName	string	Имя профиля субъекта-службы
id	string	Идентификатор профиля субъекта-службы

Subscription

Подписка электронной почты на элемент Power BI (например, отчет или панель мониторинга)

Имя	Тип	Описание
artifactDisplayName	string	Имя подписанного элемента Power BI (например, отчета или панели мониторинга)
artifactId	string	Идентификатор элемента Power BI с подпиской (например, отчета или панели мониторинга)
artifactType	string	Тип элемента Power BI (например `Report`, , `Dashboard`или `Dataset`)
attachmentFormat	string	Формат отчета, вложенного в подписку электронной почты
endDate	string	Дата и время окончания подписки электронной почты
frequency	string	Частота подписки на электронную почту
id	string	Идентификатор подписки
isEnabled	boolean	Включена ли подписка на электронную почту
linkToContent	boolean	Существует ли ссылка на подписку в подписке электронной почты
previewImage	boolean	Существует ли снимок экрана отчета в подписке электронной почты
startDate	string	Дата и время начала подписки на электронную почту
subArtifactDisplayName	string	Имя страницы подписанного элемента Power BI, если это отчет.
title	string	Имя приложения
users	SubscriptionUser[]	Сведения о каждом подписчике электронной почты. При использовании вызова API Get User Subscriptions As Администратор возвращаемым значением является пустой массив (null). Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Сведения о подписке можно получить в отчете или на панели мониторинга Power BI с помощью команд API Получение подписок на отчеты как Администратор или Получение подписок панели мониторинга как Администратор вызовов API.

SubscriptionsByUserResponse

Оболочка ответа OData для подписок Power BI для пользователя

Имя	Тип	Описание
continuationToken	string	Маркер для получения следующего блока результирующих наборов
continuationUri	string	Универсальный код ресурса (URI) для следующего блока в результирующем наборе
odata.context	string
subscriptionEntities	Subscription[]	Подписки для пользователя

SubscriptionUser

Пользователь подписки на электронную почту Power BI

Имя	Тип	Описание
displayName	string	Отображаемое имя субъекта
emailAddress	string	Адрес электронной почты пользователя
graphId	string	Идентификатор субъекта в Microsoft Graph. Доступно только для api-интерфейсов администратора.
identifier	string	Идентификатор субъекта
principalType	PrincipalType	Тип субъекта
profile	ServicePrincipalProfile	Профиль субъекта служба Power BI. Применимо только для Power BI Embedded мультитенантного решения.
userType	string	Тип пользователя.

Поделиться через