Runs - Run Pipeline

Uruchamia potok.

POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?api-version=7.1
POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?pipelineVersion={pipelineVersion}&api-version=7.1

Parametry identyfikatora URI

Nazwisko W Wymagane Typ Opis
organization
path True

string

Nazwa organizacji usługi Azure DevOps.

pipelineId
path True

integer (int32)

Identyfikator potoku.

project
path True

string

Identyfikator projektu lub nazwa projektu

api-version
query True

string

Wersja interfejsu API do użycia. Należy ustawić wartość "7.1", aby używać tej wersji interfejsu API.

pipelineVersion
query

integer (int32)

Wersja potoku.

Treść żądania

Nazwisko Typ Opis
previewRun

boolean

Jeśli to prawda, nie twórz nowego przebiegu. Zamiast tego po przeanalizowaniu szablonów zwróć końcowy dokument YAML.

resources

RunResourcesParameters

Zasoby wymagane przez przebieg.

stagesToSkip

string[]

templateParameters

object

variables

<string,  Variable>

yamlOverride

string

Jeśli używasz opcji uruchamiania w wersji zapoznawczej, opcjonalnie możesz podać inny kod YAML. Dzięki temu można wyświetlić podgląd końcowego dokumentu YAML bez zatwierdzania zmienionego pliku.

Odpowiedzi

Nazwisko Typ Opis
200 OK

Run

operacja zakończona powodzeniem

Zabezpieczenia

oauth2

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Adres URL tokenu: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Zakresy

Nazwisko Opis
vso.build_execute Umożliwia dostęp do artefaktów kompilacji, w tym wyników kompilacji, definicji i żądań oraz możliwość kolejkowania kompilacji, aktualizowania właściwości kompilacji oraz odbierania powiadomień o zdarzeniach kompilacji za pośrednictwem punktów zaczepienia usługi.

Definicje

Nazwisko Opis
BuildResourceParameters
Container
ContainerResource
ContainerResourceParameters
PackageResourceParameters
PipelineReference

Odwołanie do potoku.

PipelineResource
PipelineResourceParameters
ReferenceLinks

Klasa reprezentująca kolekcję linków referencyjnych REST.

Repository
RepositoryResource
RepositoryResourceParameters
RepositoryType
Run
RunPipelineParameters

Ustawienia wpływające na uruchomienia potoku.

RunResources
RunResourcesParameters
RunResult
RunState
Variable

BuildResourceParameters

Nazwisko Typ Opis
version

string

Container

Nazwisko Typ Opis
environment

object

image

string

mapDockerSocket

boolean

options

string

ports

string[]

volumes

string[]

ContainerResource

Nazwisko Typ Opis
container

Container

ContainerResourceParameters

Nazwisko Typ Opis
version

string

PackageResourceParameters

Nazwisko Typ Opis
version

string

PipelineReference

Odwołanie do potoku.

Nazwisko Typ Opis
folder

string

Folder potoku

id

integer (int32)

Identyfikator potoku

name

string

Nazwa potoku

revision

integer (int32)

Numer poprawki

url

string

PipelineResource

Nazwisko Typ Opis
pipeline

PipelineReference

Odwołanie do potoku.

version

string

PipelineResourceParameters

Nazwisko Typ Opis
version

string

Klasa reprezentująca kolekcję linków referencyjnych REST.

Nazwisko Typ Opis
links

object

Czytelny widok linków. Ponieważ linki odwołania są tylko do odczytu, chcemy uwidocznić je tylko jako tylko do odczytu.

Repository

Nazwisko Typ Opis
type

RepositoryType

RepositoryResource

Nazwisko Typ Opis
refName

string

repository

Repository

version

string

RepositoryResourceParameters

Nazwisko Typ Opis
refName

string

token

string

Jest to token zabezpieczający używany podczas nawiązywania połączenia z repozytorium.

tokenType

string

Fakultatywny. Jest to typ podanego tokenu. Jeśli nie zostanie podana, przyjmuje się typ "Bearer". Uwaga: użyj "Basic" dla tokenu PAT.

version

string

RepositoryType

Wartość Opis
unknown
gitHub
azureReposGit
gitHubEnterprise
azureReposGitHyphenated

Run

Nazwisko Typ Opis
_links

ReferenceLinks

Klasa reprezentująca kolekcję linków referencyjnych REST.

createdDate

string (date-time)

finalYaml

string

finishedDate

string (date-time)

id

integer (int32)

name

string

pipeline

PipelineReference

Odwołanie do potoku.

resources

RunResources

result

RunResult

state

RunState

templateParameters

object

url

string

variables

<string,  Variable>

RunPipelineParameters

Ustawienia wpływające na uruchomienia potoku.

Nazwisko Typ Opis
previewRun

boolean

Jeśli to prawda, nie twórz nowego przebiegu. Zamiast tego po przeanalizowaniu szablonów zwróć końcowy dokument YAML.

resources

RunResourcesParameters

Zasoby wymagane przez przebieg.

stagesToSkip

string[]

templateParameters

object

variables

<string,  Variable>

yamlOverride

string

Jeśli używasz opcji uruchamiania w wersji zapoznawczej, opcjonalnie możesz podać inny kod YAML. Dzięki temu można wyświetlić podgląd końcowego dokumentu YAML bez zatwierdzania zmienionego pliku.

RunResources

Nazwisko Typ Opis
containers

<string,  ContainerResource>

pipelines

<string,  PipelineResource>

repositories

<string,  RepositoryResource>

RunResourcesParameters

Nazwisko Typ Opis
builds

<string,  BuildResourceParameters>

containers

<string,  ContainerResourceParameters>

packages

<string,  PackageResourceParameters>

pipelines

<string,  PipelineResourceParameters>

repositories

<string,  RepositoryResourceParameters>

RunResult

Wartość Opis
unknown
succeeded
failed
canceled

RunState

Wartość Opis
unknown
inProgress
canceling
completed

Variable

Nazwisko Typ Opis
isSecret

boolean

value

string