Runs - Run Pipeline
執行管線。
POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?api-version=6.1-preview.1
POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?pipelineVersion={pipelineVersion}&api-version=6.1-preview.1
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
organization
|
path | True |
string |
Azure DevOps 組織的名稱。 |
pipeline
|
path | True |
integer int32 |
管線識別碼。 |
project
|
path | True |
string |
專案識別碼或專案名稱 |
api-version
|
query | True |
string |
要使用的 API 版本。 這應該設定為 '6.1-preview.1' 以使用此版本的 API。 |
pipeline
|
query |
integer int32 |
管線版本。 |
要求本文
名稱 | 類型 | Description |
---|---|---|
previewRun |
boolean |
如果為 true,請勿實際建立新的執行。 相反地,在剖析範本之後傳回最終 YAML 檔。 |
resources |
執行所需的資源。 |
|
stagesToSkip |
string[] |
|
templateParameters |
object |
|
variables |
<string, Variable> |
|
yamlOverride |
string |
如果您使用預覽執行選項,您可以選擇性地提供不同的 YAML。 這可讓您預覽最終 YAML 檔,而不認可已變更的檔案。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
成功作業 |
安全性
accessToken
個人存取權杖。 針對使用者名稱和權杖使用任何值作為密碼。
Type:
basic
定義
BuildResourceParameters
名稱 | 類型 | Description |
---|---|---|
version |
string |
ContainerResourceParameters
名稱 | 類型 | Description |
---|---|---|
version |
string |
PackageResourceParameters
名稱 | 類型 | Description |
---|---|---|
version |
string |
PipelineReference
管線的參考。
名稱 | 類型 | Description |
---|---|---|
folder |
string |
管線資料夾 |
id |
integer |
管線識別碼 |
name |
string |
管線名稱 |
revision |
integer |
修訂編號 |
url |
string |
PipelineResourceParameters
名稱 | 類型 | Description |
---|---|---|
version |
string |
ReferenceLinks
表示 REST 參考連結集合的類別。
名稱 | 類型 | Description |
---|---|---|
links |
object |
連結的唯讀檢視。 因為參考連結是唯讀的,所以我們只想要將它們公開為唯讀。 |
Repository
名稱 | 類型 | Description |
---|---|---|
type |
RepositoryResource
名稱 | 類型 | Description |
---|---|---|
refName |
string |
|
repository | ||
version |
string |
RepositoryResourceParameters
名稱 | 類型 | Description |
---|---|---|
refName |
string |
|
token |
string |
這是連接到存放庫時要使用的安全性權杖。 |
tokenType |
string |
選擇性。 這是指定的權杖類型。 如果未提供,則會假設有一種類型的 「Bearer」。 注意:針對 PAT 權杖使用「基本」。 |
version |
string |
RepositoryType
名稱 | 類型 | Description |
---|---|---|
azureReposGit |
string |
|
azureReposGitHyphenated |
string |
|
gitHub |
string |
|
gitHubEnterprise |
string |
|
unknown |
string |
Run
名稱 | 類型 | Description |
---|---|---|
_links |
表示 REST 參考連結集合的類別。 |
|
createdDate |
string |
|
finalYaml |
string |
|
finishedDate |
string |
|
id |
integer |
|
name |
string |
|
pipeline |
管線的參考。 |
|
resources | ||
result | ||
state | ||
url |
string |
|
variables |
<string, Variable> |
RunPipelineParameters
影響管線執行的設定。
名稱 | 類型 | Description |
---|---|---|
previewRun |
boolean |
如果為 true,請勿實際建立新的執行。 相反地,在剖析範本之後傳回最終 YAML 檔。 |
resources |
執行所需的資源。 |
|
stagesToSkip |
string[] |
|
templateParameters |
object |
|
variables |
<string, Variable> |
|
yamlOverride |
string |
如果您使用預覽執行選項,您可以選擇性地提供不同的 YAML。 這可讓您預覽最終 YAML 檔,而不認可已變更的檔案。 |
RunResources
名稱 | 類型 | Description |
---|---|---|
repositories |
<string,
Repository |
RunResourcesParameters
名稱 | 類型 | Description |
---|---|---|
builds |
<string,
Build |
|
containers |
<string,
Container |
|
packages |
<string,
Package |
|
pipelines |
<string,
Pipeline |
|
repositories |
<string,
Repository |
RunResult
名稱 | 類型 | Description |
---|---|---|
canceled |
string |
|
failed |
string |
|
succeeded |
string |
|
unknown |
string |
RunState
名稱 | 類型 | Description |
---|---|---|
canceling |
string |
|
completed |
string |
|
inProgress |
string |
|
unknown |
string |
Variable
名稱 | 類型 | Description |
---|---|---|
isSecret |
boolean |
|
value |
string |