Freigeben über

Runs - Run Pipeline

  • Referenz
Dienst:
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
Mit optionalen Parametern: 
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

Typ: oauth2
Ablauf: accessCode
Autorisierungs-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

Bereiche

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

Objekt
Name Typ Beschreibung
version

string

Container

Objekt
Name Typ Beschreibung
environment

object

image

string

mapDockerSocket

boolean

options

string

ports

string[]

volumes

string[]

ContainerResource

Objekt
Name Typ Beschreibung
container

Container

ContainerResourceParameters

Objekt
Name Typ Beschreibung
version

string

PackageResourceParameters

Objekt
Name Typ Beschreibung
version

string

PipelineReference

Objekt

Ein Verweis auf eine Pipeline.

Name Typ Beschreibung
folder

string

Pipelineordner
id

integer

Pipeline-ID
name

string

Pipelinename
revision

integer

Revisionsnummer
url

string

PipelineResource

Objekt
Name Typ Beschreibung
pipeline

PipelineReference

Ein Verweis auf eine Pipeline.
version

string

PipelineResourceParameters

Objekt
Name Typ Beschreibung
version

string

Objekt

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

Objekt
Name Typ Beschreibung
type

RepositoryType

RepositoryResource

Objekt
Name Typ Beschreibung
refName

string

repository

Repository

version

string

RepositoryResourceParameters

Objekt
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

Enumeration
Wert Beschreibung
azureReposGit
azureReposGitHyphenated
gitHub
gitHubEnterprise
unknown

Run

Objekt
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

Objekt

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

Objekt
Name Typ Beschreibung
containers

<string,  ContainerResource>

pipelines

<string,  PipelineResource>

repositories

<string,  RepositoryResource>

RunResourcesParameters

Objekt
Name Typ Beschreibung
builds

<string,  BuildResourceParameters>

containers

<string,  ContainerResourceParameters>

packages

<string,  PackageResourceParameters>

pipelines

<string,  PipelineResourceParameters>

repositories

<string,  RepositoryResourceParameters>

RunResult

Enumeration
Wert Beschreibung
canceled
failed
succeeded
unknown

RunState

Enumeration
Wert Beschreibung
canceling
completed
inProgress
unknown

Variable

Objekt
Name Typ Beschreibung
isSecret

boolean

value

string