Admin - Datasets GetDatasetsInGroupAsAdmin

Ссылка

Служба:: Power BI REST APIs

Версия API:: v1.0

Возвращает список наборов данных из указанной рабочей области.

Разрешения

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

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

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

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

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

Ограничения

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

GET https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/datasets

С использованием необязательных параметров:

GET https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/datasets?$filter={$filter}&$top={$top}&$skip={$skip}&$expand={$expand}

Параметры URI

Имя	В	Обязательно	Тип	Описание
groupId	path	True	string (uuid)	Идентификатор рабочей области
$expand	query		string	Расширяет встроенные связанные сущности
$filter	query		string	Возвращает подмножество результатов на основе условия параметра запроса Odata Odata фильтра.
$skip	query		integer (int32)	Пропускает первые результаты n
$top	query		integer (int32)	Возвращает только первые результаты n

Ответы

Имя	Тип	Описание
200 OK	AdminDatasets	ХОРОШО

Примеры

Example

Example with expand on encryption

Example

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

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

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

Код состояния:: 200

{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "name": "SalesMarketing",
      "addRowsAPIEnabled": false,
      "configuredBy": "john@contoso.com",
      "isRefreshable": true,
      "isEffectiveIdentityRequired": false,
      "isEffectiveIdentityRolesRequired": false,
      "isOnPremGatewayRequired": false,
      "isInPlaceSharingEnabled": false
    }
  ]
}

Example with expand on encryption

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

GET https://api.powerbi.com/v1.0/myorg/admin/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets?$expand=encryption

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

Код состояния:: 200

{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "name": "SalesMarketing",
      "addRowsAPIEnabled": false,
      "configuredBy": "john@contoso.com",
      "isRefreshable": true,
      "isEffectiveIdentityRequired": false,
      "isEffectiveIdentityRolesRequired": false,
      "isOnPremGatewayRequired": false,
      "isInPlaceSharingEnabled": false,
      "encryption": {
        "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
        "encryptionStatus": "InSyncWithWorkspace"
      }
    }
  ]
}

Определения

Имя	Описание
AdminDataset	Набор данных Power BI, возвращенный API-интерфейсами администратора. API возвращает подмножество из следующего списка свойств набора данных. Подмножество зависит от вызываемого API, разрешений вызываемого абонента и доступности данных в базе данных Power BI.
AdminDatasets	Оболочка списка odata набора данных
DatasetQueryScaleOutSettings	Параметры масштабирования запросов набора данных
DatasetUser	Запись права доступа пользователя Power BI для набора данных
DatasetUserAccessRight	Право доступа, которое пользователь имеет для набора данных (уровень разрешений)
DependentDataflow	Зависимый поток данных Power BI
Encryption	Сведения о шифровании для набора данных
EncryptionStatus	Состояние шифрования набора данных
PrincipalType	Тип субъекта
ServicePrincipalProfile	Профиль субъекта-службы Power BI. Применимо только для решения Power BI Embedded с несколькими арендами.

AdminDataset

Object

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

Имя	Тип	Описание
ContentProviderType	string	Нерекомендуемое свойство, которое следует игнорировать.
Encryption	Encryption	Сведения о шифровании набора данных. Применимо только при указании `$expand`.
IsEffectiveIdentityRequired	boolean	Требуется ли для набора данных эффективное удостоверение, которое необходимо отправить в вызов API GenerateTo ken.
IsEffectiveIdentityRolesRequired	boolean	Определяется ли безопасность на уровне строк внутри PBIX-файла Power BI. В этом случае необходимо указать роль.
IsInPlaceSharingEnabled	boolean	Может ли набор данных использоваться внешними пользователями в собственном клиенте.
IsOnPremGatewayRequired	boolean	Требуется ли для набора данных локальный шлюз данных
IsRefreshable	boolean	Это поле возвращает `true`, если набор данных недавно обновлен или настроен для автоматического обновления, при этом режим подключения специально установлен в значение Import. Значение возвращает `false` для других режимов подключения, таких как DirectQuery и LiveConnection, независимо от того, обновляется ли набор данных вручную или настроен для автоматического обновления.
addRowsAPIEnabled	boolean	Позволяет ли набор данных добавлять новые строки
configuredBy	string	Владелец набора данных
createReportEmbedURL	string	URL-адрес внедрения отчета в набор данных
createdDate	string (date-time)	Дата и время создания набора данных
description	string	Описание набора данных
id	string	Идентификатор набора данных
name	string	Имя набора данных
qnaEmbedURL	string	Url-адрес внедрения набора данных Q&A
queryScaleOutSettings	DatasetQueryScaleOutSettings	Параметры масштабирования запросов набора данных
targetStorageMode	string	Режим хранения набора данных
upstreamDataflows	DependentDataflow[]	Список всех потоков данных этого элемента зависит от
users	DatasetUser[]	(Пустое значение) Сведения о доступе пользователя к набору данных. Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Вы можете получить сведения о пользователе в элементе Power BI (например, отчете или панели мониторинга) с помощью API Получения пользователей набора данных в качестве администратора или API PostWorkspaceInfo с параметром `getArtifactUsers`.
webUrl	string	URL-адрес веб-набора данных
workspaceId	string (uuid)	Идентификатор рабочей области набора данных. Это свойство будет возвращено только в GetDatasetsAsAdmin.

AdminDatasets

Object

Оболочка списка odata набора данных

Имя	Тип	Описание
@odata.context	string	Контекст OData
value	AdminDataset[]	Наборы данных

DatasetQueryScaleOutSettings

Object

Параметры масштабирования запросов набора данных

Имя	Тип	Описание
autoSyncReadOnlyReplicas	boolean	Автоматически ли набор данных синхронизирует реплики только для чтения
maxReadOnlyReplicas	integer minimum: -1 maximum: 64	Максимальное количество реплик только для чтения для набора данных (0–64, -1 для автоматического числа реплик)

DatasetUser

Object

Запись права доступа пользователя Power BI для набора данных

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

DatasetUserAccessRight

Перечисление

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

Значение	Описание
None	Удаляет разрешение на содержимое в наборе данных
Read	Предоставляет доступ на чтение к содержимому в наборе данных
ReadExplore	Предоставляет доступ на чтение и изучение содержимого в наборе данных
ReadReshare	Предоставляет доступ на чтение и повторное предоставление доступа к содержимому в наборе данных
ReadReshareExplore	Предоставляет доступ к содержимому в наборе данных для чтения, повторного доступа и просмотра
ReadWrite	Предоставляет доступ на чтение и запись к содержимому в наборе данных
ReadWriteExplore	Предоставляет доступ на чтение, запись и изучение содержимого в наборе данных
ReadWriteReshare	Предоставляет доступ для чтения, записи и повторного доступа к содержимому в наборе данных
ReadWriteReshareExplore	Предоставляет доступ для чтения, записи, повторного доступа к содержимому в наборе данных

DependentDataflow

Object

Зависимый поток данных Power BI

Имя	Тип	Описание
groupId	string	Идентификатор целевой группы
targetDataflowId	string	Идентификатор целевого потока данных

Encryption

Object

Сведения о шифровании для набора данных

Имя	Тип	Описание
EncryptionStatus	EncryptionStatus	Состояние шифрования набора данных

EncryptionStatus

Перечисление

Состояние шифрования набора данных

Значение	Описание
InSyncWithWorkspace	Шифрование поддерживается и синхронизируется с параметрами шифрования.
NotInSyncWithWorkspace	Шифрование поддерживается, но не синхронизируется с параметрами шифрования.
NotSupported	Шифрование не поддерживается для этого набора данных
Unknown	Состояние шифрования неизвестно из-за повреждения набора данных

PrincipalType

Перечисление

Тип субъекта

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

ServicePrincipalProfile

Object

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

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

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

Admin - Datasets GetDatasetsInGroupAsAdmin

Разрешения

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

Ограничения

Параметры URI

Ответы

Примеры

Example

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

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

Example with expand on encryption

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

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

Определения

AdminDataset

AdminDatasets

DatasetQueryScaleOutSettings

DatasetUser

DatasetUserAccessRight

DependentDataflow

Encryption

EncryptionStatus

PrincipalType

ServicePrincipalProfile

Дополнительные ресурсы