Items - Create Data Pipeline

Tjeneste:

DataPipeline

API-versjon:

v1

Oppretter et datasamlebånd i det angitte arbeidsområdet.
Denne API-en støtter langvarige operasjoner (LRO).

Tillatelser

Innringeren må ha bidragsyter eller høyere arbeidsområderolle.

Nødvendige delegerte omfang

DataPipeline.ReadWrite.All eller Item.ReadWrite.All

Begrensninger

• Hvis du vil opprette et datasamlebånd, må arbeidsområdet være på en støttet Fabric-kapasitet.

Microsoft Entra-støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identitet	Støtte
Bruker	Ja
tjenestekontohaver og administrerte identiteter	Ja

Grensesnitt

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

URI-parametere

Navn	I	Obligatorisk	Type	Beskrivelse
workspaceId	path	True	string uuid	Arbeidsområde-ID-en.

Brødtekst for forespørsel

Navn	Obligatorisk	Type	Beskrivelse
displayName	True	string	Visningsnavnet for datasamlebåndet.
definition		DataPipelineDefinition	Den offentlige definisjonen for datasamlebåndet.
description		string	Datasamlebåndbeskrivelsen. Maksimal lengde er 256 tegn.

Svar

Navn	Type	Beskrivelse
201 Created	DataPipeline	Opprettet
202 Accepted		Forespørsel godtatt, klargjøring av datasamlebånd pågår Overskrifter Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Vanlige feilkoder: InvalidItemType – elementtypen er ugyldig ItemDisplayNameAlreadyInUse – visningsnavnet for elementet er allerede brukt CorruptedPayload – den angitte nyttelasten er skadet

Eksempler

Create data pipeline example

Create data pipeline with item definition example

Create data pipeline example

Eksempelforespørsel

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/dataPipelines

{
  "displayName": "DataPipeline 1",
  "description": "A data pipeline description"
}

Eksempelsvar

Statuskode:

201

{
  "displayName": "DataPipeline 1",
  "description": "A data pipeline description",
  "type": "DataPipeline",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Statuskode:

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

Eksempelforespørsel

HTTP

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

Eksempelsvar

Statuskode:

201

{
  "displayName": "DataPipeline 1",
  "description": "A data pipeline description",
  "type": "DataPipeline",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Statuskode:

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

Definisjoner

Navn	Beskrivelse
CreateDataPipelineRequest	Opprett nyttelast for datasamlebåndforespørsel.
DataPipeline	Et datasamlebåndobjekt.
DataPipelineDefinition	Offentlig definisjonsobjekt for datasamlebånd.
DataPipelineDefinitionPart	Delobjekt for datasamlebånddefinisjon.
ErrorRelatedResource	Objektet for feilrelaterte ressursdetaljer.
ErrorResponse	Feilsvaret.
ErrorResponseDetails	Feilsvardetaljene.
ItemType	Typen element. Flere elementtyper kan legges til over tid.
PayloadType	Typen nyttelast for definisjonsdelen. Flere nyttelasttyper kan legges til over tid.

CreateDataPipelineRequest

Object

Opprett nyttelast for datasamlebåndforespørsel.

Navn	Type	Beskrivelse
definition	DataPipelineDefinition	Den offentlige definisjonen for datasamlebåndet.
description	string	Datasamlebåndbeskrivelsen. Maksimal lengde er 256 tegn.
displayName	string	Visningsnavnet for datasamlebåndet.

DataPipeline

Object

Et datasamlebåndobjekt.

Navn	Type	Beskrivelse
description	string	Elementbeskrivelsen.
displayName	string	Visningsnavnet for elementet.
id	string uuid	Element-ID-en.
type	ItemType	Elementtypen.
workspaceId	string uuid	Arbeidsområde-ID-en.

DataPipelineDefinition

Object

Offentlig definisjonsobjekt for datasamlebånd.

Navn	Type	Beskrivelse
format	string	Formatet for elementdefinisjonen.
parts	DataPipelineDefinitionPart[]	En liste over definisjonsdeler.

DataPipelineDefinitionPart

Object

Delobjekt for datasamlebånddefinisjon.

Navn	Type	Beskrivelse
path	string	Delbanen for datasamlebåndet.
payload	string	Nyttelasten for datasamlebånddelen.
payloadType	PayloadType	Nyttelasttypen.

ErrorRelatedResource

Object

Objektet for feilrelaterte ressursdetaljer.

Navn	Type	Beskrivelse
resourceId	string	Ressurs-ID-en som er involvert i feilen.
resourceType	string	Typen ressurs som er involvert i feilen.

ErrorResponse

Object

Feilsvaret.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
moreDetails	ErrorResponseDetails[]	Liste over flere feildetaljer.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.
requestId	string	ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Object

Feilsvardetaljene.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.

ItemType

Opplisting

Typen element. Flere elementtyper kan legges til over tid.

Verdi	Beskrivelse
Dashboard	PowerBI-instrumentbord.
DataPipeline	Et datasamlebånd.
Datamart	PowerBI-datamart.
Environment	Et miljø.
Eventhouse	Et arrangementshus.
Eventstream	En hendelsesstrøm.
GraphQLApi	En API for GraphQL-element.
KQLDashboard	Et KQL-instrumentbord.
KQLDatabase	En KQL-database.
KQLQueryset	Et KQL-spørringssett.
Lakehouse	Et innsjøhus.
MLExperiment	Et maskinlæringseksperiment.
MLModel	En maskinlæringsmodell.
MirroredDatabase	En speilvendt database.
MirroredWarehouse	Et speilvendt lager.
MountedDataFactory	En MountedDataFactory.
Notebook	En notatblokk.
PaginatedReport	Paginert powerbi-rapport.
Reflex	En refleks.
Report	PowerBI-rapport.
SQLDatabase	En SQLDatabase.
SQLEndpoint	Et SQL-endepunkt.
SemanticModel	Semantisk PowerBI-modell.
SparkJobDefinition	En spark-jobbdefinisjon.
Warehouse	Et lager.

PayloadType

Opplisting

Typen nyttelast for definisjonsdelen. Flere nyttelasttyper kan legges til over tid.

Verdi	Beskrivelse
InlineBase64	Innebygd grunntall 64.