Udostępnij przez

Deployment Pipelines - Create Deployment Pipeline

Usługa:
Core
Wersja interfejsu API:
v1

Tworzy nowy potok wdrażania.

Uprawnienia

Jednostki usługi muszą mieć uprawnienia przyznane przez administratora sieci szkieletowej. Aby uzyskać więcej informacji, zobacz: Jednostki usługi mogą tworzyć obszary robocze, połączenia i potoki wdrażania.

Wymagane zakresy delegowane

Pipeline.ReadWrite.All

Tożsamości obsługiwane przez Microsoft Entra

Ten interfejs API obsługuje tożsamości firmy 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/deploymentPipelines

Treść żądania

Nazwa Wymagane Typ Opis
displayName True

string

maxLength: 256

Nazwa wyświetlana potoku wdrażania.
Nazwa wyświetlana nie może zawierać więcej niż 256 znaków.
stages True

DeploymentPipelineStageRequest[]

Kolekcja etapów potoku wdrażania.
description

string

maxLength: 1024

Opis potoku wdrażania.
Opis nie może zawierać więcej niż 1024 znaków.

Odpowiedzi

Nazwa Typ Opis
201 Created

DeploymentPipelineExtendedInfo

Pomyślnie utworzono.
Other Status Codes

ErrorResponse

Typowe kody błędów:

  • UnknownError — wystąpił błąd

Przykłady

Create a deployment pipeline example

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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
    }
  ]
}

Definicje

Nazwa Opis
CreateDeploymentPipelineRequest

Żądanie utworzenia nowego potoku wdrażania.
DeploymentPipelineExtendedInfo

Potok wdrażania sieci szkieletowej.
DeploymentPipelineStage

Etap potoku wdrażania sieci szkieletowej.
DeploymentPipelineStageRequest

Etap potoku wdrażania sieci szkieletowej.
ErrorRelatedResource

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

Odpowiedź na błąd.
ErrorResponseDetails

Szczegóły odpowiedzi na błąd.

CreateDeploymentPipelineRequest

Objekt

Żądanie utworzenia nowego potoku wdrażania.

Nazwa Typ Opis
description

string

maxLength: 1024

Opis potoku wdrażania.
Opis nie może zawierać więcej niż 1024 znaków.
displayName

string

maxLength: 256

Nazwa wyświetlana potoku wdrażania.
Nazwa wyświetlana nie może zawierać więcej niż 256 znaków.
stages

DeploymentPipelineStageRequest[]

Kolekcja etapów potoku wdrażania.

DeploymentPipelineExtendedInfo

Objekt

Potok wdrażania sieci szkieletowej.

Nazwa Typ Opis
description

string

Opis potoku wdrażania.
displayName

string

Nazwa wyświetlana potoku wdrażania.
id

string (uuid)

Identyfikator potoku wdrażania.
stages

DeploymentPipelineStage[]

Kolekcja etapów potoku wdrażania.

DeploymentPipelineStage

Objekt

Etap potoku wdrażania sieci szkieletowej.

Nazwa Typ Opis
description

string

Opis etapu potoku wdrażania.
displayName

string

Nazwa wyświetlana etapu potoku wdrażania.
id

string (uuid)

Identyfikator etapu potoku wdrażania.
isPublic

boolean

Wskazuje, czy etap potoku wdrażania jest publiczny. Prawda - etap jest publiczny, False - etap nie jest publiczny.
order

integer

Kolejność etapu, począwszy od zera.
workspaceId

string (uuid)

Identyfikator przypisanego obszaru roboczego. Dotyczy tylko wtedy, gdy istnieje przypisany obszar roboczy.
workspaceName

string

Przypisana nazwa obszaru roboczego. Ma zastosowanie tylko wtedy, gdy istnieje przypisany obszar roboczy, a użytkownik ma dostęp do obszaru roboczego.

DeploymentPipelineStageRequest

Objekt

Etap potoku wdrażania sieci szkieletowej.

Nazwa Typ Opis
description

string

maxLength: 1024

Opis etapu potoku wdrażania.
Opis nie może zawierać więcej niż 1024 znaków.
displayName

string

maxLength: 256

Nazwa wyświetlana etapu potoku wdrażania.
Nazwa wyświetlana nie może zawierać więcej niż 256 znaków.
isPublic

boolean

Czy etap potoku wdrażania jest publiczny.

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

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.