Releases - Create
建立發行。
POST https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases?api-version=5.0
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
organization
|
path | True |
string |
Azure DevOps 組織的名稱。 |
project
|
path | True |
string |
專案識別碼或專案名稱 |
api-version
|
query | True |
string |
要使用的 API 版本。 這應該設定為 '5.0' 以使用此版本的 API。 |
要求本文
名稱 | 類型 | Description |
---|---|---|
artifacts |
設定要建立發行的成品清單。 |
|
definitionId |
integer |
設定定義識別碼以建立發行。 |
description |
string |
設定建立發行的描述。 |
environmentsMetadata |
設定環境中繼資料的清單。 |
|
isDraft |
boolean |
設定 'true' 以在草稿模式中建立發行,否則為 'false'。 |
manualEnvironments |
string[] |
將環境清單設定為手動做為條件。 |
properties |
類別會將屬性包表示為索引鍵/值組的集合。 所有基本型別的值都會 (接受任何具有 |
|
reason |
設定建立發行的原因。 |
|
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 | 授與讀取和更新發行成品的能力,包括發行、版本定義和發行記憶體,以及將新版本排入佇列的能力。 |
範例
Sample Request
POST https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/releases?api-version=5.0
{
"definitionId": 1,
"description": "Creating Sample release",
"artifacts": [
{
"alias": "Fabrikam.CI",
"instanceReference": {
"id": "2",
"name": null
}
}
],
"isDraft": false,
"reason": "none",
"manualEnvironments": null
}
Sample Response
{
"id": 19,
"name": "Release-19",
"status": "active",
"createdOn": "2017-06-16T01:53:32.777Z",
"modifiedOn": "2017-06-16T01:53:32.777Z",
"modifiedBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
},
"createdBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
},
"environments": [
{
"id": 73,
"releaseId": 19,
"name": "Dev",
"status": "notStarted",
"variables": {},
"preDeployApprovals": [],
"postDeployApprovals": [],
"preApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": false,
"isNotificationOn": false,
"approver": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
},
"id": 0
}
],
"approvalOptions": {
"requiredApproverCount": 0,
"releaseCreatorCanBeApprover": true,
"autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
"enforceIdentityRevalidation": false,
"timeoutInMintues": 43200
}
},
"postApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"deploySteps": [],
"rank": 1,
"definitionEnvironmentId": 1,
"environmentOptions": {
"emailNotificationType": "OnlyOnFailure",
"emailRecipients": "release.environment.owner;release.creator",
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"enableAccessToken": false,
"publishDeploymentStatus": false
},
"demands": [],
"conditions": [],
"workflowTasks": [],
"deployPhasesSnapshot": [
{
"deploymentInput": {
"parallelExecution": {
"parallelExecutionType": "none"
},
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"queueId": 2,
"demands": [],
"enableAccessToken": false
},
"rank": 1,
"phaseType": "agentBasedDeployment",
"name": "Run on agent",
"workflowTasks": [
{
"taskId": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
"version": "1.*",
"name": "PowerShell Script",
"enabled": true,
"alwaysRun": false,
"continueOnError": false,
"timeoutInMinutes": 0,
"definitionType": "task",
"inputs": {
"scriptType": "inlineScript",
"scriptName": "",
"arguments": "",
"inlineScript": "# You can write your powershell scripts inline here. \n# You can also pass predefined and custom variables to this scripts using arguments\n\n Write-Host \"Hello World\"",
"workingFolder": "",
"failOnStandardError": "true"
}
}
]
}
],
"owner": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
},
"schedules": [],
"release": {
"id": 19,
"name": "Release-19",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=19&_a=release-summary"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19"
}
}
},
"releaseDefinition": {
"id": 1,
"name": "MyShuttle.CD",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
}
}
},
"releaseCreatedBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart"
},
"triggerReason": "Manual"
},
{
"id": 74,
"releaseId": 19,
"name": "QA",
"status": "notStarted",
"variables": {},
"preDeployApprovals": [],
"postDeployApprovals": [],
"preApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"postApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"deploySteps": [],
"rank": 2,
"definitionEnvironmentId": 2,
"environmentOptions": {
"emailNotificationType": "OnlyOnFailure",
"emailRecipients": "release.environment.owner;release.creator",
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"enableAccessToken": false,
"publishDeploymentStatus": false
},
"demands": [],
"conditions": [
{
"result": false,
"name": "Dev",
"conditionType": "environmentState",
"value": "4"
}
],
"workflowTasks": [],
"deployPhasesSnapshot": [
{
"deploymentInput": {
"parallelExecution": {
"parallelExecutionType": "none"
},
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"queueId": 2,
"demands": [],
"enableAccessToken": false
},
"rank": 1,
"phaseType": "agentBasedDeployment",
"name": "Run on agent",
"workflowTasks": [
{
"taskId": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
"version": "1.*",
"name": "PowerShell Script",
"enabled": true,
"alwaysRun": false,
"continueOnError": false,
"timeoutInMinutes": 0,
"definitionType": "task",
"inputs": {
"scriptType": "inlineScript",
"scriptName": "",
"arguments": "",
"inlineScript": "# You can write your powershell scripts inline here. \n# You can also pass predefined and custom variables to this scripts using arguments\n\n Write-Host \"Hello World\"",
"workingFolder": "",
"failOnStandardError": "true"
}
}
]
}
],
"owner": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
},
"schedules": [],
"release": {
"id": 19,
"name": "Release-19",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=19&_a=release-summary"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19"
}
}
},
"releaseDefinition": {
"id": 1,
"name": "MyShuttle.CD",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
}
}
},
"releaseCreatedBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart"
},
"triggerReason": "After successful deployment of Dev"
},
{
"id": 75,
"releaseId": 19,
"name": "PPE",
"status": "notStarted",
"variables": {},
"preDeployApprovals": [],
"postDeployApprovals": [],
"preApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"postApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"deploySteps": [],
"rank": 3,
"definitionEnvironmentId": 3,
"environmentOptions": {
"emailNotificationType": "OnlyOnFailure",
"emailRecipients": "release.environment.owner;release.creator",
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"enableAccessToken": false,
"publishDeploymentStatus": false
},
"demands": [],
"conditions": [
{
"result": false,
"name": "QA",
"conditionType": "environmentState",
"value": "4"
}
],
"workflowTasks": [],
"deployPhasesSnapshot": [
{
"deploymentInput": {
"parallelExecution": {
"parallelExecutionType": "none"
},
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"queueId": 2,
"demands": [],
"enableAccessToken": false
},
"rank": 1,
"phaseType": "agentBasedDeployment",
"name": "Run on agent",
"workflowTasks": [
{
"taskId": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
"version": "1.*",
"name": "PowerShell Script",
"enabled": true,
"alwaysRun": false,
"continueOnError": false,
"timeoutInMinutes": 0,
"definitionType": "task",
"inputs": {
"scriptType": "inlineScript",
"scriptName": "",
"arguments": "",
"inlineScript": "# You can write your powershell scripts inline here. \n# You can also pass predefined and custom variables to this scripts using arguments\n\n Write-Host \"Hello World\"",
"workingFolder": "",
"failOnStandardError": "true"
}
}
]
}
],
"owner": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
},
"schedules": [],
"release": {
"id": 19,
"name": "Release-19",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=19&_a=release-summary"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19"
}
}
},
"releaseDefinition": {
"id": 1,
"name": "MyShuttle.CD",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
}
}
},
"releaseCreatedBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart"
},
"triggerReason": "After successful deployment of QA"
},
{
"id": 76,
"releaseId": 19,
"name": "PROD",
"status": "notStarted",
"variables": {},
"preDeployApprovals": [],
"postDeployApprovals": [],
"preApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"postApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"deploySteps": [],
"rank": 4,
"definitionEnvironmentId": 4,
"environmentOptions": {
"emailNotificationType": "OnlyOnFailure",
"emailRecipients": "release.environment.owner;release.creator",
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"enableAccessToken": false,
"publishDeploymentStatus": false
},
"demands": [],
"conditions": [
{
"result": false,
"name": "PPE",
"conditionType": "environmentState",
"value": "4"
}
],
"workflowTasks": [],
"deployPhasesSnapshot": [
{
"deploymentInput": {
"parallelExecution": {
"parallelExecutionType": "none"
},
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"queueId": 2,
"demands": [],
"enableAccessToken": false
},
"rank": 1,
"phaseType": "agentBasedDeployment",
"name": "Run on agent",
"workflowTasks": [
{
"taskId": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
"version": "1.*",
"name": "PowerShell Script",
"enabled": true,
"alwaysRun": false,
"continueOnError": false,
"timeoutInMinutes": 0,
"definitionType": "task",
"inputs": {
"scriptType": "inlineScript",
"scriptName": "",
"arguments": "",
"inlineScript": "# You can write your powershell scripts inline here. \n# You can also pass predefined and custom variables to this scripts using arguments\n\n Write-Host \"Hello World\"",
"workingFolder": "",
"failOnStandardError": "true"
}
}
]
}
],
"owner": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
},
"schedules": [],
"release": {
"id": 19,
"name": "Release-19",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=19&_a=release-summary"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19"
}
}
},
"releaseDefinition": {
"id": 1,
"name": "MyShuttle.CD",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
}
}
},
"releaseCreatedBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart"
},
"triggerReason": "After successful deployment of PPE"
}
],
"variables": {},
"variableGroups": [],
"artifacts": [
{
"sourceId": "d07908bc-118f-47d2-8a13-ff75601a6b1a:1",
"type": "Build",
"alias": "Fabrikam.CI",
"definitionReference": {
"artifactSourceDefinitionUrl": {
"id": "https://dev.azure.com/fabrikam/_permalink/_build/index?collectionId=13d3daac-03b8-4a23-9cc4-2c3de65dab63&projectId=d07908bc-118f-47d2-8a13-ff75601a6b1a&definitionId=1",
"name": ""
},
"defaultVersionBranch": {
"id": "",
"name": ""
},
"defaultVersionSpecific": {
"id": "",
"name": ""
},
"defaultVersionTags": {
"id": "",
"name": ""
},
"defaultVersionType": {
"id": "latestType",
"name": "Latest"
},
"definition": {
"id": "1",
"name": "Fabrikam.CI"
},
"project": {
"id": "d07908bc-118f-47d2-8a13-ff75601a6b1a",
"name": "MyFirstProject"
},
"version": {
"id": "2",
"name": ""
},
"artifactSourceVersionUrl": {
"id": "https://dev.azure.com/fabrikam/_permalink/_build/index?collectionId=13d3daac-03b8-4a23-9cc4-2c3de65dab63&projectId=d07908bc-118f-47d2-8a13-ff75601a6b1a&buildId=2",
"name": ""
}
},
"isPrimary": true
}
],
"releaseDefinition": {
"id": 1,
"name": "MyShuttle.CD",
"url": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
"_links": {
"self": {
"href": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
},
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
}
}
},
"description": "Creating Sample release",
"reason": "manual",
"releaseNameFormat": "Release-$(rev:r)",
"keepForever": false,
"definitionSnapshotRevision": 1,
"logsContainerUrl": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19/logs",
"url": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19",
"_links": {
"self": {
"href": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19"
},
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=19&_a=release-summary"
}
},
"tags": [],
"projectReference": {
"id": "d07908bc-118f-47d2-8a13-ff75601a6b1a",
"name": null
},
"properties": {}
}
定義
ApprovalExecutionOrder
名稱 | 類型 | Description |
---|---|---|
afterGatesAlways |
string |
|
afterSuccessfulGates |
string |
|
beforeGates |
string |
ApprovalOptions
名稱 | 類型 | Description |
---|---|---|
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped |
boolean |
|
enforceIdentityRevalidation |
boolean |
|
executionOrder | ||
releaseCreatorCanBeApprover |
boolean |
|
requiredApproverCount |
integer |
|
timeoutInMinutes |
integer |
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 |
Artifact
名稱 | 類型 | Description |
---|---|---|
alias |
string |
取得或設定別名。 |
definitionReference |
<string,
Artifact |
取得或設定定義參考。 例如{「project」:{「id」:「fed755ea-49c5-4399-acea-fd5b5aa90a6c」,「name」:「myProject」},「definition」:{「id」:「1」,「name」:「mybuildDefinition」},「connection」:{「id」:「1」,「name」:「myConnection」}} |
isPrimary |
boolean |
取得或設定為成品是主要或不是。 |
isRetained |
boolean |
|
type |
string |
取得或設定類型。 其值可以是 'Build'、'Jenkins'、'GitHub'、'Nuget'、'Team Build (外部) '、'ExternalTFSBuild'、'Git'、'TFVC'、'ExternalTfsXamlBuild'。 |
ArtifactMetadata
名稱 | 類型 | Description |
---|---|---|
alias |
string |
設定成品的別名。 |
instanceReference |
設定成品的實例參考。 例如,針對組建成品,它是組建編號。 |
ArtifactSourceReference
名稱 | 類型 | Description |
---|---|---|
id |
string |
|
name |
string |
AuthorizationHeader
名稱 | 類型 | Description |
---|---|---|
name |
string |
|
value |
string |
BuildVersion
名稱 | 類型 | Description |
---|---|---|
commitMessage |
string |
|
definitionId |
string |
|
definitionName |
string |
|
id |
string |
|
isMultiDefinitionType |
boolean |
|
name |
string |
|
sourceBranch |
string |
|
sourcePullRequestVersion | ||
sourceRepositoryId |
string |
|
sourceRepositoryType |
string |
|
sourceVersion |
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 |
取得或設定資料來源的參數。 |
resultSelector |
string |
取得或設定結果選取器。 |
resultTemplate |
string |
取得或設定結果範本。 |
target |
string |
取得或設定資料來源的目標。 |
Demand
名稱 | 類型 | Description |
---|---|---|
name |
string |
|
value |
string |
DeploymentAttempt
名稱 | 類型 | Description |
---|---|---|
attempt |
integer |
|
deploymentId |
integer |
|
hasStarted |
boolean |
指定部署是否已啟動 |
id |
integer |
|
issues |
Issue[] |
與部署相關的所有問題 |
job | ||
lastModifiedBy | ||
lastModifiedOn |
string |
|
operationStatus | ||
postDeploymentGates | ||
preDeploymentGates | ||
queuedOn |
string |
|
reason | ||
releaseDeployPhases | ||
requestedBy | ||
requestedFor | ||
runPlanId |
string |
|
status | ||
tasks |
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 |
部署狀態為 partiallysucceeded。 |
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 |
|
emailNotificationType |
string |
|
emailRecipients |
string |
|
enableAccessToken |
boolean |
|
publishDeploymentStatus |
boolean |
|
pullRequestDeploymentEnabled |
boolean |
|
skipArtifactsDownload |
boolean |
|
timeoutInMinutes |
integer |
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 |
|
displayName |
string |
這是圖形主體的非唯一顯示名稱。 若要變更此欄位,您必須變更來源提供者中的值。 |
id |
string |
|
imageUrl |
string |
|
inactive |
boolean |
|
isAadIdentity |
boolean |
|
isContainer |
boolean |
|
isDeletedInOrigin |
boolean |
|
profileUrl |
string |
|
uniqueName |
string |
|
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 |
取得專案的名稱。 |
PropertiesCollection
類別會將屬性包表示為索引鍵/值組的集合。 所有基本型別的值都會 (接受任何具有 TypeCode != TypeCode.Object
) DBNull
的型別。 Byte[]、Int32、Double、DateType 和 String 類型的值會保留其類型,其他基本類型會重新調整為 String。 Byte[] 預期為 base64 編碼字串。
名稱 | 類型 | Description |
---|---|---|
count |
integer |
集合中屬性的計數。 |
item |
object |
|
keys |
string[] |
集合中的索引鍵集合。 |
values |
string[] |
集合中的值集。 |
ReferenceLinks
表示 REST 參考連結集合的類別。
名稱 | 類型 | Description |
---|---|---|
links |
object |
連結的唯讀檢視。 因為參考連結是唯讀的,所以我們只想要將它們公開為唯讀。 |
Release
名稱 | 類型 | Description |
---|---|---|
_links |
取得存取發行的連結。 |
|
artifacts |
Artifact[] |
取得或設定成品清單。 |
comment |
string |
取得或設定批註。 |
createdBy |
取得或設定建立的身分識別。 |
|
createdOn |
string |
取得建立日期。 |
definitionSnapshotRevision |
integer |
取得定義快照集的修訂編號。 |
description |
string |
取得或設定發行的描述。 |
environments |
取得環境清單。 |
|
id |
integer |
取得這個欄位的唯一識別碼。 |
keepForever |
boolean |
是否要從保留原則中排除發行。 |
logsContainerUrl |
string |
取得記錄容器 URL。 |
modifiedBy |
取得或設定已修改的身分識別。 |
|
modifiedOn |
string |
取得修改日期。 |
name |
string |
取得名稱。 |
poolName |
string |
取得集區名稱。 |
projectReference |
取得或設定專案參考。 |
|
properties |
類別會將屬性包表示為索引鍵/值組的集合。 所有基本型別的值都會 (接受任何具有 |
|
reason |
取得發行的原因。 |
|
releaseDefinition |
取得 releaseDefinitionReference,指定與此版本相關聯的發行定義參考。 |
|
releaseNameFormat |
string |
取得發行名稱格式。 |
status |
取得狀態。 |
|
tags |
string[] |
取得或設定標記的清單。 |
triggeringArtifactAlias |
string |
|
variableGroups |
取得變數群組的清單。 |
|
variables |
<string,
Configuration |
取得或設定變數的字典。 |
ReleaseApproval
名稱 | 類型 | Description |
---|---|---|
approvalType |
取得或設定核准的類型。 |
|
approvedBy |
取得已核准的身分識別。 |
|
approver |
取得或設定應該核准的身分識別。 |
|
attempt |
integer |
取得或設定嘗試,指定其所屬的部署嘗試。 |
comments |
string |
取得或設定核准的批註。 |
createdOn |
string |
取得建立日期。 |
history |
取得記錄,指定與此核准相關聯的所有核准。 |
|
id |
integer |
取得這個欄位的唯一識別碼。 |
isAutomated |
boolean |
取得或設定為自動核准。 |
isNotificationOn |
boolean |
|
modifiedOn |
string |
取得修改日期。 |
rank |
integer |
取得或設定指定核准順序的排名。 例如,相同的排名表示平行核准。 |
release |
取得 releaseReference,指定與此核准相關聯的發行參考。 |
|
releaseDefinition |
取得 releaseDefinitionReference,指定與此核准相關聯的發行定義參考。 |
|
releaseEnvironment |
取得 releaseEnvironmentReference,指定與此核准相關聯的發行環境參考。 |
|
revision |
integer |
取得修訂編號。 |
status |
取得或設定核准的狀態。 |
|
trialNumber |
integer |
|
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 |
ReleaseDefinitionShallowReference
名稱 | 類型 | Description |
---|---|---|
_links |
取得發行定義之相關資源、API 和檢視的連結。 |
|
id |
integer |
取得發行定義的唯一識別碼。 |
name |
string |
取得或設定發行定義的名稱。 |
path |
string |
取得或設定發行定義的路徑。 |
projectReference |
取得或設定專案參考。 |
|
url |
string |
取得 REST API URL 以存取發行定義。 |
ReleaseDeployPhase
名稱 | 類型 | Description |
---|---|---|
deploymentJobs | ||
errorLog |
string |
|
id |
integer |
|
manualInterventions | ||
name |
string |
|
phaseId |
string |
|
phaseType | ||
rank |
integer |
|
runPlanId |
string |
|
startedOn |
string |
階段開始時間 |
status |
ReleaseEnvironment
名稱 | 類型 | Description |
---|---|---|
conditions |
取得條件清單。 |
|
createdOn |
string |
取得建立日期。 |
definitionEnvironmentId |
integer |
取得定義環境識別碼。 |
demands |
Demand[] |
取得需求。 |
deployPhasesSnapshot |
取得部署階段快照集的清單。 |
|
deploySteps |
取得部署步驟。 |
|
environmentOptions |
取得環境選項。 |
|
id |
integer |
取得這個欄位的唯一識別碼。 |
modifiedOn |
string |
取得修改日期。 |
name |
string |
取得名稱。 |
nextScheduledUtcTime |
string |
取得下一個排程的 UTC 時間。 |
owner |
取得發行環境的擁有者身分識別。 |
|
postApprovalsSnapshot |
取得部署後核准快照集的清單。 |
|
postDeployApprovals |
取得部署後核准的清單。 |
|
postDeploymentGatesSnapshot | ||
preApprovalsSnapshot |
取得預先部署核准快照集的清單。 |
|
preDeployApprovals |
取得預先部署核准的清單。 |
|
preDeploymentGatesSnapshot | ||
processParameters |
取得進程參數。 |
|
queueId |
integer |
取得佇列識別碼。 |
rank |
integer |
取得排名。 |
release |
取得發行參考,指定與此發行環境相關聯之發行的參考。 |
|
releaseCreatedBy |
取得建立發行的身分識別。 |
|
releaseDefinition |
取得 releaseDefinitionReference,指定與此發行環境相關聯之發行定義的參考。 |
|
releaseDescription |
string |
取得發行描述。 |
releaseId |
integer |
取得版本識別碼。 |
scheduledDeploymentTime |
string |
取得發行環境的排程部署時間。 |
schedules |
取得排程清單。 |
|
status |
取得環境狀態。 |
|
timeToDeploy |
number |
取得部署時間。 |
triggerReason |
string |
取得觸發因素。 |
variableGroups |
取得變數群組的清單。 |
|
variables |
<string,
Configuration |
取得變數的字典。 |
workflowTasks |
取得工作流程工作的清單。 |
ReleaseEnvironmentShallowReference
名稱 | 類型 | Description |
---|---|---|
_links |
取得發行環境相關資源、API 和檢視的連結。 |
|
id |
integer |
取得發行環境的唯一識別碼。 |
name |
string |
取得或設定發行環境的名稱。 |
url |
string |
取得 REST API URL 以存取發行環境。 |
ReleaseGates
名稱 | 類型 | Description |
---|---|---|
deploymentJobs | ||
id |
integer |
|
ignoredGates | ||
lastModifiedOn |
string |
|
runPlanId |
string |
|
stabilizationCompletedOn |
string |
|
startedOn |
string |
|
status | ||
succeedingSince |
string |
ReleaseReason
取得發行的原因。
名稱 | 類型 | Description |
---|---|---|
continuousIntegration |
string |
|
manual |
string |
|
none |
string |
|
pullRequest |
string |
|
schedule |
string |
ReleaseSchedule
名稱 | 類型 | Description |
---|---|---|
daysToRelease |
發行的星期幾 |
|
jobId |
string |
Team Foundation 作業定義作業識別碼 |
startHours |
integer |
要開始的當地時區小時 |
startMinutes |
integer |
要開始的當地時區分鐘數 |
timeZoneId |
string |
發行排程的時區識別碼,例如 'UTC' |
ReleaseShallowReference
名稱 | 類型 | Description |
---|---|---|
_links |
取得版本相關資源、API 和檢視的連結。 |
|
id |
integer |
取得發行的唯一識別碼。 |
name |
string |
取得或設定發行的名稱。 |
url |
string |
取得要存取版本的 REST API URL。 |
ReleaseStartEnvironmentMetadata
名稱 | 類型 | Description |
---|---|---|
definitionEnvironmentId |
integer |
設定發行定義環境識別碼。 |
variables |
<string,
Configuration |
設定部署時要覆寫的環境變數清單。 |
ReleaseStartMetadata
名稱 | 類型 | Description |
---|---|---|
artifacts |
設定要建立發行的成品清單。 |
|
definitionId |
integer |
設定定義識別碼以建立發行。 |
description |
string |
設定建立發行的描述。 |
environmentsMetadata |
設定環境中繼資料的清單。 |
|
isDraft |
boolean |
設定 'true' 以在草稿模式中建立發行,否則為 'false'。 |
manualEnvironments |
string[] |
將環境清單設定為手動做為條件。 |
properties |
類別會將屬性包表示為索引鍵/值組的集合。 所有基本型別的值都會 (接受任何具有 |
|
reason |
設定建立發行的原因。 |
|
variables |
<string,
Configuration |
設定部署時要覆寫的發行變數清單。 |
ReleaseStatus
取得狀態。
名稱 | 類型 | Description |
---|---|---|
abandoned |
string |
|
active |
string |
|
draft |
string |
|
undefined |
string |
ReleaseTask
名稱 | 類型 | Description |
---|---|---|
agentName |
string |
|
finishTime |
string |
|
id |
integer |
|
issues |
Issue[] |
|
lineCount |
integer |
|
logUrl |
string |
|
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 |
SourcePullRequestVersion
名稱 | 類型 | Description |
---|---|---|
pullRequestId |
string |
發行將發佈狀態的提取要求識別碼 |
pullRequestMergedAt |
string |
|
sourceBranchCommitId |
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 |
取得或設定類型。 |
variables |
<string,
Variable |
VariableGroupProviderData
VariableValue
名稱 | 類型 | Description |
---|---|---|
isSecret |
boolean |
|
value |
string |
WorkflowTask
名稱 | 類型 | Description |
---|---|---|
alwaysRun |
boolean |
|
condition |
string |
|
continueOnError |
boolean |
|
definitionType |
string |
|
enabled |
boolean |
|
environment |
object |
|
inputs |
object |
|
name |
string |
|
overrideInputs |
object |
|
refName |
string |
|
taskId |
string |
|
timeoutInMinutes |
integer |
|
version |
string |
WorkflowTaskReference
名稱 | 類型 | Description |
---|---|---|
id |
string |
|
name |
string |
|
version |
string |
意見反應
https://aka.ms/ContentUserFeedback。
即將登場:在 2024 年,我們將逐步淘汰 GitHub 問題作為內容的意見反應機制,並將它取代為新的意見反應系統。 如需詳細資訊,請參閱:提交並檢視相關的意見反應