Runs - Run Pipeline
Spustí kanál.
POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?api-version=7.1POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?pipelineVersion={pipelineVersion}&api-version=7.1Parametry identifikátoru URI
| Name | V | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Název organizace Azure DevOps. |
|
pipeline
|
path | True |
integer (int32) |
ID kanálu. |
|
project
|
path | True |
string |
ID projektu nebo název projektu |
|
api-version
|
query | True |
string |
Verze rozhraní API, která se má použít. Pokud chcete použít tuto verzi rozhraní API, měla by být nastavená na hodnotu 7.1. |
|
pipeline
|
query |
integer (int32) |
Verze kanálu. |
Text požadavku
| Name | Typ | Description |
|---|---|---|
| previewRun |
boolean |
Pokud ano, ve skutečnosti nevytvořte nové spuštění. Místo toho po analýze šablon vraťte konečný dokument YAML. |
| resources |
Prostředky, které spuštění vyžaduje. |
|
| stagesToSkip |
string[] |
|
| templateParameters |
object |
|
| variables |
<string, Variable> |
|
| yamlOverride |
string |
Pokud použijete možnost spuštění ve verzi Preview, můžete volitelně zadat jiný YAML. To vám umožní zobrazit náhled konečného dokumentu YAML bez potvrzení změněný soubor. |
Odpovědi
| Name | Typ | Description |
|---|---|---|
| 200 OK |
úspěšná operace |
Zabezpečení
oauth2
Typ:
oauth2
Tok:
accessCode
URL autorizace:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
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
Rozsahy
| Name | Description |
|---|---|
| vso.build_execute | Uděluje možnost získat přístup k artefaktům sestavení, včetně výsledků sestavení, definic a požadavků, a možnost zařadit sestavení do fronty, aktualizovat vlastnosti sestavení a možnost přijímat oznámení o událostech sestavení prostřednictvím volání služeb. |
Definice
| Name | Description |
|---|---|
|
Build |
|
| Container | |
|
Container |
|
|
Container |
|
|
Package |
|
|
Pipeline |
Odkaz na kanál. |
|
Pipeline |
|
|
Pipeline |
|
|
Reference |
Třída představující kolekci odkazů REST. |
| Repository | |
|
Repository |
|
|
Repository |
|
|
Repository |
|
| Run | |
|
Run |
Nastavení, která ovlivňují spuštění kanálu. |
|
Run |
|
|
Run |
|
|
Run |
|
|
Run |
|
| Variable |
BuildResourceParameters
| Name | Typ | Description |
|---|---|---|
| version |
string |
Container
| Name | Typ | Description |
|---|---|---|
| environment |
object |
|
| image |
string |
|
| mapDockerSocket |
boolean |
|
| options |
string |
|
| ports |
string[] |
|
| volumes |
string[] |
ContainerResource
| Name | Typ | Description |
|---|---|---|
| container |
ContainerResourceParameters
| Name | Typ | Description |
|---|---|---|
| version |
string |
PackageResourceParameters
| Name | Typ | Description |
|---|---|---|
| version |
string |
PipelineReference
Odkaz na kanál.
| Name | Typ | Description |
|---|---|---|
| folder |
string |
Složka kanálu |
| id |
integer (int32) |
ID kanálu |
| name |
string |
Název kanálu |
| revision |
integer (int32) |
Číslo revize |
| url |
string |
PipelineResource
| Name | Typ | Description |
|---|---|---|
| pipeline |
Odkaz na kanál. |
|
| version |
string |
PipelineResourceParameters
| Name | Typ | Description |
|---|---|---|
| version |
string |
ReferenceLinks
Třída představující kolekci odkazů REST.
| Name | Typ | Description |
|---|---|---|
| links |
object |
Jen pro čtení odkazů. Vzhledem k tomu, že odkazy odkazy jsou jen pro čtení, chceme je zveřejnit jen pro čtení. |
Repository
| Name | Typ | Description |
|---|---|---|
| type |
RepositoryResource
| Name | Typ | Description |
|---|---|---|
| refName |
string |
|
| repository | ||
| version |
string |
RepositoryResourceParameters
| Name | Typ | Description |
|---|---|---|
| refName |
string |
|
| token |
string |
Toto je token zabezpečení, který se použije při připojování k úložišti. |
| tokenType |
string |
Volitelný. Toto je typ daného tokenu. Pokud není zadán, předpokládá se typ "Bearer". Poznámka: Pro token PAT použijte "Basic". |
| version |
string |
RepositoryType
| Hodnota | Description |
|---|---|
| azureReposGit | |
| azureReposGitHyphenated | |
| gitHub | |
| gitHubEnterprise | |
| unknown |
Run
| Name | Typ | Description |
|---|---|---|
| _links |
Třída představující kolekci odkazů REST. |
|
| createdDate |
string (date-time) |
|
| finalYaml |
string |
|
| finishedDate |
string (date-time) |
|
| id |
integer (int32) |
|
| name |
string |
|
| pipeline |
Odkaz na kanál. |
|
| resources | ||
| result | ||
| state | ||
| templateParameters |
object |
|
| url |
string |
|
| variables |
<string, Variable> |
RunPipelineParameters
Nastavení, která ovlivňují spuštění kanálu.
| Name | Typ | Description |
|---|---|---|
| previewRun |
boolean |
Pokud ano, ve skutečnosti nevytvořte nové spuštění. Místo toho po analýze šablon vraťte konečný dokument YAML. |
| resources |
Prostředky, které spuštění vyžaduje. |
|
| stagesToSkip |
string[] |
|
| templateParameters |
object |
|
| variables |
<string, Variable> |
|
| yamlOverride |
string |
Pokud použijete možnost spuštění ve verzi Preview, můžete volitelně zadat jiný YAML. To vám umožní zobrazit náhled konečného dokumentu YAML bez potvrzení změněný soubor. |
RunResources
| Name | Typ | Description |
|---|---|---|
| containers |
<string,
Container |
|
| pipelines |
<string,
Pipeline |
|
| repositories |
<string,
Repository |
RunResourcesParameters
| Name | Typ | Description |
|---|---|---|
| builds |
<string,
Build |
|
| containers |
<string,
Container |
|
| packages |
<string,
Package |
|
| pipelines |
<string,
Pipeline |
|
| repositories |
<string,
Repository |
RunResult
| Hodnota | Description |
|---|---|
| canceled | |
| failed | |
| succeeded | |
| unknown |
RunState
| Hodnota | Description |
|---|---|
| canceling | |
| completed | |
| inProgress | |
| unknown |
Variable
| Name | Typ | Description |
|---|---|---|
| isSecret |
boolean |
|
| value |
string |