Items - Update Dataflow Definition

Usługa:
Dataflow
Wersja interfejsu API:
v1

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

Aktualizowanie definicji przepływu danych nie ma wpływu na etykietę poufności.

Uprawnienia

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

Wymagane zakresy delegowane

Dataflow.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}/dataflows/{dataflowId}/updateDefinition
Z parametrami opcjonalnymi: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataflows/{dataflowId}/updateDefinition?updateMetadata={updateMetadata}

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
dataflowId
 path True

string (uuid)

Identyfikator przepływu 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

Nazwa Wymagane Typ Opis
definition True

DataflowDefinition

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

Odpowiedzi

Nazwa 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 Dataflow public definition example

Przykładowe żądanie

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

{
  "definition": {
    "parts": [
      {
        "path": "queryMetadata.json",
        "payload": "ewogICJmb3JtYXRWZXJzaW9uIjogIjIwMjUwMiIsCiAgImNvbXB1dGVFbmdpbmVTZXR0aW5ncyI6IHt9LAogICJuYW1lIjogIlRlc3REYXRhZmxvdyIsCiAgInF1ZXJ5R3JvdXBzIjogW10sCiAgImRvY3VtZW50TG9jYWxlIjogImVuLVVTIiwKICAicXVlcmllc01ldGFkYXRhIjogewogICAgInF1ZXJ5IjogewogICAgICAicXVlcnlJZCI6ICJiZTE3MjEwZi01YWNhLTQyMWEtOGMwYS1iZjYzMTQ4N2JiOGUiLAogICAgICAicXVlcnlOYW1lIjogIlF1ZXJ5IgogICAgfSwKICAgICJNREYgdHJhbnNmb3JtIjogewogICAgICAicXVlcnlJZCI6ICI5YzZkN2M4Ny04M2RiLTQ3MTgtYjM4Mi1jMGMxYWExNjM2ZDciLAogICAgICAicXVlcnlOYW1lIjogIk1ERiB0cmFuc2Zvcm0iLAogICAgICAibG9hZEVuYWJsZWQiOiBmYWxzZQogICAgfQogIH0sCiAgImNvbm5lY3Rpb25zIjogW10KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "mashup.pq",
        "payload": "W1N0YWdpbmdEZWZpbml0aW9uID0gW0tpbmQgPSAiRmFzdENvcHkiXV0Kc2VjdGlvbiBTZWN0aW9uMTsKc2hhcmVkIFF1ZXJ5ID0gbGV0CiAgU291cmNlID0gVGFibGUuRnJvbVJvd3MoSnNvbi5Eb2N1bWVudChCaW5hcnkuRGVjb21wcmVzcyhCaW5hcnkuRnJvbVRleHQoImk0NVdNbFRTVVhMT3p5bk56VE9LUjdDTmdleFluV2dsSXlSWkl5UlpJNlhZV0FBPSIsIEJpbmFyeUVuY29kaW5nLkJhc2U2NCksIENvbXByZXNzaW9uLkRlZmxhdGUpKSwgbGV0IF90ID0gKCh0eXBlIG51bGxhYmxlIHRleHQpIG1ldGEgW1NlcmlhbGl6ZWQuVGV4dCA9IHRydWVdKSBpbiB0eXBlIHRhYmxlIFtDb2x1bW4xID0gX3QsIENvbHVtbjIgPSBfdCwgQ29sdW1uMyA9IF90XSksCiAgIyJDaGFuZ2VkIGNvbHVtbiB0eXBlIiA9IFRhYmxlLlRyYW5zZm9ybUNvbHVtblR5cGVzKFNvdXJjZSwge3siQ29sdW1uMSIsIEludDY0LlR5cGV9LCB7IkNvbHVtbjIiLCB0eXBlIHRleHR9LCB7IkNvbHVtbjMiLCB0eXBlIHRleHR9fSkKaW4KICAjIkNoYW5nZWQgY29sdW1uIHR5cGUiOwpbSXRlbVR5cGUgPSAiTURGIl0Kc2hhcmVkICMiTURGIHRyYW5zZm9ybSIgPSAiX19fRXh0ZXJuYWxSZXNvdXJjZS1QbGFjZWhvbGRlcl9fXyI7Cg==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "MDF transform.mdf",
        "payload": "ewogICAgIm5hbWUiOiAiTURGIiwKICAgICJwcm9wZXJ0aWVzIjogewogICAgICAgICJ0eXBlIjogIk1hcHBpbmdEYXRhRmxvdyIsCiAgICAgICAgInR5cGVQcm9wZXJ0aWVzIjogewogICAgICAgICAgICAic291cmNlcyI6IFsKICAgICAgICAgICAgICAgIHsKICAgICAgICAgICAgICAgICAgICAibmFtZSI6ICJzb3VyY2UxIiwKICAgICAgICAgICAgICAgICAgICAiZXh0ZXJuYWxSZWZlcmVuY2VzIjogewogICAgICAgICAgICAgICAgICAgICAgICAiY29ubmVjdGlvbiI6ICI8c291cmNlMUNvbm5lY3Rpb25JZD4iCiAgICAgICAgICAgICAgICAgICAgfQogICAgICAgICAgICAgICAgfQogICAgICAgICAgICBdLAogICAgICAgICAgICAic2lua3MiOiBbCiAgICAgICAgICAgICAgICB7CiAgICAgICAgICAgICAgICAgICAgIm5hbWUiOiAic2luazEiLAogICAgICAgICAgICAgICAgICAgICJleHRlcm5hbFJlZmVyZW5jZXMiOiB7CiAgICAgICAgICAgICAgICAgICAgICAgICJjb25uZWN0aW9uIjogIjxzaW5rMUNvbm5lY3Rpb25JZD4iCiAgICAgICAgICAgICAgICAgICAgfQogICAgICAgICAgICAgICAgfQogICAgICAgICAgICBdLAogICAgICAgICAgICAidHJhbnNmb3JtYXRpb25zIjogWwogICAgICAgICAgICAgICAgewogICAgICAgICAgICAgICAgICAgICJuYW1lIjogImRlcml2ZWRDb2x1bW4xIgogICAgICAgICAgICAgICAgfQogICAgICAgICAgICBdLAogICAgICAgICAgICAic2NyaXB0TGluZXMiOiBbCiAgICAgICAgICAgICAgICAic291cmNlKG91dHB1dCgiLAogICAgICAgICAgICAgICAgIiAgICAgICAgICBDb2x1bW4xIGFzIHNob3J0LCIsCiAgICAgICAgICAgICAgICAiICAgICAgICAgIENvbHVtbjIgYXMgc3RyaW5nLCIsCiAgICAgICAgICAgICAgICAiICAgICAgICAgIENvbHVtbjMgYXMgZGF0ZSwiLAogICAgICAgICAgICAgICAgIiAgICAgICAgICBDb2x1bW40IGFzIGJvb2xlYW4sIiwKICAgICAgICAgICAgICAgICIgICAgICAgICAgQ29sdW1uNSBhcyBzdHJpbmcsIiwKICAgICAgICAgICAgICAgICIgICAgICAgICAgQ29sdW1uNiBhcyBkb3VibGUiLAogICAgICAgICAgICAgICAgIiAgICAgKSwiLAogICAgICAgICAgICAgICAgIiAgICAgdXNlU2NoZW1hOiBmYWxzZSwiLAogICAgICAgICAgICAgICAgIiAgICAgYWxsb3dTY2hlbWFEcmlmdDogdHJ1ZSwiLAogICAgICAgICAgICAgICAgIiAgICAgdmFsaWRhdGVTY2hlbWE6IGZhbHNlLCIsCiAgICAgICAgICAgICAgICAiICAgICBpZ25vcmVOb0ZpbGVzRm91bmQ6IGZhbHNlLCIsCiAgICAgICAgICAgICAgICAiICAgICBmb3JtYXQ6ICdkZWxpbWl0ZWQnLCIsCiAgICAgICAgICAgICAgICAiICAgICBmaWxlU3lzdGVtOiAnZm9sZGVyMScsIiwKICAgICAgICAgICAgICAgICIgICAgIGZpbGVOYW1lOiAnZmlsZTEuY3N2JywiLAogICAgICAgICAgICAgICAgIiAgICAgY29sdW1uRGVsaW1pdGVyOiAnLCcsIiwKICAgICAgICAgICAgICAgICIgICAgIGVzY2FwZUNoYXI6ICdcXFxcJywiLAogICAgICAgICAgICAgICAgIiAgICAgcXVvdGVDaGFyOiAnXFxcIicsIiwKICAgICAgICAgICAgICAgICIgICAgIGNvbHVtbk5hbWVzQXNIZWFkZXI6IHRydWUpIH4+IHNvdXJjZTEiLAogICAgICAgICAgICAgICAgInNvdXJjZTEgZGVyaXZlKGlzQ29sdW1uNkdyZWF0ZXJUaGFuMTAgPSBDb2x1bW42PjEwKSB+PiBkZXJpdmVkQ29sdW1uMSIsCiAgICAgICAgICAgICAgICAiZGVyaXZlZENvbHVtbjEgc2luayhhbGxvd1NjaGVtYURyaWZ0OiB0cnVlLCIsCiAgICAgICAgICAgICAgICAiICAgICB2YWxpZGF0ZVNjaGVtYTogZmFsc2UsIiwKICAgICAgICAgICAgICAgICIgICAgIGZvcm1hdDogJ2pzb24nLCIsCiAgICAgICAgICAgICAgICAiICAgICBmaWxlU3lzdGVtOiAnb3V0cHV0MScsIiwKICAgICAgICAgICAgICAgICIgICAgIHVtYXNrOiAwMDIyLCIsCiAgICAgICAgICAgICAgICAiICAgICBwcmVDb21tYW5kczogW10sIiwKICAgICAgICAgICAgICAgICIgICAgIHBvc3RDb21tYW5kczogW10sIiwKICAgICAgICAgICAgICAgICIgICAgIHNraXBEdXBsaWNhdGVNYXBJbnB1dHM6IHRydWUsIiwKICAgICAgICAgICAgICAgICIgICAgIHNraXBEdXBsaWNhdGVNYXBPdXRwdXRzOiB0cnVlKSB+PiBzaW5rMSIKICAgICAgICAgICAgXQogICAgICAgIH0KICAgIH0KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIkRhdGFmbG93IiwKICAgICJkaXNwbGF5TmFtZSI6ICJUZXN0RGF0YWZsb3ciCiAgfSwKICAiY29uZmlnIjogewogICAgInZlcnNpb24iOiAiMi4wIiwKICAgICJsb2dpY2FsSWQiOiAiZjU4ZDJmODMtYTMwMC1iMTM1LTQ3ODgtMDU5NjgzY2Q1NzFjIgogIH0KfQ==",
        "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

Nazwa Opis
DataflowDefinition

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

Obiekt części definicji przepływu danych.
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.
UpdateDataflowDefinitionRequest

Zaktualizuj ładunek żądania definicji publicznej przepływu danych.

DataflowDefinition

Objekt

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

Nazwa Typ Opis
format

string

Format definicji przepływu danych.
parts

DataflowDefinitionPart[]

Lista części definicji.

DataflowDefinitionPart

Objekt

Obiekt części definicji przepływu danych.

Nazwa Typ Opis
path

string

Ścieżka części definicji publicznej przepływu danych.
payload

string

Ładunek części definicji publicznej przepływu danych.
payloadType

PayloadType

Typ ładunku.

ErrorRelatedResource

Objekt

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

Nazwa 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.

Nazwa 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.
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.

Nazwa 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.
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.

UpdateDataflowDefinitionRequest

Objekt

Zaktualizuj ładunek żądania definicji publicznej przepływu danych.

Nazwa Typ Opis
definition

DataflowDefinition

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