Partager via

Items - Update Data Pipeline Definition

Service:
DataPipeline
Version d'API:
v1

Remplace la définition du pipeline de données spécifié.
Cette API prend en charge opérations longues (LRO).

La mise à jour de la définition de DataPipeline n’affecte pas son étiquette de confidentialité.

Autorisations

L’appelant doit disposer d’autorisations de lecture et d’écriture pour le pipeline de données.

Étendues déléguées requises

DataPipeline.ReadWrite.All ou Item.ReadWrite.All

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité Soutien
Utilisateur Oui
Service principal et identités gérées Oui

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataPipelines/{dataPipelineId}/updateDefinition
Avec des paramètres facultatifs: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataPipelines/{dataPipelineId}/updateDefinition?updateMetadata={updateMetadata}

Paramètres URI

Nom Dans Obligatoire Type Description
dataPipelineId
 path True

string (uuid)

ID du pipeline de données.
workspaceId
 path True

string (uuid)

Identifiant de l’espace de travail.
updateMetadata
 query

boolean

Lorsque la valeur est true et que le fichier .platform est fourni dans le cadre de la définition, les métadonnées de l’élément sont mises à jour à l’aide des métadonnées dans le fichier .platform

Corps de la demande

Nom Obligatoire Type Description
definition True

DataPipelineDefinition

Objet de définition publique du pipeline de données.

Réponses

Nom Type Description
200 OK

La demande s’est terminée avec succès.
202 Accepted

Demande acceptée. La définition de mise à jour est en cours.

En-têtes

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

ErrorResponse

Codes d’erreur courants :

  • OperationNotSupportedForItem : opération non prise en charge pour l’élément demandé.

  • CorruptedPayload : la charge utile fournie est endommagée.

Exemples

Update a data pipeline public definition example

Exemple de requête

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

Exemple de réponse

Code d’état:
200
Code d’état:
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

Définitions

Nom Description
DataPipelineDefinition

Objet de définition publique du pipeline de données.
DataPipelineDefinitionPart

Objet de partie de définition de pipeline de données.
ErrorRelatedResource

Objet de détails de ressource associé à l’erreur.
ErrorResponse

Réponse d’erreur.
ErrorResponseDetails

Détails de la réponse d’erreur.
PayloadType

Type de la charge utile du composant de définition. Des types de charge utile supplémentaires peuvent être ajoutés au fil du temps.
UpdateDataPipelineDefinitionRequest

Mettez à jour la charge utile de la demande de définition publique du pipeline de données.

DataPipelineDefinition

Object

Objet de définition publique du pipeline de données.

Nom Type Description
format

string

Format de la définition d’élément.
parts

DataPipelineDefinitionPart[]

Liste des parties de définition.

DataPipelineDefinitionPart

Object

Objet de partie de définition de pipeline de données.

Nom Type Description
path

string

Chemin d’accès de la partie de pipeline de données.
payload

string

Charge utile de partie du pipeline de données.
payloadType

PayloadType

Type de charge utile.

ErrorRelatedResource

Object

Objet de détails de ressource associé à l’erreur.

Nom Type Description
resourceId

string

ID de ressource impliqué dans l’erreur.
resourceType

string

Type de la ressource impliquée dans l’erreur.

ErrorResponse

Object

Réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
moreDetails

ErrorResponseDetails[]

Liste des détails d’erreur supplémentaires.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.
requestId

string

ID de la demande associée à l’erreur.

ErrorResponseDetails

Object

Détails de la réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.

PayloadType

Énumération

Type de la charge utile du composant de définition. Des types de charge utile supplémentaires peuvent être ajoutés au fil du temps.

Valeur Description
InlineBase64

Base 64 inline.

UpdateDataPipelineDefinitionRequest

Object

Mettez à jour la charge utile de la demande de définition publique du pipeline de données.

Nom Type Description
definition

DataPipelineDefinition

Objet de définition publique du pipeline de données.