Definitions - Update

參考

Service:: Release

API Version:: 7.1-preview.4

更新發行定義。

PUT https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions?api-version=7.1-preview.4

URI 參數

名稱	位於	必要	類型	Description
organization	path	True	string	Azure DevOps 組織的名稱。
project	path	True	string	專案識別碼或專案名稱
api-version	query	True	string	要使用的 API 版本。這應該設定為 '7.1-preview.4'，以使用此版本的 API。

要求本文

名稱	類型	Description
_links	ReferenceLinks	取得發行定義之相關資源、API 和檢視的連結。
artifacts	Artifact[]	取得或設定成品清單。
comment	string	取得或設定批註。
createdBy	IdentityRef	取得或設定建立的身分識別。
createdOn	string	取得建立日期。
description	string	取得或設定描述。
environments	ReleaseDefinitionEnvironment[]	取得或設定環境清單。
id	integer	取得發行定義的唯一識別碼。
isDeleted	boolean	是否刪除發行定義。
lastRelease	ReleaseReference	取得最後一個版本的參考。
modifiedBy	IdentityRef	取得或設定已修改的身分識別。
modifiedOn	string	取得修改日期。
name	string	取得或設定發行定義的名稱。
path	string	取得或設定發行定義的路徑。
projectReference	ProjectReference	取得或設定專案參考。
properties	PropertiesCollection	取得或設定屬性。
releaseNameFormat	string	取得或設定發行名稱格式。
revision	integer	取得修訂編號。
source	ReleaseDefinitionSource	取得或設定發行定義的來源。
tags	string[]	取得或設定標籤的清單。
triggers	ReleaseTriggerBase[]	取得或設定觸發程式清單。
url	string	取得 REST API URL 以存取發行定義。
variableGroups	integer[]	取得或設定變數群組的清單。
variables	<string, ConfigurationVariableValue>	取得或設定變數的字典。

回應

名稱	類型	Description
200 OK	ReleaseDefinition	成功的作業

安全性

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	授與讀取和更新發行成品的能力，包括資料夾、發行、發行定義和發行環境，以及將新版本排入佇列的能力。

範例

Update the release definition

Sample Request

HTTP

PUT https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions?api-version=7.1-preview.4

{
  "source": "restApi",
  "revision": 1,
  "description": null,
  "createdBy": {
    "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"
  },
  "createdOn": "2018-12-11T05:33:56.573Z",
  "modifiedBy": {
    "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"
  },
  "modifiedOn": "2018-12-11T05:33:56.573Z",
  "isDeleted": false,
  "variables": {
    "NonSecretVariable": {
      "value": "NonSecretValue"
    }
  },
  "variableGroups": [],
  "environments": [
    {
      "id": 43,
      "name": "PROD",
      "rank": 1,
      "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"
      },
      "variables": {},
      "variableGroups": [],
      "preDeployApprovals": {
        "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": 127
          }
        ],
        "approvalOptions": {
          "requiredApproverCount": 0,
          "releaseCreatorCanBeApprover": true,
          "autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
          "enforceIdentityRevalidation": false,
          "timeoutInMinutes": 0,
          "executionOrder": "beforeGates"
        }
      },
      "deployStep": {
        "tasks": [],
        "id": 128
      },
      "postDeployApprovals": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 129
          }
        ]
      },
      "deployPhases": [
        {
          "deploymentInput": {
            "parallelExecution": {
              "parallelExecutionType": "none"
            },
            "skipArtifactsDownload": false,
            "artifactsDownloadInput": {
              "downloadInputs": []
            },
            "queueId": 15,
            "demands": [],
            "enableAccessToken": false,
            "timeoutInMinutes": 0,
            "jobCancelTimeoutInMinutes": 1,
            "condition": "succeeded()",
            "overrideInputs": {}
          },
          "rank": 1,
          "phaseType": "agentBasedDeployment",
          "name": "Run on agent",
          "workflowTasks": []
        }
      ],
      "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": [],
      "executionPolicy": {
        "concurrencyCount": 0,
        "queueDepthCount": 0
      },
      "schedules": [],
      "currentRelease": {
        "id": 0,
        "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/0",
        "_links": {}
      },
      "retentionPolicy": {
        "daysToKeep": 30,
        "releasesToKeep": 3,
        "retainBuild": true
      },
      "properties": {},
      "preDeploymentGates": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      },
      "postDeploymentGates": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      },
      "environmentTriggers": [],
      "badgeUrl": "https://vsrm.dev.azure.com/fabrikam/_apis/public/Release/badge/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/43/43"
    }
  ],
  "artifacts": [],
  "triggers": [],
  "releaseNameFormat": "",
  "tags": [],
  "properties": {},
  "id": 43,
  "name": "Fabrikam-web",
  "path": "\\",
  "projectReference": null,
  "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/43",
  "_links": {
    "self": {
      "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/43"
    },
    "web": {
      "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=43"
    }
  }
}

Sample Response

Status code:: 200

{
  "source": "restApi",
  "revision": 2,
  "description": null,
  "createdBy": {
    "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"
  },
  "createdOn": "2018-12-11T05:33:56.573Z",
  "modifiedBy": {
    "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"
  },
  "modifiedOn": "2018-12-11T05:33:58.433Z",
  "isDeleted": false,
  "variables": {
    "NonSecretVariable": {
      "value": "NonSecretValue"
    }
  },
  "variableGroups": [],
  "environments": [
    {
      "id": 43,
      "name": "PROD",
      "rank": 1,
      "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"
      },
      "variables": {},
      "variableGroups": [],
      "preDeployApprovals": {
        "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": 127
          }
        ],
        "approvalOptions": {
          "requiredApproverCount": 0,
          "releaseCreatorCanBeApprover": true,
          "autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
          "enforceIdentityRevalidation": false,
          "timeoutInMinutes": 0,
          "executionOrder": "beforeGates"
        }
      },
      "deployStep": {
        "id": 128
      },
      "postDeployApprovals": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 129
          }
        ]
      },
      "deployPhases": [
        {
          "deploymentInput": {
            "parallelExecution": {
              "parallelExecutionType": "none"
            },
            "skipArtifactsDownload": false,
            "artifactsDownloadInput": {
              "downloadInputs": []
            },
            "queueId": 15,
            "demands": [],
            "enableAccessToken": false,
            "timeoutInMinutes": 0,
            "jobCancelTimeoutInMinutes": 1,
            "condition": "succeeded()",
            "overrideInputs": {}
          },
          "rank": 1,
          "phaseType": "agentBasedDeployment",
          "name": "Run on agent",
          "refName": null,
          "workflowTasks": []
        }
      ],
      "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": [],
      "executionPolicy": {
        "concurrencyCount": 0,
        "queueDepthCount": 0
      },
      "schedules": [],
      "currentRelease": {
        "id": 0,
        "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/0",
        "_links": {}
      },
      "retentionPolicy": {
        "daysToKeep": 30,
        "releasesToKeep": 3,
        "retainBuild": true
      },
      "properties": {},
      "preDeploymentGates": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      },
      "postDeploymentGates": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      },
      "environmentTriggers": [],
      "badgeUrl": "https://vsrm.dev.azure.com/fabrikam/_apis/public/Release/badge/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/43/43"
    }
  ],
  "artifacts": [],
  "triggers": [],
  "releaseNameFormat": "",
  "tags": [],
  "properties": {},
  "id": 43,
  "name": "Fabrikam-web",
  "path": "\\",
  "projectReference": null,
  "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/43",
  "_links": {
    "self": {
      "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/43"
    },
    "web": {
      "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=43"
    }
  }
}

定義

名稱	Description
ApprovalExecutionOrder	核准執行順序。
ApprovalOptions
Artifact
ArtifactSourceReference
AuthorizationHeader
Condition
ConditionType	取得或設定條件類型。
ConfigurationVariableValue
DataSourceBindingBase	表示服務端點要求的資料來源系結。
Demand
DeployPhase
DeployPhaseTypes	指出部署階段類型。
EnvironmentExecutionPolicy	定義Release Management端佇列的環境佇列原則。只有在滿足所述的原則時，我們才會傳送至環境執行器 [建立預先部署和其他步驟]。
EnvironmentOptions
EnvironmentRetentionPolicy
EnvironmentTrigger
EnvironmentTriggerType	取得或設定觸發程式類型。
IdentityRef
ProcessParameters
ProjectReference
PropertiesCollection	類別會將屬性包表示為索引鍵/值組的集合。所有基本型別的值都會 (接受任何具有 `TypeCode != TypeCode.Object`) `DBNull` 的型別。 Byte[]、Int32、Double、DateType 和 String 類型的值會保留其類型，其他基本類型會重新調整為 String。 Byte[] 預期為 base64 編碼字串。
ReferenceLinks	表示 REST 參考連結集合的類別。
ReleaseDefinition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionDeployStep
ReleaseDefinitionEnvironment
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionShallowReference
ReleaseDefinitionSource	取得或設定發行定義的來源。
ReleaseReason	取得發行的原因。
ReleaseReference
ReleaseSchedule
ReleaseShallowReference
ReleaseTriggerBase
ReleaseTriggerType	發行觸發程式的類型。
ScheduleDays	發行的星期幾。
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
WorkflowTask

ApprovalExecutionOrder

核准執行順序。

名稱	類型	Description
afterGatesAlways	string	執行閘道之後，一律會顯示核准。
afterSuccessfulGates	string	成功執行閘道之後顯示的核准。
beforeGates	string	閘道之前顯示的核准。

ApprovalOptions

名稱	類型	Description
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped	boolean	指定如果相同的核准者已核准上一個階段，是否可以略過核准。
enforceIdentityRevalidation	boolean	指定是否在完成核准之前重新驗證核准者的身分識別。
executionOrder	ApprovalExecutionOrder	核准執行順序。
releaseCreatorCanBeApprover	boolean	指定要求發行或部署的使用者是否應該允許核准者。
requiredApproverCount	integer	向前發行所需的核准數目。 '0' 表示所有必要的核准。
timeoutInMinutes	integer	核准逾時。核准預設逾時為 30 天。允許的逾時上限為 365 天。 '0' 表示預設逾時，也就是 30 天。

Artifact

名稱	類型	Description
alias	string	取得或設定別名。
definitionReference	<string, ArtifactSourceReference>	取得或設定定義參考。例如 {「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'。

ArtifactSourceReference

名稱	類型	Description
id	string	成品來源的識別碼。
name	string	成品來源的名稱。

AuthorizationHeader

名稱	類型	Description
name	string
value	string

Condition

名稱	類型	Description
conditionType	ConditionType	取得或設定條件類型。
name	string	取得或設定條件的名稱。例如 'ReleaseStarted'。
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	AuthorizationHeader[]	取得或設定授權標頭。
initialContextTemplate	string	定義查詢參數的初始值
parameters	object	取得或設定資料來源的參數。
requestContent	string	取得或設定 HTTP 要求本文
requestVerb	string	取得或設定 HTTP 要求動詞
resultSelector	string	取得或設定結果選取器。
resultTemplate	string	取得或設定結果範本。
target	string	取得或設定資料來源的目標。

Demand

名稱	類型	Description
name	string	取得並設定需求的名稱。
value	string	取得並設定需求的值。

DeployPhase

名稱	類型	Description
name	string	取得和設定部署階段的名稱。
phaseType	DeployPhaseTypes	指出部署階段類型。
rank	integer	取得並設定部署階段的排名。
refName	string	取得和設定部署階段的參考名稱。
workflowTasks	WorkflowTask[]	取得和設定部署階段的工作流程工作。

DeployPhaseTypes

指出部署階段類型。

名稱	類型	Description
agentBasedDeployment	string	階段類型，其中包含在代理程式上執行的工作。
deploymentGates	string	階段類型，其中包含做為閘道的工作，以供部署繼續進行。
machineGroupBasedDeployment	string	階段類型，其中包含部署群組電腦上執行的工作。
runOnServer	string	階段類型，其中包含伺服器執行的工作。
undefined	string	未定義階段類型。請勿使用。

EnvironmentExecutionPolicy

定義Release Management端佇列的環境佇列原則。只有在滿足所述的原則時，我們才會傳送至環境執行器 [建立預先部署和其他步驟]。

名稱	類型	Description
concurrencyCount	integer	此原則會決定使用環境執行器會有多少環境。
queueDepthCount	integer	EnvironmentQueue 資料表中的佇列深度，此資料表會保留環境專案，直到環境執行器免費 [依其原則而定] 以採取另一個環境來執行。

EnvironmentOptions

名稱	類型	Description
autoLinkWorkItems	boolean	取得和設定為自動連結工作專案。
badgeEnabled	boolean	取得並設定為啟用徽章。
publishDeploymentStatus	boolean	取得並設定為發行部署狀態。
pullRequestDeploymentEnabled	boolean	取得並設定為啟用或未啟用的.pull 要求部署。

EnvironmentRetentionPolicy

名稱	類型	Description
daysToKeep	integer	取得並設定要保留環境的天數。
releasesToKeep	integer	取得並設定要保留的版本數目。
retainBuild	boolean	取得並設定為要保留或不保留的組建。

EnvironmentTrigger

名稱	類型	Description
definitionEnvironmentId	integer	此觸發程式適用的定義環境識別碼。
releaseDefinitionId	integer	此觸發程式適用的 ReleaseDefinition 識別碼。
triggerContent	string	取得或設定觸發程式內容。
triggerType	EnvironmentTriggerType	取得或設定觸發程式類型。

EnvironmentTriggerType

取得或設定觸發程式類型。

名稱	類型	Description
deploymentGroupRedeploy	string	環境觸發程式類型是部署群組重新部署。
rollbackRedeploy	string	環境觸發程式類型為 Rollback。
undefined	string	未定義環境觸發程式類型。

IdentityRef

名稱	類型	Description
_links	ReferenceLinks	此欄位包含圖表主旨的相關零或更多有趣連結。您可以叫用這些連結來取得其他關聯性，或取得此圖表主體的詳細資訊。
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	已被取代 - 可以從描述元的主旨類型推斷 (描述元.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	已被取代 - 可以從描述元的主旨類型推斷 (描述元.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	已被取代 - 不在 ToIdentityRef 的大部分預先存在實作中使用
uniqueName	string	已被取代 - 請改用 Domain+PrincipalName
url	string	此 URL 是此圖形主體來源資源的完整路由。

ProcessParameters

名稱	類型	Description
dataSourceBindings	DataSourceBindingBase[]	表示服務端點要求的資料來源系結。
inputs	TaskInputDefinitionBase[]
sourceDefinitions	TaskSourceDefinitionBase[]

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	連結的唯讀檢視。因為參考連結是唯讀的，所以我們只想要將它們公開為唯讀。

ReleaseDefinition

名稱	類型	Description
_links	ReferenceLinks	取得發行定義相關資源、API 和檢視的連結。
artifacts	Artifact[]	取得或設定成品清單。
comment	string	取得或設定批註。
createdBy	IdentityRef	取得或設定建立的身分識別。
createdOn	string	取得建立日期。
description	string	取得或設定描述。
environments	ReleaseDefinitionEnvironment[]	取得或設定環境清單。
id	integer	取得發行定義的唯一識別碼。
isDeleted	boolean	是否刪除發行定義。
lastRelease	ReleaseReference	取得上次發行的參考。
modifiedBy	IdentityRef	取得或設定已修改的身分識別。
modifiedOn	string	取得修改日期。
name	string	取得或設定發行定義的名稱。
path	string	取得或設定發行定義的路徑。
projectReference	ProjectReference	取得或設定專案參考。
properties	PropertiesCollection	取得或設定屬性。
releaseNameFormat	string	取得或設定發行名稱格式。
revision	integer	取得修訂編號。
source	ReleaseDefinitionSource	取得或設定發行定義的來源。
tags	string[]	取得或設定標記的清單。
triggers	ReleaseTriggerBase[]	取得或設定觸發程式清單。
url	string	取得 REST API URL 以存取發行定義。
variableGroups	integer[]	取得或設定變數群組的清單。
variables	<string, ConfigurationVariableValue>	取得或設定變數的字典。

ReleaseDefinitionApprovals

名稱	類型	Description
approvalOptions	ApprovalOptions	取得或設定核准選項。
approvals	ReleaseDefinitionApprovalStep[]	取得或設定核准。

ReleaseDefinitionApprovalStep

名稱	類型	Description
approver	IdentityRef	取得並設定核准者。
id	integer	核准或部署步驟的識別碼。
isAutomated	boolean	指出核准是否自動化。
isNotificationOn	boolean	指出核准通知集。
rank	integer	取得或設定核准步驟的排名。

ReleaseDefinitionDeployStep

名稱	類型	Description
id	integer	核准或部署步驟的識別碼。
tasks	WorkflowTask[]	此定義的步驟清單。

ReleaseDefinitionEnvironment

名稱	類型	Description
badgeUrl	string	取得或設定 BadgeUrl。當發行定義環境中啟用徽章時，將會使用 BadgeUrl。
conditions	Condition[]	取得或設定環境條件。
currentRelease	ReleaseShallowReference	取得或設定目前的版本參考。
demands	Demand[]	取得或設定需求。
deployPhases	DeployPhase[]	取得或設定環境的部署階段。
deployStep	ReleaseDefinitionDeployStep	取得或設定 deploystep。
environmentOptions	EnvironmentOptions	取得或設定環境選項。
environmentTriggers	EnvironmentTrigger[]	取得或設定環境中的觸發程式。
executionPolicy	EnvironmentExecutionPolicy	取得或設定環境執行原則。
id	integer	取得並設定 ReleaseDefinitionEnvironment 的識別碼。
name	string	取得並設定 ReleaseDefinitionEnvironment 的名稱。
owner	IdentityRef	取得並設定 ReleaseDefinitionEnvironment 的擁有者。
postDeployApprovals	ReleaseDefinitionApprovals	取得或設定部署後核准。
postDeploymentGates	ReleaseDefinitionGatesStep	取得或設定部署後閘道。
preDeployApprovals	ReleaseDefinitionApprovals	取得或設定部署前核准。
preDeploymentGates	ReleaseDefinitionGatesStep	取得或設定預先部署閘道。
processParameters	ProcessParameters	取得或設定環境進程參數。
properties	PropertiesCollection	取得或設定環境上的屬性。
queueId	integer	取得或設定佇列識別碼。
rank	integer	取得並設定 ReleaseDefinitionEnvironment 的排名。
retentionPolicy	EnvironmentRetentionPolicy	取得或設定環境保留原則。
schedules	ReleaseSchedule[]	取得或設定排程
variableGroups	integer[]	取得或設定變數群組。
variables	<string, ConfigurationVariableValue>	取得並設定變數。

ReleaseDefinitionGate

名稱	類型	Description
tasks	WorkflowTask[]	取得或設定閘道工作流程。

ReleaseDefinitionGatesOptions

名稱	類型	Description
isEnabled	boolean	取得或設定為啟用或未啟用閘道。
minimumSuccessDuration	integer	取得或設定成功閘道評估之後穩定結果的最小持續時間。
samplingInterval	integer	取得或設定重新評估閘道之間的時間。
stabilizationTime	integer	取得或設定評估之前的延遲。
timeout	integer	取得或設定閘道失敗之後的逾時。

ReleaseDefinitionGatesStep

名稱	類型	Description
gates	ReleaseDefinitionGate[]	取得或設定閘道。
gatesOptions	ReleaseDefinitionGatesOptions	取得或設定閘道選項。
id	integer	ReleaseDefinitionGateStep 的識別碼。

ReleaseDefinitionShallowReference

名稱	類型	Description
_links	ReferenceLinks	取得發行定義之相關資源、API 和檢視的連結。
id	integer	取得發行定義的唯一識別碼。
name	string	取得或設定發行定義的名稱。
path	string	取得或設定發行定義的路徑。
projectReference	ProjectReference	取得或設定專案參考。
url	string	取得 REST API URL 以存取發行定義。

ReleaseDefinitionSource

取得或設定發行定義的來源。

名稱	類型	Description
ibiza	string	指出從 Ibiza 建立的 ReleaseDefinition。
portalExtensionApi	string	指出從 PortalExtension API 建立的 ReleaseDefinition。
restApi	string	指出使用 REST API 建立的 ReleaseDefinition。
undefined	string	表示未定義 ReleaseDefinition 來源。
userInterface	string	指出使用 UI 建立的 ReleaseDefinition。

ReleaseReason

取得發行的原因。

名稱	類型	Description
continuousIntegration	string	表示持續整合所觸發的發行。
manual	string	指出手動觸發的發行。
none	string	指出未設定發行觸發的原因。
pullRequest	string	指出 PullRequest 所觸發的發行。
schedule	string	表示排程所觸發的發行。

ReleaseReference

名稱	類型	Description
_links	ReferenceLinks	取得存取發行的連結。
artifacts	Artifact[]	取得成品的清單。
createdBy	IdentityRef	取得建立發行的身分識別。
createdOn	string	取得這個版本建立的日期。
description	string	取得描述。
id	integer	發行的識別碼。
modifiedBy	IdentityRef	取得修改發行的身分識別。
name	string	取得發行的名稱。
reason	ReleaseReason	取得發行的原因。
releaseDefinition	ReleaseDefinitionShallowReference	取得發行定義淺層參考。

ReleaseSchedule

名稱	類型	Description
daysToRelease	ScheduleDays	發行的星期幾。
jobId	string	Team Foundation 作業定義作業識別碼。
scheduleOnlyWithChanges	boolean	旗標，以判斷此排程是否應該只在相關聯的成品已變更或發行定義變更時釋放。
startHours	integer	要開始的當地時區小時。
startMinutes	integer	要開始的當地時區分鐘。
timeZoneId	string	發行排程的時區識別碼，例如 'UTC'。

ReleaseShallowReference

名稱	類型	Description
_links	ReferenceLinks	取得版本相關資源、API 和檢視的連結。
id	integer	取得發行的唯一識別碼。
name	string	取得或設定發行的名稱。
url	string	取得要存取版本的 REST API URL。

ReleaseTriggerBase

名稱	類型	Description
triggerType	ReleaseTriggerType	發行觸發程式的類型。

ReleaseTriggerType

發行觸發程式的類型。

名稱	類型	Description
artifactSource	string	成品型發行觸發程式。
containerImage	string	容器映射型發行觸發程式。
package	string	套件型發行觸發程式。
pullRequest	string	提取要求型發行觸發程式。
schedule	string	排程型發行觸發程式。
sourceRepo	string	來源存放庫型發行觸發程式。
undefined	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	TaskInputValidation
visibleRule	string

TaskInputValidation

名稱	類型	Description
expression	string	條件運算式
message	string	說明使用者如何在驗證失敗時更正的訊息

TaskSourceDefinitionBase

名稱	類型	Description
authKey	string
endpoint	string
keySelector	string
selector	string
target	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	取得或設定工作的版本。

共用方式為