Admin - Dashboards GetDashboardsAsAdmin

Возвращает список панелей мониторинга для организации.

Разрешения

  • Пользователь должен быть администратором Fabric или пройти проверку подлинности с помощью субъекта-службы.
  • Поддерживаются делегированные разрешения.

При выполнении в рамках проверки подлинности службы приложения не должны иметь необходимые разрешения администратора для Power BI, заданные на портале Azure.

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

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

Важно только при проверке подлинности через стандартный делегированный маркер доступа администратора. Не должно присутствовать при использовании проверки подлинности через субъект-службу.

Ограничения

Максимум 50 запросов в час или 5 запросов в минуту для каждого клиента.

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}

Параметры URI

Имя В Обязательно Тип Описание
$expand
query

string

Принимает разделенный запятыми список типов данных, который будет развернут встроенным в ответе. Поддерживает tiles.

$filter
query

string

Возвращает подмножество результатов на основе условия параметра запроса Odata Odata фильтра.

$skip
query

integer (int32)

Пропускает первые результаты n

$top
query

integer (int32)

Возвращает только первые результаты n

Ответы

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

AdminDashboards

ХОРОШО

Примеры

Example

Образец запроса

GET https://api.powerbi.com/v1.0/myorg/admin/dashboards

Пример ответа

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

Определения

Имя Описание
AdminDashboard

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

AdminDashboards

Оболочка ответа OData для коллекции панелей мониторинга Power BI

AdminTile

Плитка Power BI, возвращаемая API администратора.

DashboardUser

Правая запись доступа пользователя Power BI для панели мониторинга

DashboardUserAccessRight

Право доступа, которое пользователь имеет для панели мониторинга (уровень разрешений)

PrincipalType

Тип субъекта

ServicePrincipalProfile

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

Subscription

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

SubscriptionUser

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

AdminDashboard

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

Имя Тип Описание
appId

string

Идентификатор приложения, возвращенный только в том случае, если панель мониторинга принадлежит приложению

displayName

string

Отображаемое имя панели мониторинга

embedUrl

string

URL-адрес внедрения панели мониторинга

id

string (uuid)

Идентификатор панели мониторинга

isReadOnly

boolean

Является ли панель мониторинга доступной только для чтения

subscriptions

Subscription[]

(Пустое значение) Сведения о подписке для элемента Power BI (например, отчета или панели мониторинга). Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Сведения о подписке для отчета Power BI можно получить с помощью вызова API получения подписок отчета в качестве администратора API.

tiles

AdminTile[]

Плитки, принадлежащие панели мониторинга

users

DashboardUser[]

(Пустое значение) Сведения о доступе пользователя к панели мониторинга. Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Вы можете получить сведения о пользователях на панели мониторинга Power BI с помощью вызова API получения пользователей панели мониторинга в качестве администратора или вызова API PostWorkspaceInfo с параметром getArtifactUsers.

webUrl

string

URL-адрес веб-панели мониторинга

workspaceId

string (uuid)

Идентификатор рабочей области (GUID) панели мониторинга. Это свойство будет возвращено только в GetDashboardsAsAdmin.

AdminDashboards

Оболочка ответа OData для коллекции панелей мониторинга Power BI

Имя Тип Описание
@odata.context

string

Контекст OData

value

AdminDashboard[]

Коллекция панелей мониторинга

AdminTile

Плитка Power BI, возвращаемая API администратора.

Имя Тип Описание
colSpan

integer

Количество столбцов диапазона плиток

datasetId

string

Идентификатор набора данных. Доступно только для плиток, созданных из отчета или с помощью набора данных, например Q&плитки A.

embedData

string

Данные внедрения для плитки

embedUrl

string

URL-адрес внедрения плитки

id

string (uuid)

Идентификатор плитки

reportId

string (uuid)

Идентификатор отчета. Доступно только для плиток, созданных из отчета.

rowSpan

integer

Количество строк диапазона плиток

title

string

Отображаемое имя плитки

DashboardUser

Правая запись доступа пользователя Power BI для панели мониторинга

Имя Тип Описание
dashboardUserAccessRight

DashboardUserAccessRight

Право доступа, которое пользователь имеет для панели мониторинга (уровень разрешений)

displayName

string

Отображаемое имя субъекта

emailAddress

string

Адрес электронной почты пользователя

graphId

string

Идентификатор субъекта в Microsoft Graph. Доступно только для API администрирования.

identifier

string

Идентификатор субъекта

principalType

PrincipalType

Тип субъекта

profile

ServicePrincipalProfile

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

userType

string

Тип пользователя.

DashboardUserAccessRight

Право доступа, которое пользователь имеет для панели мониторинга (уровень разрешений)

Значение Описание
None

Нет разрешения на содержимое на панели мониторинга

Read

Предоставляет доступ на чтение к содержимому на панели мониторинга

ReadWrite

Предоставляет доступ на чтение и запись к содержимому на панели мониторинга

ReadReshare

Предоставляет доступ на чтение и повторное предоставление доступа к содержимому на панели мониторинга

ReadCopy

Предоставляет доступ на чтение и копирование содержимого на панели мониторинга

Owner

Предоставляет доступ к содержимому в отчете для чтения, записи и повторного доступа к содержимому

PrincipalType

Тип субъекта

Значение Описание
None

Нет типа субъекта. Используется для доступа на уровне всей организации.

User

Тип субъекта-пользователя

Group

Тип субъекта-группы

App

Тип субъекта-службы

ServicePrincipalProfile

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

Имя Тип Описание
displayName

string

Имя профиля субъекта-службы

id

string (uuid)

Идентификатор профиля субъекта-службы

Subscription

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

Имя Тип Описание
artifactDisplayName

string

Имя подписанного элемента Power BI (например, отчета или панели мониторинга)

artifactId

string (uuid)

Идентификатор подписанного элемента Power BI (например, отчета или панели мониторинга)

artifactType

string

Тип элемента Power BI (например, Report, Dashboardили Dataset)

attachmentFormat

string

Формат отчета, присоединенного к подписке электронной почты

endDate

string (date-time)

Дата окончания и время подписки электронной почты

frequency

string

Частота подписки электронной почты

id

string (uuid)

Идентификатор подписки

isEnabled

boolean

Включена ли подписка на электронную почту

linkToContent

boolean

Существует ли ссылка на подписку электронной почты

previewImage

boolean

Наличие снимка экрана отчета в подписке электронной почты

startDate

string (date-time)

Дата начала и время подписки электронной почты

subArtifactDisplayName

string

Имя страницы подписанного элемента Power BI, если это отчет.

title

string

Имя приложения

users

SubscriptionUser[]

Сведения о каждом подписчике электронной почты. При использовании вызова API получения подписок пользователей от имени администратора возвращается возвращаемое значение пустого массива (NULL). Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Вы можете получить сведения о подписке в отчете Или панели мониторинга Power BI с помощью получения подписок отчетов от имени администратора или получения подписок панели мониторинга от имени администратора вызовов API.

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

Тип пользователя.