Runs - Run Pipeline

Service:

Pipelines

API Version:

7.1-preview.1

Führt eine Pipeline aus.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
organization	path	True	string	Der Name der Azure DevOps-Organisation.
pipelineId	path	True	integer int32	Die Pipeline-ID.
project	path	True	string	Projekt-ID oder Projektname
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "7.1-preview.1" festgelegt werden, um diese Version der API zu verwenden.
pipelineVersion	query		integer int32	Die Pipelineversion.

Anforderungstext

Name	Typ	Beschreibung
previewRun	boolean	Wenn true, erstellen Sie keine neue Ausführung. Geben Sie stattdessen das endgültige YAML-Dokument zurück, nachdem Sie Vorlagen analysiert haben.
resources	RunResourcesParameters	Die Ressourcen, die für die Ausführung erforderlich sind.
stagesToSkip	string[]
templateParameters	object
variables	<string,  Variable>
yamlOverride	string	Wenn Sie die Vorschauausführungsoption verwenden, können Sie optional verschiedene YAML bereitstellen. Dadurch können Sie eine Vorschau des endgültigen YAML-Dokuments anzeigen, ohne eine geänderte Datei zu übernehmen.

Antworten

Name	Typ	Beschreibung
200 OK	Run	Erfolgreicher Vorgang

Sicherheit

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

Name	Beschreibung
vso.build_execute	Ermöglicht den Zugriff auf Buildartefakte, einschließlich Buildergebnissen, Definitionen und Anforderungen, sowie die Möglichkeit, einen Build in eine Warteschlange zu stellen, Buildeigenschaften zu aktualisieren und Benachrichtigungen über Buildereignisse über Diensthaken zu empfangen.

Definitionen

Name	Beschreibung
BuildResourceParameters
Container
ContainerResource
ContainerResourceParameters
PackageResourceParameters
PipelineReference	Ein Verweis auf eine Pipeline.
PipelineResource
PipelineResourceParameters
ReferenceLinks	Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.
Repository
RepositoryResource
RepositoryResourceParameters
RepositoryType
Run
RunPipelineParameters	Einstellungen, die die Pipelineausführung beeinflussen.
RunResources
RunResourcesParameters
RunResult
RunState
Variable

BuildResourceParameters

Name	Typ	Beschreibung
version	string

Container

Name	Typ	Beschreibung
environment	object
image	string
mapDockerSocket	boolean
options	string
ports	string[]
volumes	string[]

ContainerResource

Name	Typ	Beschreibung
container	Container

ContainerResourceParameters

Name	Typ	Beschreibung
version	string

PackageResourceParameters

Name	Typ	Beschreibung
version	string

PipelineReference

Ein Verweis auf eine Pipeline.

Name	Typ	Beschreibung
folder	string	Pipelineordner
id	integer	Pipeline-ID
name	string	Pipelinename
revision	integer	Revisionsnummer
url	string

PipelineResource

Name	Typ	Beschreibung
pipeline	PipelineReference	Ein Verweis auf eine Pipeline.
version	string

PipelineResourceParameters

Name	Typ	Beschreibung
version	string

ReferenceLinks

Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.

Name	Typ	Beschreibung
links	object	Die schreibgeschützte Ansicht der Links. Da Verweislinks schreibgeschützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen.

Repository

Name	Typ	Beschreibung
type	RepositoryType

RepositoryResource

Name	Typ	Beschreibung
refName	string
repository	Repository
version	string

RepositoryResourceParameters

Name	Typ	Beschreibung
refName	string
token	string	Dies ist das Sicherheitstoken, das beim Herstellen einer Verbindung mit dem Repository verwendet werden soll.
tokenType	string	Optional. Dies ist der Typ des angegebenen Tokens. Wenn nicht angegeben, wird ein Typ von "Bearer" angenommen. Hinweis: Verwenden Sie "Basic" für ein PAT-Token.
version	string

RepositoryType

Name	Typ	Beschreibung
azureReposGit	string
azureReposGitHyphenated	string
gitHub	string
gitHubEnterprise	string
unknown	string

Run

Name	Typ	Beschreibung
_links	ReferenceLinks	Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.
createdDate	string
finalYaml	string
finishedDate	string
id	integer
name	string
pipeline	PipelineReference	Ein Verweis auf eine Pipeline.
resources	RunResources
result	RunResult
state	RunState
templateParameters	object
url	string
variables	<string,  Variable>

RunPipelineParameters

Einstellungen, die die Pipelineausführung beeinflussen.

Name	Typ	Beschreibung
previewRun	boolean	Wenn true, erstellen Sie keine neue Ausführung. Geben Sie stattdessen das endgültige YAML-Dokument zurück, nachdem Sie Vorlagen analysiert haben.
resources	RunResourcesParameters	Die Ressourcen, die für die Ausführung erforderlich sind.
stagesToSkip	string[]
templateParameters	object
variables	<string,  Variable>
yamlOverride	string	Wenn Sie die Vorschauausführungsoption verwenden, können Sie optional verschiedene YAML bereitstellen. Dadurch können Sie eine Vorschau des endgültigen YAML-Dokuments anzeigen, ohne eine geänderte Datei zu übernehmen.

RunResources

Name	Typ	Beschreibung
containers	<string,  ContainerResource>
pipelines	<string,  PipelineResource>
repositories	<string,  RepositoryResource>

RunResourcesParameters

Name	Typ	Beschreibung
builds	<string,  BuildResourceParameters>
containers	<string,  ContainerResourceParameters>
packages	<string,  PackageResourceParameters>
pipelines	<string,  PipelineResourceParameters>
repositories	<string,  RepositoryResourceParameters>

RunResult

Name	Typ	Beschreibung
canceled	string
failed	string
succeeded	string
unknown	string

RunState

Name	Typ	Beschreibung
canceling	string
completed	string
inProgress	string
unknown	string

Variable

Name	Typ	Beschreibung
isSecret	boolean
value	string