Items - Create Data Pipeline
Создает конвейер данных в указанной рабочей области.
Этот API поддерживает длительные операции (LRO).
Разрешения
Вызывающий объект должен иметь участника или более поздней роли рабочей области.
Обязательные делегированные области
DataPipeline.ReadWrite.All или Item.ReadWrite.All
Ограничения
- Чтобы создать конвейер данных, рабочая область должна находиться в поддерживаемой емкости Fabric.
Поддерживаемые удостоверения Microsoft Entra
Этот API поддерживает удостоверения Microsoft , перечисленные в этом разделе.
Тождество | Поддержка |
---|---|
Пользователь | Да |
субъекта-службы и управляемых удостоверений | Да |
Интерфейс
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataPipelines
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
workspace
|
path | True |
string uuid |
Идентификатор рабочей области. |
Текст запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
displayName | True |
string |
Отображаемое имя конвейера данных. |
definition |
Общедоступное определение конвейера данных. |
||
description |
string |
Описание конвейера данных. Максимальная длина — 256 символов. |
Ответы
Имя | Тип | Описание |
---|---|---|
201 Created |
Успешно создано |
|
202 Accepted |
Запрос принят, подготовка конвейера данных выполняется Заголовки
|
|
Other Status Codes |
Распространенные коды ошибок:
|
Примеры
Create data pipeline example |
Create data pipeline with item definition example |
Create data pipeline example
Образец запроса
POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/dataPipelines
{
"displayName": "DataPipeline 1",
"description": "A data pipeline description"
}
Пример ответа
{
"displayName": "DataPipeline 1",
"description": "A data pipeline description",
"type": "DataPipeline",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047715"
}
Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30
Create data pipeline with item definition example
Образец запроса
POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/dataPipelines
{
"displayName": "DataPipeline 1",
"description": "A data pipeline description",
"definition": {
"parts": [
{
"path": "pipeline-content.json",
"payload": "ewogICAgInByb3BlcnRpZXMiOiB7IAogICAgICAgICJkZXNjcmlwdGlvbiI6ICJEYXRhIHBpcGVsaW5lIGRlc2NyaXB0aW9uIiwgCiAgICAgICAgImFjdGl2aXRpZXMiOiBbIAogICAgICAgICAgICB7IAogICAgICAgICAgICAgICAgIm5hbWUiOiAiV2FpdF9BY3Rpdml0eV8xIiwgCiAgICAgICAgICAgICAgICAidHlwZSI6ICJXYWl0IiwgCiAgICAgICAgICAgICAgICAiZGVwZW5kc09uIjogW10sIAogICAgICAgICAgICAgICAgInR5cGVQcm9wZXJ0aWVzIjogeyAKICAgICAgICAgICAgICAgICAgICAid2FpdFRpbWVJblNlY29uZHMiOiAyNDAgCiAgICAgICAgICAgICAgICB9IAogICAgICAgICAgICB9LAogICAgICAgICAgICB7CiAgICAgICAgICAgICAgICAibmFtZSI6ICJXYWl0X0FjdGl2aXR5XzIiLAogICAgICAgICAgICAgICAgInR5cGUiOiAiV2FpdCIsCiAgICAgICAgICAgICAgICAiZGVwZW5kc09uIjogWwogICAgICAgICAgICAgICAgICAgIHsKICAgICAgICAgICAgICAgICAgICAgICAgImFjdGl2aXR5IjogIldhaXRfQWN0aXZpdHlfMSIsCiAgICAgICAgICAgICAgICAgICAgICAgICJkZXBlbmRlbmN5Q29uZGl0aW9ucyI6IFsgIlN1Y2NlZWRlZCIgXQogICAgICAgICAgICAgICAgICAgIH0KICAgICAgICAgICAgICAgIF0sCiAgICAgICAgICAgICAgICAidHlwZVByb3BlcnRpZXMiOiB7CiAgICAgICAgICAgICAgICAgICAgIndhaXRUaW1lSW5TZWNvbmRzIjogMjQwCiAgICAgICAgICAgICAgICB9CiAgICAgICAgICAgIH0KICAgICAgICBdCiAgICB9IAp9IA==",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
"payloadType": "InlineBase64"
}
]
}
}
Пример ответа
{
"displayName": "DataPipeline 1",
"description": "A data pipeline description",
"type": "DataPipeline",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047715"
}
Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30
Определения
Имя | Описание |
---|---|
Create |
Создание полезных данных запроса конвейера данных. |
Data |
Объект конвейера данных. |
Data |
Объект общедоступного определения конвейера данных. |
Data |
Объект части определения конвейера данных. |
Error |
Объект сведений об ошибках, связанных с ресурсом. |
Error |
Ответ на ошибку. |
Error |
Сведения об ответе на ошибку. |
Item |
Тип элемента. С течением времени могут добавляться дополнительные типы элементов. |
Payload |
Тип полезных данных части определения. С течением времени могут добавляться дополнительные типы полезных данных. |
CreateDataPipelineRequest
Создание полезных данных запроса конвейера данных.
Имя | Тип | Описание |
---|---|---|
definition |
Общедоступное определение конвейера данных. |
|
description |
string |
Описание конвейера данных. Максимальная длина — 256 символов. |
displayName |
string |
Отображаемое имя конвейера данных. |
DataPipeline
Объект конвейера данных.
Имя | Тип | Описание |
---|---|---|
description |
string |
Описание элемента. |
displayName |
string |
Отображаемое имя элемента. |
id |
string uuid |
Идентификатор элемента. |
type |
Тип элемента. |
|
workspaceId |
string uuid |
Идентификатор рабочей области. |
DataPipelineDefinition
Объект общедоступного определения конвейера данных.
Имя | Тип | Описание |
---|---|---|
format |
string |
Формат определения элемента. |
parts |
Список частей определения. |
DataPipelineDefinitionPart
Объект части определения конвейера данных.
Имя | Тип | Описание |
---|---|---|
path |
string |
Путь к части конвейера данных. |
payload |
string |
Полезные данные части конвейера данных. |
payloadType |
Тип полезных данных. |
ErrorRelatedResource
Объект сведений об ошибках, связанных с ресурсом.
Имя | Тип | Описание |
---|---|---|
resourceId |
string |
Идентификатор ресурса, участвующий в ошибке. |
resourceType |
string |
Тип ресурса, который участвует в ошибке. |
ErrorResponse
Ответ на ошибку.
Имя | Тип | Описание |
---|---|---|
errorCode |
string |
Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями. |
message |
string |
Удобочитаемое представление ошибки. |
moreDetails |
Список дополнительных сведений об ошибке. |
|
relatedResource |
Сведения об ошибках, связанных с ресурсом. |
|
requestId |
string |
Идентификатор запроса, связанного с ошибкой. |
ErrorResponseDetails
Сведения об ответе на ошибку.
Имя | Тип | Описание |
---|---|---|
errorCode |
string |
Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями. |
message |
string |
Удобочитаемое представление ошибки. |
relatedResource |
Сведения об ошибках, связанных с ресурсом. |
ItemType
Тип элемента. С течением времени могут добавляться дополнительные типы элементов.
Значение | Описание |
---|---|
Dashboard |
Панель мониторинга PowerBI. |
DataPipeline |
Конвейер данных. |
Datamart |
Datamart PowerBI. |
Environment |
Среда. |
Eventhouse |
Хранилище событий. |
Eventstream |
Поток событий. |
GraphQLApi |
API для элемента GraphQL. |
KQLDashboard |
Панель мониторинга KQL. |
KQLDatabase |
База данных KQL. |
KQLQueryset |
Набор запросов KQL. |
Lakehouse |
Озеро. |
MLExperiment |
Эксперимент машинного обучения. |
MLModel |
Модель машинного обучения. |
MirroredDatabase |
Зеркальная база данных. |
MirroredWarehouse |
Зеркальный склад. |
MountedDataFactory |
ПодключеннаяdataFactory. |
Notebook |
Записная книжка. |
PaginatedReport |
Отчет с разбивкой на страницы PowerBI. |
Reflex |
Рефлекс. |
Report |
Отчет PowerBI. |
SQLDatabase |
База данных SQLDatabase. |
SQLEndpoint |
Конечная точка SQL. |
SemanticModel |
Семантическая модель PowerBI. |
SparkJobDefinition |
Определение задания Spark. |
Warehouse |
Склад. |
PayloadType
Тип полезных данных части определения. С течением времени могут добавляться дополнительные типы полезных данных.
Значение | Описание |
---|---|
InlineBase64 |
Встроенная база 64. |