Items - Update Data Pipeline Definition

Usługa:: DataPipeline

Wersja interfejsu API:: v1

Zastępuje definicję określonego potoku danych.
Ten interfejs API obsługuje długotrwałych operacji (LRO).

Aktualizowanie definicji elementu DataPipeline nie ma wpływu na etykietę poufności.

Uprawnienia

Obiekt wywołujący musi mieć uprawnienia do odczytu i zapisu dla potoku danych.

Wymagane zakresy delegowane

DataPipeline.ReadWrite.All lub Item.ReadWrite.All

Tożsamości obsługiwane przez Microsoft Entra

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Tożsamość	Wsparcie
Użytkownik	Tak
Główne usługi i Tożsamości zarządzane	Tak

Interfejs

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

Z parametrami opcjonalnymi:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataPipelines/{dataPipelineId}/updateDefinition?updateMetadata={updateMetadata}

Parametry identyfikatora URI

Nazwisko	W	Wymagane	Typ	Opis
dataPipelineId	path	True	string (uuid)	Identyfikator potoku danych.
workspaceId	path	True	string (uuid)	Identyfikator przestrzeni roboczej.
updateMetadata	query		boolean	W przypadku ustawienia wartości true i pliku platformy w ramach definicji metadane elementu są aktualizowane przy użyciu metadanych w pliku platformy .

Treść żądania

Nazwisko	Wymagane	Typ	Opis
definition	True	DataPipelineDefinition	Obiekt definicji publicznej potoku danych. Zapoznaj się z tym artykułem , aby uzyskać więcej informacji na temat struktury definicji potoku danych.

Odpowiedzi

Nazwisko	Typ	Opis
200 OK		Żądanie zostało ukończone pomyślnie.
202 Accepted		Zaakceptowano żądanie. Trwa aktualizowanie definicji. Nagłówki Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący `Retry-After` w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań. Nagłówki Retry-After: integer
Other Status Codes	ErrorResponse	Typowe kody błędów: OperationNotSupportedForItem — operacja nieobsługiwana dla żądanego elementu. CorruptedPayload — podany ładunek jest uszkodzony.

Przykłady

Update a data pipeline public definition example

Przykładowe żądanie

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/dataPipelines/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "definition": {
    "parts": [
      {
        "path": "pipeline-content.json",
        "payload": "ewogICJwcm9wZXJ0aWVzIjogewogICAgImFjdGl2aXRpZXMiOiBbCiAgICAgIHsKICAgICAgICAibmFtZSI6ICJXYWl0MSIsCiAgICAgICAgInR5cGUiOiAiV2FpdCIsCiAgICAgICAgImRlcGVuZHNPbiI6IFtdLAogICAgICAgICJ0eXBlUHJvcGVydGllcyI6IHsKICAgICAgICAgICJ3YWl0VGltZUluU2Vjb25kcyI6IDEKICAgICAgICB9CiAgICAgIH0KICAgIF0KICB9Cn0=",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Przykładowa odpowiedź

Kod stanu:: 200

Kod stanu:: 202

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Definicje

Nazwisko	Opis
DataPipelineDefinition	Obiekt definicji publicznej potoku danych. Zapoznaj się z tym artykułem , aby uzyskać więcej informacji na temat struktury definicji potoku danych.
DataPipelineDefinitionPart	Obiekt części definicji potoku danych.
ErrorParameter	Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
PayloadType	Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.
UpdateDataPipelineDefinitionRequest	Aktualizowanie ładunku żądania definicji publicznej potoku danych.

DataPipelineDefinition

Objekt

Obiekt definicji publicznej potoku danych. Zapoznaj się z tym artykułem , aby uzyskać więcej informacji na temat struktury definicji potoku danych.

Nazwisko	Typ	Opis
format	string	Format definicji potoku danych.
parts	DataPipelineDefinitionPart[]	Lista części definicji.

DataPipelineDefinitionPart

Objekt

Obiekt części definicji potoku danych.

Nazwisko	Typ	Opis
path	string	Ścieżka części potoku danych.
payload	string	Ładunek częściowy potoku danych.
payloadType	PayloadType	Typ ładunku.

ErrorParameter

Objekt

Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.

Nazwisko	Typ	Opis
message	string	Czytelny dla człowieka opis znaczenia parametru.
name	string	Identyfikator parametru.
value	string	Wartość parametru.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwisko	Typ	Opis
resourceId	string	Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType	string	Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwisko	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
isRetriable	boolean	Jeśli to prawda, żądanie można ponowić. Użyj nagłówka `Retry-After` odpowiedzi, aby określić opóźnienie, jeśli jest dostępne.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
parameters	ErrorParameter[]	Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string (uuid)	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwisko	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
parameters	ErrorParameter[]	Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.

PayloadType

Wyliczenie

Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.

Wartość	Opis
InlineBase64	Śródliniowa baza 64.

UpdateDataPipelineDefinitionRequest

Objekt

Aktualizowanie ładunku żądania definicji publicznej potoku danych.

Nazwisko	Typ	Opis
definition	DataPipelineDefinition	Obiekt definicji publicznej potoku danych. Zapoznaj się z tym artykułem , aby uzyskać więcej informacji na temat struktury definicji potoku danych.