Runs - Run Pipeline

Service:

Pipelines

API Version:

7.1-preview.1

Uruchamia potok.

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

With optional parameters:

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

Parametry identyfikatora URI

Nazwa	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. Powinno to być ustawione na wartość "7.1-preview.1", aby używać tej wersji interfejsu API.
pipelineVersion	query		integer int32	Wersja potoku.

Treść żądania

Nazwa	Typ	Opis
previewRun	boolean	Jeśli to prawda, nie twórz nowego przebiegu. Zamiast tego należy zwrócić końcowy dokument YAML po przeanalizowaniu szablonów.
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

Nazwa	Typ	Opis
200 OK	Run	operacja zakończona powodzeniem

Zabezpieczenia

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: 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

Scopes

Nazwa	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 możliwości odbierania powiadomień o zdarzeniach kompilacji za pośrednictwem punktów zaczepienia usługi.

Definicje

Nazwa	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 przebieg potoku.
RunResources
RunResourcesParameters
RunResult
RunState
Variable

BuildResourceParameters

Nazwa	Typ	Opis
version	string

Container

Nazwa	Typ	Opis
environment	object
image	string
mapDockerSocket	boolean
options	string
ports	string[]
volumes	string[]

ContainerResource

Nazwa	Typ	Opis
container	Container

ContainerResourceParameters

Nazwa	Typ	Opis
version	string

PackageResourceParameters

Nazwa	Typ	Opis
version	string

PipelineReference

Odwołanie do potoku.

Nazwa	Typ	Opis
folder	string	Folder potoku
id	integer	Identyfikator potoku
name	string	Nazwa potoku
revision	integer	Numer poprawki
url	string

PipelineResource

Nazwa	Typ	Opis
pipeline	PipelineReference	Odwołanie do potoku.
version	string

PipelineResourceParameters

Nazwa	Typ	Opis
version	string

ReferenceLinks

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

Nazwa	Typ	Opis
links	object	Czytelny widok linków. Ponieważ linki referencyjne są czytelne, chcemy uwidocznić je tylko jako tylko do odczytu.

Repository

Nazwa	Typ	Opis
type	RepositoryType

RepositoryResource

Nazwa	Typ	Opis
refName	string
repository	Repository
version	string

RepositoryResourceParameters

Nazwa	Typ	Opis
refName	string
token	string	Jest to token zabezpieczający używany podczas nawiązywania połączenia z repozytorium.
tokenType	string	Opcjonalny. Jest to typ podanego tokenu. Jeśli nie podano, przyjmuje się typ "Bearer". Uwaga: użyj polecenia "Basic" dla tokenu pat.
version	string

RepositoryType

Nazwa	Typ	Opis
azureReposGit	string
azureReposGitHyphenated	string
gitHub	string
gitHubEnterprise	string
unknown	string

Run

Nazwa	Typ	Opis
_links	ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
createdDate	string
finalYaml	string
finishedDate	string
id	integer
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 przebieg potoku.

Nazwa	Typ	Opis
previewRun	boolean	Jeśli to prawda, nie twórz nowego przebiegu. Zamiast tego należy zwrócić końcowy dokument YAML po przeanalizowaniu szablonów.
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

Nazwa	Typ	Opis
containers	<string,  ContainerResource>
pipelines	<string,  PipelineResource>
repositories	<string,  RepositoryResource>

RunResourcesParameters

Nazwa	Typ	Opis
builds	<string,  BuildResourceParameters>
containers	<string,  ContainerResourceParameters>
packages	<string,  PackageResourceParameters>
pipelines	<string,  PipelineResourceParameters>
repositories	<string,  RepositoryResourceParameters>

RunResult

Nazwa	Typ	Opis
canceled	string
failed	string
succeeded	string
unknown	string

RunState

Nazwa	Typ	Opis
canceling	string
completed	string
inProgress	string
unknown	string

Variable

Nazwa	Typ	Opis
isSecret	boolean
value	string