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

Items - Create Data Pipeline

  • Ссылка
Служба:
DataPipeline
Версия API:
v1

Создает конвейер данных в указанной рабочей области.
Этот API поддерживает длительные операции (LRO).

Разрешения

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

Обязательные делегированные области

DataPipeline.ReadWrite.All или Item.ReadWrite.All

Ограничения

  • Чтобы создать конвейер данных, рабочая область должна находиться в поддерживаемой емкости Fabric.

Поддерживаемые удостоверения Microsoft Entra

Этот API поддерживает удостоверения Microsoft , перечисленные в этом разделе.

Тождество Поддержка
Пользователь Да
субъекта-службы и управляемых удостоверений Да

Интерфейс

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataPipelines

Параметры URI

Имя В Обязательно Тип Описание
workspaceId
 path True

string

uuid

Идентификатор рабочей области.

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

Имя Обязательно Тип Описание
displayName True

string

Отображаемое имя конвейера данных.
definition

DataPipelineDefinition

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

string

Описание конвейера данных. Максимальная длина — 256 символов.

Ответы

Имя Тип Описание
201 Created

DataPipeline

Успешно создано
202 Accepted

Запрос принят, подготовка конвейера данных выполняется

Заголовки

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Распространенные коды ошибок:

  • InvalidItemType — тип элемента недопустим

  • ItemDisplayNameAlreadyInUse — отображаемое имя элемента уже используется

  • Поврежденный Payload — предоставленные полезные данные повреждены

Примеры

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

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

Код состояния:
201 
{
  "displayName": "DataPipeline 1",
  "description": "A data pipeline description",
  "type": "DataPipeline",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}
Код состояния:
202 
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"
      }
    ]
  }
}

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

Код состояния:
201 
{
  "displayName": "DataPipeline 1",
  "description": "A data pipeline description",
  "type": "DataPipeline",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}
Код состояния:
202 
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

Определения

Имя Описание
CreateDataPipelineRequest

Создание полезных данных запроса конвейера данных.
DataPipeline

Объект конвейера данных.
DataPipelineDefinition

Объект общедоступного определения конвейера данных.
DataPipelineDefinitionPart

Объект части определения конвейера данных.
ErrorRelatedResource

Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse

Ответ на ошибку.
ErrorResponseDetails

Сведения об ответе на ошибку.
ItemType

Тип элемента. С течением времени могут добавляться дополнительные типы элементов.
PayloadType

Тип полезных данных части определения. С течением времени могут добавляться дополнительные типы полезных данных.

CreateDataPipelineRequest

Object

Создание полезных данных запроса конвейера данных.

Имя Тип Описание
definition

DataPipelineDefinition

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

string

Описание конвейера данных. Максимальная длина — 256 символов.
displayName

string

Отображаемое имя конвейера данных.

DataPipeline

Object

Объект конвейера данных.

Имя Тип Описание
description

string

Описание элемента.
displayName

string

Отображаемое имя элемента.
id

string

uuid

Идентификатор элемента.
type

ItemType

Тип элемента.
workspaceId

string

uuid

Идентификатор рабочей области.

DataPipelineDefinition

Object

Объект общедоступного определения конвейера данных.

Имя Тип Описание
format

string

Формат определения элемента.
parts

DataPipelineDefinitionPart[]

Список частей определения.

DataPipelineDefinitionPart

Object

Объект части определения конвейера данных.

Имя Тип Описание
path

string

Путь к части конвейера данных.
payload

string

Полезные данные части конвейера данных.
payloadType

PayloadType

Тип полезных данных.

ErrorRelatedResource

Object

Объект сведений об ошибках, связанных с ресурсом.

Имя Тип Описание
resourceId

string

Идентификатор ресурса, участвующий в ошибке.
resourceType

string

Тип ресурса, который участвует в ошибке.

ErrorResponse

Object

Ответ на ошибку.

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message

string

Удобочитаемое представление ошибки.
moreDetails

ErrorResponseDetails[]

Список дополнительных сведений об ошибке.
relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.
requestId

string

Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Object

Сведения об ответе на ошибку.

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message

string

Удобочитаемое представление ошибки.
relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.

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.