Releases - Update Release Environment
更新發行環境的狀態
PATCH https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/releases/{releaseId}/environments/{environmentId}?api-version=7.1-preview.7
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
environment
|
path | True |
integer int32 |
發行環境的識別碼。 |
organization
|
path | True |
string |
Azure DevOps 組織的名稱。 |
project
|
path | True |
string |
專案識別碼或專案名稱 |
release
|
path | True |
integer int32 |
版本的識別碼。 |
api-version
|
query | True |
string |
要使用的 API 版本。 這應該設定為 '7.1-preview.7' 以使用此版本的 API。 |
要求本文
名稱 | 類型 | Description |
---|---|---|
comment |
string |
取得或設定批註。 |
scheduledDeploymentTime |
string |
取得或設定排程的部署時間。 |
status |
取得或設定環境的狀態。 |
|
variables |
<string,
Configuration |
設定部署時要覆寫的環境變數清單。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
成功的作業 |
安全性
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
名稱 | Description |
---|---|
vso.release_execute | 授與讀取和更新發行成品的能力,包括資料夾、發行、發行定義和發行環境,以及將新版本排入佇列的能力。 |
範例
Start deployment on an environment
Sample Request
PATCH https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/releases/{releaseId}/environments/{environmentId}?api-version=7.1-preview.7
{
"status": "inProgress",
"scheduledDeploymentTime": null,
"comment": null,
"variables": {}
}
Sample Response
{
"id": 45,
"releaseId": 45,
"name": "PROD",
"status": "queued",
"variables": {},
"variableGroups": [],
"preDeployApprovals": [],
"postDeployApprovals": [],
"preApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": false,
"isNotificationOn": false,
"approver": {
"displayName": "Chuck Reinhart",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
"_links": {
"avatar": {
"href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
}
},
"id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
"uniqueName": "fabfiber@outlook.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
"descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
},
"id": 0
}
],
"approvalOptions": {
"requiredApproverCount": 0,
"releaseCreatorCanBeApprover": true,
"autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
"enforceIdentityRevalidation": false,
"timeoutInMinutes": 0,
"executionOrder": "beforeGates"
}
},
"postApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"deploySteps": [],
"rank": 1,
"definitionEnvironmentId": 23,
"environmentOptions": {
"emailNotificationType": "OnlyOnFailure",
"emailRecipients": "release.environment.owner;release.creator",
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"enableAccessToken": false,
"publishDeploymentStatus": false,
"badgeEnabled": false,
"autoLinkWorkItems": false,
"pullRequestDeploymentEnabled": false
},
"demands": [],
"conditions": [],
"workflowTasks": [],
"deployPhasesSnapshot": [
{
"deploymentInput": {
"parallelExecution": {
"parallelExecutionType": "none"
},
"skipArtifactsDownload": false,
"artifactsDownloadInput": {
"downloadInputs": []
},
"queueId": 0,
"demands": [],
"enableAccessToken": false,
"timeoutInMinutes": 0,
"jobCancelTimeoutInMinutes": 1,
"condition": "succeeded()",
"overrideInputs": {}
},
"rank": 1,
"phaseType": "agentBasedDeployment",
"name": "Run on agent",
"refName": null,
"workflowTasks": []
}
],
"owner": {
"displayName": "Chuck Reinhart",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
"_links": {
"avatar": {
"href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
}
},
"id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
"uniqueName": "fabfiber@outlook.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
"descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
},
"schedules": [],
"release": {
"id": 45,
"name": "Release-2",
"url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/45",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?releaseId=45&_a=release-summary"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/45"
}
}
},
"releaseDefinition": {
"id": 23,
"name": "Fabrikam-web",
"path": "\\",
"projectReference": null,
"url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/23",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=23"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/23"
}
}
},
"releaseCreatedBy": {
"displayName": "Chuck Reinhart",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
"_links": {
"avatar": {
"href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
}
},
"id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
"uniqueName": "fabfiber@outlook.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
"descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
},
"triggerReason": "Manual",
"preDeploymentGatesSnapshot": {
"id": 0,
"gatesOptions": null,
"gates": []
},
"postDeploymentGatesSnapshot": {
"id": 0,
"gatesOptions": null,
"gates": []
}
}
定義
ApprovalExecutionOrder
核准執行順序。
名稱 | 類型 | Description |
---|---|---|
afterGatesAlways |
string |
執行閘道之後,一律會顯示核准。 |
afterSuccessfulGates |
string |
成功執行閘道之後顯示的核准。 |
beforeGates |
string |
閘道之前顯示的核准。 |
ApprovalOptions
名稱 | 類型 | Description |
---|---|---|
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped |
boolean |
指定如果相同的核准者核准前一個階段,是否可以略過核准。 |
enforceIdentityRevalidation |
boolean |
指定是否在完成核准之前重新驗證核准者的身分識別。 |
executionOrder |
核准執行順序。 |
|
releaseCreatorCanBeApprover |
boolean |
指定要求發行或部署的使用者是否應該允許核准者。 |
requiredApproverCount |
integer |
向前發行所需的核准數目。 '0' 表示所有需要核准。 |
timeoutInMinutes |
integer |
核准逾時。 核准預設逾時為 30 天。 允許的逾時上限為 365 天。 '0' 表示預設逾時,也就是 30 天。 |
ApprovalStatus
取得或設定核准的狀態。
名稱 | 類型 | Description |
---|---|---|
approved |
string |
指出核准已核准。 |
canceled |
string |
表示核准已取消。 |
pending |
string |
表示核准擱置中。 |
reassigned |
string |
指出已重新指派核准。 |
rejected |
string |
表示核准遭到拒絕。 |
skipped |
string |
表示已略過核准。 |
undefined |
string |
表示核准沒有狀態集。 |
ApprovalType
取得或設定核准的類型。
名稱 | 類型 | Description |
---|---|---|
all |
string |
表示所有核准。 |
postDeploy |
string |
指出部署之後執行的核准。 |
preDeploy |
string |
指出在部署之前執行的核准。 |
undefined |
string |
表示未設定核准類型。 |
AuthorizationHeader
名稱 | 類型 | Description |
---|---|---|
name |
string |
|
value |
string |
ConditionType
取得或設定條件類型。
名稱 | 類型 | Description |
---|---|---|
artifact |
string |
條件類型為成品。 |
environmentState |
string |
條件類型為環境狀態。 |
event |
string |
條件類型為 事件。 |
undefined |
string |
條件類型未定義。 |
ConfigurationVariableValue
名稱 | 類型 | Description |
---|---|---|
allowOverride |
boolean |
取得及設定是否可以在部署期間覆寫變數。 |
isSecret |
boolean |
取得或設定為變數是秘密或不是。 |
value |
string |
取得和設定組態變數的值。 |
DataSourceBindingBase
表示服務端點要求的資料來源系結。
名稱 | 類型 | Description |
---|---|---|
callbackContextTemplate |
string |
此資料來源支援的分頁格式 (ContinuationToken/SkipTop) 。 |
callbackRequiredTemplate |
string |
需要後續的呼叫嗎? |
dataSourceName |
string |
取得或設定資料來源的名稱。 |
endpointId |
string |
取得或設定端點識別碼。 |
endpointUrl |
string |
取得或設定服務端點的 URL。 |
headers |
取得或設定授權標頭。 |
|
initialContextTemplate |
string |
定義查詢參數的初始值 |
parameters |
object |
取得或設定資料來源的參數。 |
requestContent |
string |
取得或設定 HTTP 要求本文 |
requestVerb |
string |
取得或設定 HTTP 要求動詞 |
resultSelector |
string |
取得或設定結果選取器。 |
resultTemplate |
string |
取得或設定結果範本。 |
target |
string |
取得或設定資料來源的目標。 |
DeploymentAttempt
名稱 | 類型 | Description |
---|---|---|
attempt |
integer |
部署嘗試。 |
deploymentId |
integer |
部署的識別碼。 |
hasStarted |
boolean |
指定是否已啟動部署。 |
id |
integer |
部署的識別碼。 |
issues |
Issue[] |
與部署相關的所有問題。 |
lastModifiedBy |
上次修改此部署的身分識別。 |
|
lastModifiedOn |
string |
上次修改此部署的時間。 |
operationStatus |
部署作業狀態。 |
|
postDeploymentGates |
在此部署中執行的部署後閘道。 |
|
preDeploymentGates |
在此部署中執行的預先部署閘道。 |
|
queuedOn |
string |
此部署排入佇列時。 |
reason |
部署的原因。 |
|
releaseDeployPhases |
在此部署中執行的發行部署階段清單。 |
|
requestedBy |
要求此部署的身分識別。 |
|
requestedFor |
要求此部署的身分識別。 |
|
status |
部署的狀態。 |
DeploymentJob
名稱 | 類型 | Description |
---|---|---|
job |
所有已執行工作的父工作。 |
|
tasks |
作業中已執行的工作清單。 |
DeploymentOperationStatus
取得部署的作業狀態。
名稱 | 類型 | Description |
---|---|---|
all |
string |
部署作業狀態為全部。 |
approved |
string |
部署作業狀態已核准。 |
canceled |
string |
部署作業狀態已取消。 |
cancelling |
string |
部署作業狀態正在取消。 |
deferred |
string |
部署作業狀態會延後。 |
evaluatingGates |
string |
部署作業狀態為 EvaluatingGates。 |
gateFailed |
string |
部署作業狀態為 GateFailed。 |
manualInterventionPending |
string |
部署作業狀態為 manualintervention 擱置中。 |
pending |
string |
部署作業狀態為擱置中。 |
phaseCanceled |
string |
部署作業狀態為階段已取消。 |
phaseFailed |
string |
部署作業狀態為階段失敗。 |
phaseInProgress |
string |
部署作業狀態為進行中的階段。 |
phasePartiallySucceeded |
string |
部署作業狀態是部分成功的階段。 |
phaseSucceeded |
string |
部署作業狀態為階段成功。 |
queued |
string |
部署作業狀態已排入佇列。 |
queuedForAgent |
string |
部署作業狀態已排入佇列以供代理程式使用。 |
queuedForPipeline |
string |
部署作業狀態已排入佇列以供管線使用。 |
rejected |
string |
部署作業狀態遭到拒絕。 |
scheduled |
string |
已排程部署作業狀態。 |
undefined |
string |
未定義部署作業狀態。 |
DeploymentReason
取得部署的原因。
名稱 | 類型 | Description |
---|---|---|
automated |
string |
部署原因為自動化。 |
manual |
string |
部署原因為手動。 |
none |
string |
部署原因為無。 |
redeployTrigger |
string |
部署原因為 RedeployTrigger。 |
scheduled |
string |
已排程部署原因。 |
DeploymentStatus
取得部署的狀態。
名稱 | 類型 | Description |
---|---|---|
all |
string |
部署狀態為全部。 |
failed |
string |
部署狀態失敗。 |
inProgress |
string |
部署狀態正在進行中。 |
notDeployed |
string |
未部署部署狀態。 |
partiallySucceeded |
string |
部署狀態已部分取得。 |
succeeded |
string |
部署狀態成功。 |
undefined |
string |
部署狀態未定義。 |
DeployPhase
名稱 | 類型 | Description |
---|---|---|
name |
string |
取得和設定部署階段的名稱。 |
phaseType |
指出部署階段類型。 |
|
rank |
integer |
取得並設定部署階段的排名。 |
refName |
string |
取得和設定部署階段的參考名稱。 |
workflowTasks |
取得和設定部署階段的工作流程工作。 |
DeployPhaseStatus
階段的狀態。
名稱 | 類型 | Description |
---|---|---|
canceled |
string |
階段執行已取消。 |
cancelling |
string |
階段處於取消狀態。 |
failed |
string |
階段執行失敗。 |
inProgress |
string |
進行中的階段執行。 |
notStarted |
string |
階段執行未啟動。 |
partiallySucceeded |
string |
階段執行部分成功。 |
skipped |
string |
略過階段執行。 |
succeeded |
string |
階段執行成功。 |
undefined |
string |
未設定階段狀態。 |
DeployPhaseTypes
指出部署階段類型。
名稱 | 類型 | Description |
---|---|---|
agentBasedDeployment |
string |
階段類型,其中包含在代理程式上執行的工作。 |
deploymentGates |
string |
階段類型,其中包含作為要繼續部署之閘道的工作。 |
machineGroupBasedDeployment |
string |
階段類型,其中包含部署群組機器上執行的工作。 |
runOnServer |
string |
階段類型,其中包含伺服器執行的工作。 |
undefined |
string |
未定義階段類型。 請勿使用。 |
EnvironmentOptions
名稱 | 類型 | Description |
---|---|---|
autoLinkWorkItems |
boolean |
取得和設定為自動連結工作專案。 |
badgeEnabled |
boolean |
取得並設定為啟用徽章。 |
publishDeploymentStatus |
boolean |
取得並設定為發行部署狀態。 |
pullRequestDeploymentEnabled |
boolean |
取得並設定為啟用或未啟用的.pull 要求部署。 |
EnvironmentStatus
取得環境狀態。
名稱 | 類型 | Description |
---|---|---|
canceled |
string |
環境處於已取消狀態。 |
inProgress |
string |
環境處於進行中狀態。 |
notStarted |
string |
環境處於未啟動狀態。 |
partiallySucceeded |
string |
環境處於部分成功狀態。 |
queued |
string |
環境處於佇列狀態。 |
rejected |
string |
環境處於拒絕狀態。 |
scheduled |
string |
環境處於排程狀態。 |
succeeded |
string |
環境處於成功狀態。 |
undefined |
string |
未設定環境狀態。 |
GateStatus
發行閘道的狀態。
名稱 | 類型 | Description |
---|---|---|
canceled |
string |
閘道執行已取消。 |
failed |
string |
閘道執行失敗。 |
inProgress |
string |
閘道目前正在進行中。 |
none |
string |
閘道沒有狀態設定。 |
pending |
string |
閘道處於擱置狀態。 |
succeeded |
string |
閘道成功完成。 |
IdentityRef
名稱 | 類型 | Description |
---|---|---|
_links |
此欄位包含有關圖表主旨的零個或多個有趣連結。 您可以叫用這些連結來取得其他關聯性,或取得此圖表主體的詳細資訊。 |
|
descriptor |
string |
描述項是在系統執行時參考圖形主旨的主要方式。 此欄位可唯一識別帳戶和組織之間的相同圖表主旨。 |
directoryAlias |
string |
已淘汰 - 藉由查詢 IdentityRef 「_links」 字典之 「self」 專案中參考的 Graph 使用者,即可擷取 |
displayName |
string |
這是圖表主旨的非唯一顯示名稱。 若要變更此欄位,您必須在來源提供者中變更其值。 |
id |
string |
|
imageUrl |
string |
已淘汰 - 可在 IdentityRef 「_links」 字典的 「avatar」 專案中使用 |
inactive |
boolean |
已淘汰 - 您可以查詢 GraphUser 「_links」 字典的 「membershipState」 專案中參考的 Graph 成員資格狀態來擷取 |
isAadIdentity |
boolean |
已被取代 - 可以從描述元的主旨類型推斷 (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
isContainer |
boolean |
已被取代 - 可以從描述元的主旨類型推斷 (Descriptor.IsGroupType) |
isDeletedInOrigin |
boolean |
|
profileUrl |
string |
已淘汰 - 不在 ToIdentityRef 的大多數既有實作中使用 |
uniqueName |
string |
已淘汰 - 請改用 Domain+PrincipalName |
url |
string |
此 URL 是此圖表主體來源資源的完整路由。 |
IgnoredGate
名稱 | 類型 | Description |
---|---|---|
lastModifiedOn |
string |
取得上次忽略閘道的日期。 |
name |
string |
忽略閘道的名稱。 |
Issue
名稱 | 類型 | Description |
---|---|---|
data |
object |
發出資料。 |
issueType |
string |
問題類型,例如錯誤、警告或資訊。 |
message |
string |
問題訊息。 |
ManualIntervention
名稱 | 類型 | Description |
---|---|---|
approver |
取得或設定應該核准的身分識別。 |
|
comments |
string |
取得或設定核准的批註。 |
createdOn |
string |
取得建立日期。 |
id |
integer |
取得手動介入的唯一識別碼。 |
instructions |
string |
取得或設定核准的指示。 |
modifiedOn |
string |
取得修改日期。 |
name |
string |
取得或設定名稱。 |
release |
取得手動介入的 releaseReference。 |
|
releaseDefinition |
取得 releaseDefinitionReference 以進行手動介入。 |
|
releaseEnvironment |
取得 releaseEnvironmentReference 以進行手動介入。 |
|
status |
取得或設定手動介入的狀態。 |
|
taskInstanceId |
string |
取得工作實例識別碼。 |
url |
string |
取得 URL 以存取手動介入。 |
ManualInterventionStatus
取得或設定手動介入的狀態。
名稱 | 類型 | Description |
---|---|---|
approved |
string |
手動介入已核准。 |
canceled |
string |
手動介入已取消。 |
pending |
string |
手動介入擱置中。 |
rejected |
string |
手動介入遭到拒絕。 |
unknown |
string |
手動介入沒有狀態設定。 |
ProcessParameters
名稱 | 類型 | Description |
---|---|---|
dataSourceBindings |
表示服務端點要求的資料來源系結。 |
|
inputs | ||
sourceDefinitions |
ProjectReference
名稱 | 類型 | Description |
---|---|---|
id |
string |
取得這個欄位的唯一識別碼。 |
name |
string |
取得專案的名稱。 |
ReferenceLinks
表示 REST 參考連結集合的類別。
名稱 | 類型 | Description |
---|---|---|
links |
object |
連結的唯讀檢視。 因為參考連結是唯讀的,所以我們只想要將它們公開為唯讀。 |
ReleaseApproval
名稱 | 類型 | Description |
---|---|---|
approvalType |
取得或設定核准的類型。 |
|
approvedBy |
取得已核准的身分識別。 |
|
approver |
取得或設定應該核准的身分識別。 |
|
attempt |
integer |
取得或設定嘗試,指定其所屬的部署嘗試。 |
comments |
string |
取得或設定核准的批註。 |
createdOn |
string |
取得建立日期。 |
history |
取得記錄,指定與此核准相關聯的所有核准。 |
|
id |
integer |
取得這個欄位的唯一識別碼。 |
isAutomated |
boolean |
取得或設定為自動核准。 |
modifiedOn |
string |
取得修改日期。 |
rank |
integer |
取得或設定指定核准順序的排名。 例如,相同的排名表示平行核准。 |
release |
取得 releaseReference,指定與此核准相關聯的發行參考。 |
|
releaseDefinition |
取得 releaseDefinitionReference,指定與此核准相關聯的發行定義參考。 |
|
releaseEnvironment |
取得 releaseEnvironmentReference,指定與此核准相關聯的發行環境參考。 |
|
revision |
integer |
取得修訂編號。 |
status |
取得或設定核准的狀態。 |
|
url |
string |
取得存取核准的 URL。 |
ReleaseApprovalHistory
名稱 | 類型 | Description |
---|---|---|
approver |
核准者的身分識別。 |
|
changedBy |
變更核准的物件身分識別。 |
|
comments |
string |
核准歷程記錄批註。 |
createdOn |
string |
建立此核准的時間。 |
modifiedOn |
string |
修改此核准的時間。 |
revision |
integer |
核准歷程記錄修訂。 |
ReleaseCondition
名稱 | 類型 | Description |
---|---|---|
conditionType |
取得或設定條件類型。 |
|
name |
string |
取得或設定條件的名稱。 例如 'ReleaseStarted'。 |
result |
boolean |
發行條件結果。 |
value |
string |
取得或設定條件的值。 |
ReleaseDefinitionApprovals
名稱 | 類型 | Description |
---|---|---|
approvalOptions |
取得或設定核准選項。 |
|
approvals |
取得或設定核准。 |
ReleaseDefinitionApprovalStep
名稱 | 類型 | Description |
---|---|---|
approver |
取得並設定核准者。 |
|
id |
integer |
核准或部署步驟的識別碼。 |
isAutomated |
boolean |
指出核准是否自動化。 |
isNotificationOn |
boolean |
指出核准通知集。 |
rank |
integer |
取得或設定核准步驟的排名。 |
ReleaseDefinitionGate
名稱 | 類型 | Description |
---|---|---|
tasks |
取得或設定閘道工作流程。 |
ReleaseDefinitionGatesOptions
名稱 | 類型 | Description |
---|---|---|
isEnabled |
boolean |
取得或設定為啟用或未啟用閘道。 |
minimumSuccessDuration |
integer |
取得或設定成功閘道評估之後穩定結果的最小持續時間。 |
samplingInterval |
integer |
取得或設定重新評估閘道之間的時間。 |
stabilizationTime |
integer |
取得或設定評估之前的延遲。 |
timeout |
integer |
取得或設定閘道失敗後的逾時。 |
ReleaseDefinitionGatesStep
名稱 | 類型 | Description |
---|---|---|
gates |
取得或設定閘道。 |
|
gatesOptions |
取得或設定閘道選項。 |
|
id |
integer |
ReleaseDefinitionGateStep 的識別碼。 |
ReleaseDefinitionShallowReference
名稱 | 類型 | Description |
---|---|---|
_links |
取得發行定義相關資源、API 和檢視的連結。 |
|
id |
integer |
取得發行定義的唯一識別碼。 |
name |
string |
取得或設定發行定義的名稱。 |
path |
string |
取得或設定發行定義的路徑。 |
projectReference |
取得或設定專案參考。 |
|
url |
string |
取得 REST API URL 以存取發行定義。 |
ReleaseDeployPhase
名稱 | 類型 | Description |
---|---|---|
deploymentJobs |
階段的部署作業。 |
|
errorLog |
string |
階段執行錯誤記錄。 |
manualInterventions |
手動介入工作在階段執行資訊的清單。 |
|
name |
string |
階段的名稱。 |
phaseId |
string |
階段的識別碼。 |
phaseType |
階段的類型。 |
|
rank |
integer |
階段的排名。 |
runPlanId |
string |
執行階段的計畫識別碼。 |
startedOn |
string |
階段開始時間。 |
status |
階段的狀態。 |
ReleaseEnvironment
名稱 | 類型 | Description |
---|---|---|
conditions |
取得條件清單。 |
|
createdOn |
string |
取得建立日期。 |
definitionEnvironmentId |
integer |
取得定義環境識別碼。 |
deployPhasesSnapshot |
取得部署階段快照集的清單。 |
|
deploySteps |
取得部署步驟。 |
|
environmentOptions |
取得環境選項。 |
|
id |
integer |
取得這個欄位的唯一識別碼。 |
modifiedOn |
string |
取得修改日期。 |
name |
string |
取得名稱。 |
nextScheduledUtcTime |
string |
取得下一個排程的 UTC 時間。 |
owner |
取得身分識別,其為發行環境的擁有者。 |
|
postApprovalsSnapshot |
取得部署後核准快照集的清單。 |
|
postDeployApprovals |
取得部署後核准的清單。 |
|
postDeploymentGatesSnapshot |
部署閘道後快照集資料。 |
|
preApprovalsSnapshot |
取得預先部署核准快照集的清單。 |
|
preDeployApprovals |
取得預先部署核准的清單。 |
|
preDeploymentGatesSnapshot |
預先部署閘道快照集資料。 |
|
processParameters |
取得進程參數。 |
|
rank |
integer |
取得排名。 |
release |
取得發行參考,指定此發行環境關聯之版本的參考。 |
|
releaseCreatedBy |
取得建立發行的身分識別。 |
|
releaseDefinition |
取得 releaseDefinitionReference,指定與此發行環境相關聯之發行定義的參考。 |
|
releaseId |
integer |
取得版本識別碼。 |
scheduledDeploymentTime |
string |
取得發行環境的排程部署時間。 |
schedules |
取得排程的清單。 |
|
status |
取得環境狀態。 |
|
timeToDeploy |
number |
取得部署時間。 |
triggerReason |
string |
取得觸發程式原因。 |
variableGroups |
取得變數群組的清單。 |
|
variables |
<string,
Configuration |
取得變數的字典。 |
ReleaseEnvironmentShallowReference
名稱 | 類型 | Description |
---|---|---|
_links |
取得發行環境相關資源、API 和檢視的連結。 |
|
id |
integer |
取得發行環境的唯一識別碼。 |
name |
string |
取得或設定發行環境的名稱。 |
url |
string |
取得 REST API URL 以存取發行環境。 |
ReleaseEnvironmentUpdateMetadata
名稱 | 類型 | Description |
---|---|---|
comment |
string |
取得或設定批註。 |
scheduledDeploymentTime |
string |
取得或設定排程的部署時間。 |
status |
取得或設定環境的狀態。 |
|
variables |
<string,
Configuration |
設定部署時要覆寫的環境變數清單。 |
ReleaseGates
名稱 | 類型 | Description |
---|---|---|
deploymentJobs |
包含每個評估的閘道作業詳細資料。 |
|
id |
integer |
發行閘道的識別碼。 |
ignoredGates |
忽略的閘道清單。 |
|
lastModifiedOn |
string |
閘道上次修改的時間。 |
runPlanId |
string |
執行閘道的計畫識別碼。 |
stabilizationCompletedOn |
string |
閘道防震已完成日期和時間。 |
startedOn |
string |
閘道評估開始時間。 |
status |
發行閘道的狀態。 |
|
succeedingSince |
string |
成功執行所有閘道的日期和時間。 |
ReleaseSchedule
名稱 | 類型 | Description |
---|---|---|
daysToRelease |
要發行的星期幾。 |
|
jobId |
string |
Team Foundation 作業定義作業識別碼。 |
scheduleOnlyWithChanges |
boolean |
旗標,以判斷此排程是否應該只有在相關聯的成品已變更或發行定義變更時才會釋放。 |
startHours |
integer |
要啟動的當地時區小時。 |
startMinutes |
integer |
要啟動的當地時區分鐘。 |
timeZoneId |
string |
發行排程的時區識別碼,例如 'UTC'。 |
ReleaseShallowReference
名稱 | 類型 | Description |
---|---|---|
_links |
取得發行相關資源、API 和檢視的連結。 |
|
id |
integer |
取得發行的唯一識別碼。 |
name |
string |
取得或設定發行的名稱。 |
url |
string |
取得要存取發行的 REST API URL。 |
ReleaseTask
名稱 | 類型 | Description |
---|---|---|
agentName |
string |
執行工作的代理程式名稱。 |
finishTime |
string |
發行工作的完成時間。 |
id |
integer |
發行工作的識別碼。 |
issues |
Issue[] |
執行工作時發生的問題清單。 |
lineCount |
integer |
記錄發行工作具有的行數。 |
logUrl |
string |
工作的記錄 URL。 |
name |
string |
工作的名稱。 |
percentComplete |
integer |
工作執行完成前置。 |
rank |
integer |
發行工作的排名。 |
resultCode |
string |
工作的結果碼。 |
startTime |
string |
發行工作的識別碼。 |
status |
發行工作的狀態。 |
|
task |
工作流程工作參考。 |
|
timelineRecordId |
string |
發行工作的時程表記錄識別碼。 |
ScheduleDays
要發行的星期幾。
名稱 | 類型 | Description |
---|---|---|
all |
string |
排程在一周中的所有天數。 |
friday |
string |
排定在星期五。 |
monday |
string |
排程在星期一。 |
none |
string |
未設定排程日期。 |
saturday |
string |
排程于星期六。 |
sunday |
string |
排定在星期日。 |
thursday |
string |
排定在星期四。 |
tuesday |
string |
排定在星期二。 |
wednesday |
string |
排定在星期三。 |
TaskInputDefinitionBase
名稱 | 類型 | Description |
---|---|---|
aliases |
string[] |
|
defaultValue |
string |
|
groupName |
string |
|
helpMarkDown |
string |
|
label |
string |
|
name |
string |
|
options |
object |
|
properties |
object |
|
required |
boolean |
|
type |
string |
|
validation | ||
visibleRule |
string |
TaskInputValidation
名稱 | 類型 | Description |
---|---|---|
expression |
string |
條件運算式 |
message |
string |
說明使用者如何在驗證失敗時更正的訊息 |
TaskSourceDefinitionBase
名稱 | 類型 | Description |
---|---|---|
authKey |
string |
|
endpoint |
string |
|
keySelector |
string |
|
selector |
string |
|
target |
string |
TaskStatus
發行工作的狀態。
名稱 | 類型 | Description |
---|---|---|
canceled |
string |
工作執行已取消。 |
failed |
string |
工作執行失敗。 |
failure |
string |
工作執行失敗。 |
inProgress |
string |
工作目前正在進行中。 |
partiallySucceeded |
string |
工作執行部分成功。 |
pending |
string |
工作處於擱置狀態。 |
skipped |
string |
已略過工作執行。 |
succeeded |
string |
工作已順利完成。 |
success |
string |
工作已順利完成。 |
unknown |
string |
工作沒有狀態設定。 |
VariableGroup
名稱 | 類型 | Description |
---|---|---|
createdBy |
取得或設定建立的身分識別。 |
|
createdOn |
string |
取得建立日期。 |
description |
string |
取得或設定描述。 |
id |
integer |
取得這個欄位的唯一識別碼。 |
isShared |
boolean |
表示變數群組是否與其他專案共用。 |
modifiedBy |
取得或設定已修改的身分識別。 |
|
modifiedOn |
string |
取得修改日期。 |
name |
string |
取得或設定名稱。 |
providerData |
取得或設定提供者資料。 |
|
type |
string |
取得或設定類型。 |
variableGroupProjectReferences |
變數群組與其他專案共用的所有專案參考。 |
|
variables |
<string,
Variable |
取得及設定變數的字典。 |
VariableGroupProjectReference
變數群組參考是變數群組的淺層參考。
名稱 | 類型 | Description |
---|---|---|
description |
string |
取得或設定變數群組的描述。 |
name |
string |
取得或設定變數群組的名稱。 |
projectReference |
取得或設定變數群組的專案參考。 |
VariableGroupProviderData
VariableValue
名稱 | 類型 | Description |
---|---|---|
isReadOnly |
boolean |
取得或設定變數是否為唯讀。 |
isSecret |
boolean |
取得或設定為變數為秘密或不是。 |
value |
string |
取得或設定值。 |
WorkflowTask
名稱 | 類型 | Description |
---|---|---|
alwaysRun |
boolean |
取得或設定為工作一律執行或未執行。 |
condition |
string |
取得或設定工作條件。 |
continueOnError |
boolean |
取得或設定當工作在錯誤時繼續執行。 |
definitionType |
string |
取得或設定工作定義類型。 範例:- 'Agent'、DeploymentGroup'、'Server' 或 'ServerGate'。 |
enabled |
boolean |
取得或設定為已啟用或未啟用的工作。 |
environment |
object |
取得或設定工作環境變數。 |
inputs |
object |
取得或設定工作輸入。 |
name |
string |
取得或設定工作的名稱。 |
overrideInputs |
object |
取得或設定工作覆寫輸入。 |
refName |
string |
取得或設定工作的參考名稱。 |
retryCountOnTaskFailure |
integer |
取得或設定工作 retryCount。 |
taskId |
string |
取得或設定工作的識別碼。 |
timeoutInMinutes |
integer |
取得或設定工作逾時。 |
version |
string |
取得或設定工作的版本。 |
WorkflowTaskReference
名稱 | 類型 | Description |
---|---|---|
id |
string |
工作識別碼。 |
name |
string |
工作的名稱。 |
version |
string |
工作的版本。 |