Partager via

Items - Get Data Pipeline Definition

Service:
DataPipeline
Version d'API:
v1

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

Lorsque vous obtenez une définition publique de DataPipeline, l’étiquette de confidentialité ne fait pas partie de la définition.

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}/getDefinition
Avec des paramètres facultatifs: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataPipelines/{dataPipelineId}/getDefinition?format={format}

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.
format
 query

string

Format de la définition publique du pipeline de données.

Réponses

Nom Type Description
200 OK

DataPipelineDefinitionResponse

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

Demande acceptée. La récupération de la définition 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é.

Exemples

Get a data pipeline public definition example

Exemple de requête

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/dataPipelines/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

Exemple de réponse

Code d’état:
200 
{
  "definition": {
    "parts": [
      {
        "path": "pipeline-content.json",
        "payload": "ewogICJwcm9wZXJ0aWVzIjogewogICAgImFjdGl2aXRpZXMiOiBbXQogIH0KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
Code d’état:
202 
Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
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.
DataPipelineDefinitionResponse

Réponse de définition publique du 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.

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.

DataPipelineDefinitionResponse

Object

Réponse de définition publique du pipeline de données.

Nom Type Description
definition

DataPipelineDefinition

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

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.