Partager via

Deployment Pipelines - Create Deployment Pipeline

Service:
Core
Version d'API:
v1

Crée un pipeline de déploiement.

Autorisations

Les principaux de service doivent disposer d’autorisations accordées par l’administrateur Fabric. Pour plus d’informations, consultez : les principaux de service peuvent créer des espaces de travail, des connexions et des pipelines de déploiement.

Étendues déléguées requises

Pipeline.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
principal de service et identités managées Oui

Interface

POST https://api.fabric.microsoft.com/v1/deploymentPipelines

Corps de la demande

Nom Obligatoire Type Description
displayName True

string

maxLength: 256

Nom complet du pipeline de déploiement.
Le nom complet ne peut pas contenir plus de 256 caractères.
stages True

DeploymentPipelineStageRequest[]

Collection d’étapes de pipeline de déploiement.
description

string

maxLength: 1024

Description du pipeline de déploiement.
La description ne peut pas contenir plus de 1 024 caractères.

Réponses

Nom Type Description
201 Created

DeploymentPipelineExtendedInfo

Création réussie.
Other Status Codes

ErrorResponse

Codes d’erreur courants :

  • UnknownError - Une erreur s’est produite

Exemples

Create a deployment pipeline example

Exemple de requête

POST https://api.fabric.microsoft.com/v1/deploymentPipelines

{
  "displayName": "My Deployment Pipeline Name",
  "description": "My deployment pipeline description",
  "stages": [
    {
      "displayName": "Development",
      "description": "Development stage description",
      "isPublic": false
    },
    {
      "displayName": "Test",
      "description": "Test stage description",
      "isPublic": false
    },
    {
      "displayName": "Production",
      "description": "Production stage description",
      "isPublic": true
    }
  ]
}

Exemple de réponse

Code d’état:
201 
{
  "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
  "displayName": "My Deployment Pipeline Name",
  "description": "My deployment pipeline description",
  "stages": [
    {
      "id": "2e6f0272-e809-410a-be63-50e1d97ba75a",
      "order": 0,
      "displayName": "Development",
      "description": "Development stage description",
      "isPublic": false
    },
    {
      "id": "d2056166-041c-4a56-8d37-ea90038bc0d6",
      "order": 1,
      "displayName": "Test",
      "description": "Test stage description",
      "isPublic": false
    },
    {
      "id": "4c3eb03b-fbbb-4605-9b1a-6fba1003679e",
      "order": 2,
      "displayName": "Production",
      "description": "Production stage description",
      "isPublic": true
    }
  ]
}

Définitions

Nom Description
CreateDeploymentPipelineRequest

Demande de création d’un pipeline de déploiement.
DeploymentPipelineExtendedInfo

Un pipeline de déploiement Fabric.
DeploymentPipelineStage

Étape du pipeline de déploiement Fabric.
DeploymentPipelineStageRequest

Étape du pipeline de déploiement Fabric.
ErrorRelatedResource

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

Réponse d’erreur.
ErrorResponseDetails

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

CreateDeploymentPipelineRequest

Object

Demande de création d’un pipeline de déploiement.

Nom Type Description
description

string

maxLength: 1024

Description du pipeline de déploiement.
La description ne peut pas contenir plus de 1 024 caractères.
displayName

string

maxLength: 256

Nom complet du pipeline de déploiement.
Le nom complet ne peut pas contenir plus de 256 caractères.
stages

DeploymentPipelineStageRequest[]

Collection d’étapes de pipeline de déploiement.

DeploymentPipelineExtendedInfo

Object

Un pipeline de déploiement Fabric.

Nom Type Description
description

string

Description du pipeline de déploiement.
displayName

string

Nom complet du pipeline de déploiement.
id

string (uuid)

ID du pipeline de déploiement.
stages

DeploymentPipelineStage[]

Collection d’étapes de pipeline de déploiement.

DeploymentPipelineStage

Object

Étape du pipeline de déploiement Fabric.

Nom Type Description
description

string

Description de l’étape du pipeline de déploiement.
displayName

string

Nom complet de l’étape du pipeline de déploiement.
id

string (uuid)

ID d’étape du pipeline de déploiement.
isPublic

boolean

Indique si l’étape du pipeline de déploiement est publique. True : la scène est publique, False : la phase n’est pas publique.
order

integer

Ordre d’étape, à partir de zéro.
workspaceId

string (uuid)

ID d’espace de travail affecté. Applicable uniquement lorsqu’il existe un espace de travail affecté.
workspaceName

string

Nom de l’espace de travail affecté. Applicable uniquement lorsqu’il existe un espace de travail affecté et que l’utilisateur a accès à l’espace de travail.

DeploymentPipelineStageRequest

Object

Étape du pipeline de déploiement Fabric.

Nom Type Description
description

string

maxLength: 1024

Description de l’étape du pipeline de déploiement.
La description ne peut pas contenir plus de 1 024 caractères.
displayName

string

maxLength: 256

Nom complet de l’étape du pipeline de déploiement.
Le nom complet ne peut pas contenir plus de 256 caractères.
isPublic

boolean

Indique si l’étape du pipeline de déploiement est publique.

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.