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


Admin - Dashboards GetDashboardsAsAdmin

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

Разрешения

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

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

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

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

Фильтрует результаты на основе логического условия.

$skip
query

integer

int32

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

$top
query

integer

int32

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

Ответы

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

AdminDashboards

ОК

Примеры

Example

Sample Request

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

Sample Response

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

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

isReadOnly

boolean

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

subscriptions

Subscription[]

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

tiles

AdminTile[]

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

users

DashboardUser[]

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

webUrl

string

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

workspaceId

string

Идентификатор рабочей области (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

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

reportId

string

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

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

string

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

Owner

string

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

Read

string

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

ReadCopy

string

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

ReadReshare

string

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

ReadWrite

string

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

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.

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

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