Freigeben über

Deployment Pipelines - Create Deployment Pipeline

Dienst:
Core
API-Version:
v1

Erstellt eine neue Bereitstellungspipeline.

Erlaubnisse

Dienstprinzipale müssen über die Berechtigung des Fabric-Administrators verfügen. Weitere Informationen finden Sie unter: Dienstprinzipale können Arbeitsbereiche, Verbindungen und Bereitstellungspipelinen erstellen.

Erforderliche delegierte Bereiche

Pipeline.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identität Unterstützung
Benutzer Ja
Service Principal und Verwaltete Identitäten Ja

Schnittstelle

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

Anforderungstext

Name Erforderlich Typ Beschreibung
displayName True

string

maxLength: 256

Der Anzeigename für die Bereitstellungspipeline.
Der Anzeigename darf nicht mehr als 256 Zeichen enthalten.
stages True

DeploymentPipelineStageRequest[]

Die Sammlung der Bereitstellungspipelinephasen.
description

string

maxLength: 1024

Die Beschreibung für die Bereitstellungspipeline.
Die Beschreibung darf nicht mehr als 1024 Zeichen enthalten.

Antworten

Name Typ Beschreibung
201 Created

DeploymentPipelineExtendedInfo

Erfolgreich erstellt.
Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • UnknownError – Fehler

Beispiele

Create a deployment pipeline example

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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
    }
  ]
}

Definitionen

Name Beschreibung
CreateDeploymentPipelineRequest

Eine Anforderung zum Erstellen einer neuen Bereitstellungspipeline.
DeploymentPipelineExtendedInfo

Eine Fabric-Bereitstellungspipeline.
DeploymentPipelineStage

Eine Fabric-Bereitstellungspipelinephase.
DeploymentPipelineStageRequest

Eine Fabric-Bereitstellungspipelinephase.
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.

CreateDeploymentPipelineRequest

Objekt

Eine Anforderung zum Erstellen einer neuen Bereitstellungspipeline.

Name Typ Beschreibung
description

string

maxLength: 1024

Die Beschreibung für die Bereitstellungspipeline.
Die Beschreibung darf nicht mehr als 1024 Zeichen enthalten.
displayName

string

maxLength: 256

Der Anzeigename für die Bereitstellungspipeline.
Der Anzeigename darf nicht mehr als 256 Zeichen enthalten.
stages

DeploymentPipelineStageRequest[]

Die Sammlung der Bereitstellungspipelinephasen.

DeploymentPipelineExtendedInfo

Objekt

Eine Fabric-Bereitstellungspipeline.

Name Typ Beschreibung
description

string

Beschreibung der Bereitstellungspipeline.
displayName

string

Der Anzeigename der Bereitstellungspipeline.
id

string (uuid)

Die Bereitstellungspipeline-ID.
stages

DeploymentPipelineStage[]

Die Sammlung der Bereitstellungspipelinephasen.

DeploymentPipelineStage

Objekt

Eine Fabric-Bereitstellungspipelinephase.

Name Typ Beschreibung
description

string

Beschreibung der Bereitstellungspipelinephase.
displayName

string

Der Anzeigename der Bereitstellungspipelinephase.
id

string (uuid)

Die Bereitstellungspipelinestufen-ID.
isPublic

boolean

Gibt an, ob die Bereitstellungspipelinestufe öffentlich ist. True - die Bühne ist öffentlich, False - die Bühne ist nicht öffentlich.
order

integer

Die Phasenreihenfolge beginnend mit Null.
workspaceId

string (uuid)

Die zugewiesene Arbeitsbereichs-ID. Gilt nur, wenn ein zugewiesener Arbeitsbereich vorhanden ist.
workspaceName

string

Der zugewiesene Arbeitsbereichsname. Gilt nur, wenn ein zugewiesener Arbeitsbereich vorhanden ist und der Benutzer Zugriff auf den Arbeitsbereich hat.

DeploymentPipelineStageRequest

Objekt

Eine Fabric-Bereitstellungspipelinephase.

Name Typ Beschreibung
description

string

maxLength: 1024

Beschreibung der Bereitstellungspipelinephase.
Die Beschreibung darf nicht mehr als 1024 Zeichen enthalten.
displayName

string

maxLength: 256

Der Anzeigename der Bereitstellungspipelinephase.
Der Anzeigename darf nicht mehr als 256 Zeichen enthalten.
isPublic

boolean

Gibt an, ob die Bereitstellungspipelinestufe öffentlich ist.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name Typ Beschreibung
resourceId

string

Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType

string

Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
moreDetails

ErrorResponseDetails[]

Liste der zusätzlichen Fehlerdetails.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.
requestId

string

ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.