Datasets - Get Dataset

Ссылка

Service:: Power BI REST APIs

API Version:: v1.0

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

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

Dataset.ReadWrite.All или Dataset.Read.All

GET https://api.powerbi.com/v1.0/myorg/datasets/{datasetId}

Параметры URI

Имя	В	Обязательно	Тип	Описание
datasetId	path	True	string	Идентификатор набора данных

Ответы

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

Примеры

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229

Sample Response

Status code:: 200

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

Определения

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

Dataset

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

Имя	Тип	Описание
ContentProviderType	string	Тип поставщика контента для набора данных
CreateReportEmbedURL	string	URL-адрес внедрения отчета создания набора данных
CreatedDate	string	Дата и время создания набора данных
Encryption	Encryption	Сведения о шифровании набора данных. Применимо, только если `$expand` указан параметр .
IsEffectiveIdentityRequired	boolean	Требуется ли набору данных действующее удостоверение, которое необходимо отправить в вызове API GenerateToken .
IsEffectiveIdentityRolesRequired	boolean	Определяется ли безопасность на уровне строк в PBIX-файле Power BI. Если да, необходимо указать роль.
IsInPlaceSharingEnabled	boolean	Можно ли предоставить доступ к набору данных внешним пользователям для использования в их собственном клиенте
IsOnPremGatewayRequired	boolean	Требуется ли набору данных локальный шлюз данных
IsRefreshable	boolean	Является ли набор данных обновляемым или нет. Обновляемый набор данных Power BI — это набор данных, который обновлялся по крайней мере один раз или для которого существует допустимое расписание обновления.
QnaEmbedURL	string	URL-адрес внедрения набора данных Q&A
addRowsAPIEnabled	boolean	Позволяет ли набор данных добавлять новые строки
configuredBy	string	Владелец набора данных
description	string	Описание набора данных
id	string	Идентификатор набора данных
name	string	Имя набора данных
queryScaleOutSettings	DatasetQueryScaleOutSettings	Параметры масштабирования запроса для набора данных
targetStorageMode	string	Режим хранения набора данных
upstreamDataflows	DependentDataflow[]	Список всех потоков данных, от которые зависит этот элемент
users	DatasetUser[]	(Пустое значение) Сведения о доступе пользователя к набору данных. Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Сведения о пользователях элемента Power BI (например, отчет или панель мониторинга) можно получить с помощью API получения набора данных в качестве Администратор API или API PostWorkspaceInfo с параметром `getArtifactUsers` .
webUrl	string	URL-адрес набора данных

DatasetQueryScaleOutSettings

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

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

DatasetUser

Запись права доступа пользователя 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	string	Удаляет разрешение на содержимое в наборе данных.
Read	string	Предоставляет доступ на чтение к содержимому в наборе данных.
ReadExplore	string	Предоставляет доступ на чтение и просмотр к содержимому в наборе данных
ReadReshare	string	Предоставляет доступ для чтения и повторного доступа к содержимому в наборе данных.
ReadReshareExplore	string	Предоставляет доступ для чтения, повторного доступа и просмотра к содержимому в наборе данных.
ReadWrite	string	Предоставляет доступ на чтение и запись к содержимому в наборе данных.
ReadWriteExplore	string	Предоставляет доступ для чтения, записи и просмотра к содержимому в наборе данных.
ReadWriteReshare	string	Предоставляет доступ для чтения, записи и повторного доступа к содержимому в наборе данных.
ReadWriteReshareExplore	string	Предоставляет доступ для чтения, записи, повторного доступа и просмотра к содержимому в наборе данных.

DependentDataflow

Поток данных, зависящий от Power BI

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

Encryption

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

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

EncryptionStatus

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

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

PrincipalType

Тип субъекта

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

ServicePrincipalProfile

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

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