Push Datasets - Datasets PostDatasetInGroup

Service:

Power BI REST APIs

API Version:

v1.0

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

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

Dataset.ReadWrite.All

Ограничения

Этот вызов API поддерживает только push-наборы данных. Полный список ограничений см. в разделе Ограничения для принудительной отправки наборов данных.

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

With optional parameters:

POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets?defaultRetentionPolicy={defaultRetentionPolicy}

Параметры URI

Имя	В	Обязательно	Тип	Описание
groupId	path	True	string uuid	идентификатор рабочей области;
defaultRetentionPolicy	query		DefaultRetentionPolicy	Политика хранения по умолчанию

Текст запроса

Имя	Обязательно	Тип	Описание
name	True	string	Имя набора данных
tables	True	Table[]	Таблицы наборов данных
datasources		Datasource[]	Источники данных, связанные с этим набором данных
defaultMode		DatasetMode	Режим или тип набора данных
relationships		Relationship[]	Связи наборов данных

Ответы

Имя	Тип	Описание
201 Created	Dataset	Создание
202 Accepted	Dataset	Принято

Примеры

Push example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets?defaultRetentionPolicy=basicFIFO

Request Body

{
  "name": "SalesMarketing",
  "defaultMode": "Push",
  "tables": [
    {
      "name": "Product",
      "columns": [
        {
          "name": "ProductID",
          "dataType": "Int64"
        },
        {
          "name": "Name",
          "dataType": "string"
        },
        {
          "name": "Category",
          "dataType": "string"
        },
        {
          "name": "IsCompete",
          "dataType": "bool"
        },
        {
          "name": "ManufacturedOn",
          "dataType": "DateTime"
        },
        {
          "name": "Sales",
          "dataType": "Int64",
          "formatString": "Currency"
        }
      ]
    }
  ]
}

Sample Response

Status code:

201

{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "name": "SalesMarketing",
  "defaultRetentionPolicy": "basicFIFO"
}

Определения

Имя	Описание
ASMashupExpression	Источник таблицы набора данных
Column	Столбец набора данных
CreateDatasetRequest	Набор данных Power BI
CrossFilteringBehavior	Направление фильтра связи
Dataset	Набор данных Power BI. API возвращает подмножество из следующего списка свойств набора данных. Подмножество зависит от вызываемого API, разрешений вызывающего объекта и доступности данных в базе данных Power BI.
DatasetMode	Режим или тип набора данных
DatasetQueryScaleOutSettings	Параметры масштабирования запроса для набора данных
DatasetUser	Запись права доступа пользователя Power BI для набора данных
DatasetUserAccessRight	Право доступа, которое пользователь имеет для набора данных (уровень разрешений)
Datasource	Источник данных Power BI
DatasourceConnectionDetails	Сведения о подключении к источнику данных Power BI. Примеры см. в разделах Получение источников данных или Получение источников данных в группе.
DefaultRetentionPolicy	Политика хранения по умолчанию
DependentDataflow	Поток данных, зависящий от Power BI
Encryption	Сведения о шифровании для набора данных
EncryptionStatus	Состояние шифрования набора данных
Measure	Мера Power BI
PrincipalType	Тип субъекта
Relationship	Связь между таблицами в наборе данных
Row	Строка данных в наборе данных
ServicePrincipalProfile	Профиль субъекта служба Power BI. Применимо только для Power BI Embedded мультитенантного решения.
Table	Таблица наборов данных

ASMashupExpression

Источник таблицы набора данных

Имя	Тип	Описание
expression	string	Исходное выражение

Column

Столбец набора данных

Имя	Тип	Описание
dataCategory	string	Необязательный элемент. Строковое значение, используемое для категории данных, описывающей данные в этом столбце.
dataType	string	Тип данных столбца
formatString	string	Необязательный элемент. Формат столбца, указанный в FORMAT_STRING.
isHidden	boolean	Необязательный элемент. Является ли столбец скрытым. Значение по умолчанию — false.
name	string	Имя столбца
sortByColumn	string	Необязательный элемент. Строка, представляющая собой название столбца в той же таблице, который нужно использовать для сортировки текущего столбца.
summarizeBy	string	Необязательный элемент. Агрегатная функция, используемая для суммирования этого столбца.

CreateDatasetRequest

Набор данных Power BI

Имя	Тип	Описание
datasources	Datasource[]	Источники данных, связанные с этим набором данных
defaultMode	DatasetMode	Режим или тип набора данных
name	string	Имя набора данных
relationships	Relationship[]	Связи наборов данных
tables	Table[]	Таблицы наборов данных

CrossFilteringBehavior

Направление фильтра связи

Имя	Тип	Описание
Automatic	string	Поведение перекрестной фильтрации определяется автоматически
BothDirections	string	В целях фильтрации обе таблицы обрабатываются как одна таблица.
OneDirection	string	В целях фильтрации фильтр будет применяться к таблице, в которой вычисляются значения.

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-адрес набора данных

DatasetMode

Режим или тип набора данных

Имя	Тип	Описание
AsAzure	string	Набор данных с динамическим подключением к Azure Analysis Services
AsOnPrem	string	Набор данных с динамическим подключением к локальной Azure Analysis Services
Push	string	Набор данных, обеспечивающий программный доступ для отправки данных в Power BI.
PushStreaming	string	Набор данных, поддерживающий потоковую передачу данных и обеспечивающий программный доступ для отправки данных в Power BI.
Streaming	string	Набор данных, поддерживающий потоковую передачу данных. Дополнительные сведения см. в статье Потоковая передача данных в реальном времени в Power BI.

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	Предоставляет доступ для чтения, записи, повторного доступа и просмотра к содержимому в наборе данных.

Datasource

Источник данных Power BI

Имя	Тип	Описание
connectionDetails	DatasourceConnectionDetails	Сведения о подключении к источнику данных
connectionString	string	(Не рекомендуется) Источник данных строка подключения. Доступно только для DirectQuery.
datasourceId	string	Идентификатор привязанного источника данных, который пуст, если он не привязан к шлюзу.
datasourceType	string	Тип источника данных
gatewayId	string	Идентификатор привязанного шлюза, который пуст, если он не привязан к шлюзу. При использовании кластера шлюза идентификатор шлюза относится к основному (первому) шлюзу в кластере и аналогичен идентификатору кластера шлюза.
name	string	(Не рекомендуется) Имя источника данных. Доступно только для DirectQuery.

DatasourceConnectionDetails

Сведения о подключении к источнику данных Power BI. Примеры см. в разделах Получение источников данных или Получение источников данных в группе.

Имя	Тип	Описание
account	string	Учетная запись подключения
classInfo	string	Сведения о классе подключения
database	string	База данных подключения
domain	string	Домен подключения
emailAddress	string	Адрес электронной почты подключения
kind	string	Тип подключения
loginServer	string	Сервер входа подключения
path	string	Путь подключения
server	string	Сервер подключения
url	string	URL-адрес подключения

DefaultRetentionPolicy

Политика хранения по умолчанию

Имя	Тип	Описание
None	string	Нет
basicFIFO	string	basicFIFO

DependentDataflow

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

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

Encryption

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

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

EncryptionStatus

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

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

Measure

Мера Power BI

Имя	Тип	Описание
description	string	Необязательный элемент. Описание меры.
expression	string	Допустимое выражение DAX
formatString	string	Необязательный элемент. Строка, описывающая форматирование значения при его отображении, как указано в FORMAT_STRING.
isHidden	boolean	Необязательный элемент. Скрыта ли мера.
name	string	Имя меры

PrincipalType

Тип субъекта

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

Relationship

Связь между таблицами в наборе данных

Имя	Тип	Значение по умолчанию	Описание
crossFilteringBehavior	CrossFilteringBehavior	OneDirection	Направление фильтра связи
fromColumn	string		Имя столбца внешнего ключа
fromTable	string		Имя таблицы внешних ключей
name	string		Имя и идентификатор связи
toColumn	string		Имя столбца первичного ключа
toTable	string		Имя таблицы первичного ключа

Row

Строка данных в наборе данных

Имя	Тип	Описание
id	string	Уникальный идентификатор строки

ServicePrincipalProfile

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

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

Table

Таблица наборов данных

Имя	Тип	Описание
columns	Column[]	Схема столбцов для этой таблицы
description	string	Описание таблицы
isHidden	boolean	Необязательный элемент. Скрыта ли эта таблица набора данных.
measures	Measure[]	Меры в этой таблице
name	string	имя таблицы;
rows	Row[]	Строки данных в этой таблице
source	ASMashupExpression[]	Источник таблицы