Definitions - List

参考

服务:: Release

API 版本:: 7.1

获取发布定义列表。

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

具有可选参数:

GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions?searchText={searchText}&$expand={$expand}&artifactType={artifactType}&artifactSourceId={artifactSourceId}&$top={$top}&continuationToken={continuationToken}&queryOrder={queryOrder}&path={path}&isExactNameMatch={isExactNameMatch}&tagFilter={tagFilter}&propertyFilters={propertyFilters}&definitionIdFilter={definitionIdFilter}&isDeleted={isDeleted}&searchTextContainsFolderName={searchTextContainsFolderName}&api-version=7.1

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
project	path	True	string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。这应设置为“7.1”才能使用此版本的 API。
$expand	query		ReleaseDefinitionExpands	应在发布定义列表中展开的属性。
$top	query		integer (int32)	要获取的发布定义数。
artifactSourceId	query		string	将返回具有给定 artifactSourceId 的发布定义。例如，对于生成，它将是 {projectGuid}：{BuildDefinitionId}，对于 Jenkins，它是 {JenkinsConnectionId}：{JenkinsDefinitionId}，对于 TfsOnPrem，它将是 {TfsOnPremConnectionId}：{ProjectName}：{TfsOnPremDefinitionId}。对于第三方项目，例如 TeamCity，BitBucket 可以在 https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensionsvss-extension.json 内引用“uniqueSourceIdentifier”。
artifactType	query		string	将返回具有给定 artifactType 的发布定义。值可以是 Build、Jenkins、GitHub、Nuget、Team Build（外部）、ExternalTFSBuild、Git、TFVC、ExternalTfsXamlBuild。
continuationToken	query		string	获取提供延续令牌后的版本定义。
definitionIdFilter	query		string (array (string))	要检索的发布定义的逗号分隔列表。
isDeleted	query		boolean	“true”用于获取已删除的发布定义。默认值为“false”
isExactNameMatch	query		boolean	“true”可获取与 searchText 中指定的完全匹配的发布定义。默认值为“false”。
path	query		string	获取指定路径下的发布定义。
propertyFilters	query		string (array (string))	要检索的扩展属性的逗号分隔列表。如果已设置，则返回的发布定义将包含指定属性 ID 的值（如果存在）。如果未设置，则不会包含属性。请注意，无论结果是否设置了属性，这都不会从结果中筛选出任何发布定义。
queryOrder	query		ReleaseDefinitionQueryOrder	按定义的顺序获取结果。默认值为“IdAscending”。
searchText	query		string	获取包含 searchText 的名称的发布定义。
searchTextContainsFolderName	query		boolean	“true”用于获取文件夹下的发布定义，其名称在 searchText 中指定的名称。默认值为“false”。
tagFilter	query		string (array (string))	以逗号分隔的标记列表。仅返回包含这些标记的发布定义。

响应

名称	类型	说明
200 OK	ReleaseDefinition[]	成功作

安全性

oauth2

类型: oauth2
流向: accessCode
授权 URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
令牌 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

作用域

名称	说明
vso.release	授予读取发布项目（包括文件夹、发布、发布定义和发布环境）的能力。

示例

With artifacts details expanded

With environments details expanded

示例请求

HTTP

GET https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/definitions?api-version=7.1

示例响应

状态代码:: 200

{
  "count": 1,
  "value": [
    {
      "source": "userInterface",
      "id": 1,
      "revision": 3,
      "name": "MyShuttle.CD",
      "description": null,
      "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"
      },
      "createdOn": "2017-05-31T16:39:04.883Z",
      "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"
      },
      "modifiedOn": "2017-05-31T16:39:58.06Z",
      "lastRelease": {
        "id": 14,
        "name": "Release-14",
        "artifacts": [],
        "webAccessUri": null,
        "_links": {},
        "description": "",
        "releaseDefinition": {
          "id": 1,
          "_links": {}
        },
        "createdOn": "2017-06-01T09:42:15.273Z",
        "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"
        },
        "modifiedBy": null,
        "reason": "none"
      },
      "path": "\\",
      "variableGroups": null,
      "releaseNameFormat": "Release-$(rev:r)",
      "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
      "_links": {
        "self": {
          "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
        },
        "web": {
          "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
        }
      },
      "properties": {}
    }
  ]
}

With artifacts details expanded

示例请求

HTTP

GET https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/definitions?$expand=Artifacts&api-version=7.1

示例响应

状态代码:: 200

{
  "count": 1,
  "value": [
    {
      "source": "userInterface",
      "id": 1,
      "revision": 3,
      "name": "MyShuttle.CD",
      "description": null,
      "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"
      },
      "createdOn": "2017-05-31T16:39:04.883Z",
      "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"
      },
      "modifiedOn": "2017-05-31T16:39:58.06Z",
      "lastRelease": {
        "id": 14,
        "name": "Release-14",
        "artifacts": [],
        "webAccessUri": null,
        "_links": {},
        "description": "",
        "releaseDefinition": {
          "id": 1,
          "_links": {}
        },
        "createdOn": "2017-06-01T09:42:15.273Z",
        "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"
        },
        "modifiedBy": null,
        "reason": "none"
      },
      "path": "\\",
      "variableGroups": null,
      "artifacts": [],
      "releaseNameFormat": "Release-$(rev:r)",
      "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
      "_links": {
        "self": {
          "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
        },
        "web": {
          "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
        }
      },
      "properties": {}
    }
  ]
}

With environments details expanded

示例请求

HTTP

GET https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/definitions?$expand=Environments&api-version=7.1

示例响应

状态代码:: 200

{
  "count": 1,
  "value": [
    {
      "source": "userInterface",
      "id": 1,
      "revision": 3,
      "name": "MyShuttle.CD",
      "description": null,
      "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"
      },
      "createdOn": "2017-05-31T16:39:04.883Z",
      "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"
      },
      "modifiedOn": "2017-05-31T16:39:58.06Z",
      "lastRelease": {
        "id": 14,
        "name": "Release-14",
        "artifacts": [],
        "webAccessUri": null,
        "_links": {},
        "description": "",
        "releaseDefinition": {
          "id": 1,
          "_links": {}
        },
        "createdOn": "2017-06-01T09:42:15.273Z",
        "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"
        },
        "modifiedBy": null,
        "reason": "none"
      },
      "path": "\\",
      "variableGroups": null,
      "environments": [
        {
          "id": 1,
          "name": "Dev",
          "rank": 1,
          "schedules": [],
          "retentionPolicy": {
            "daysToKeep": 30,
            "releasesToKeep": 3,
            "retainBuild": true
          }
        },
        {
          "id": 2,
          "name": "QA",
          "rank": 2,
          "schedules": [],
          "retentionPolicy": {
            "daysToKeep": 30,
            "releasesToKeep": 3,
            "retainBuild": true
          }
        },
        {
          "id": 3,
          "name": "PPE",
          "rank": 3,
          "schedules": [],
          "retentionPolicy": {
            "daysToKeep": 30,
            "releasesToKeep": 3,
            "retainBuild": true
          }
        },
        {
          "id": 4,
          "name": "PROD",
          "rank": 4,
          "schedules": [],
          "retentionPolicy": {
            "daysToKeep": 30,
            "releasesToKeep": 3,
            "retainBuild": true
          }
        }
      ],
      "releaseNameFormat": "Release-$(rev:r)",
      "retentionPolicy": {
        "daysToKeep": 30
      },
      "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
      "_links": {
        "self": {
          "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
        },
        "web": {
          "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
        }
      },
      "properties": {}
    }
  ]
}

定义

名称	说明
ApprovalExecutionOrder	审批执行顺序。
ApprovalOptions
Artifact
ArtifactSourceReference
AuthorizationHeader
Condition
ConditionType	获取或设置条件类型。
ConfigurationVariableValue
DataSourceBindingBase	表示服务终结点请求的数据源绑定。
Demand
DeployPhase
DeployPhaseTypes	指示部署阶段类型。
EnvironmentExecutionPolicy	定义发布管理端队列中的环境队列策略。仅当满足提到的策略时，才会发送到环境运行程序 [创建预部署和其他步骤]。
EnvironmentOptions
EnvironmentRetentionPolicy
EnvironmentTrigger
EnvironmentTriggerType	获取或设置触发器类型。
IdentityRef
ProcessParameters
ProjectReference
PropertiesCollection	类将属性包表示为键值对的集合。接受除 `DBNull` 以外的所有基元类型（具有 `TypeCode != TypeCode.Object`的任何类型）的值。 Byte[]、Int32、Double、DateType 和 String 类型的值将保留其类型，其他基元将重新调整为 String。 Byte[] 应为 base64 编码字符串。
ReferenceLinks	表示 REST 引用链接集合的类。
ReleaseDefinition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionDeployStep
ReleaseDefinitionEnvironment
ReleaseDefinitionExpands	应在发布定义列表中展开的属性。
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionQueryOrder	按定义的顺序获取结果。默认值为“IdAscending”。
ReleaseDefinitionShallowReference
ReleaseDefinitionSource	获取或设置发布定义的源。
ReleaseReason	获取发布的原因。
ReleaseReference
ReleaseSchedule
ReleaseShallowReference
ReleaseTriggerBase
ReleaseTriggerType	发布触发器的类型。
ScheduleDays	要发布的一周中的天数。
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
WorkflowTask

ApprovalExecutionOrder

枚举

审批执行顺序。

值	说明
afterGatesAlways	执行入口后始终显示的审批。
afterSuccessfulGates	成功执行入口后显示的审批。
beforeGates	门前显示的审批。

ApprovalOptions

Object

名称	类型	说明
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped	boolean	指定如果同一审批者批准上一阶段，是否可以跳过审批。
enforceIdentityRevalidation	boolean	指定在完成审批之前是否重新验证审批者的标识。
executionOrder	ApprovalExecutionOrder	审批执行顺序。
releaseCreatorCanBeApprover	boolean	指定请求发布或部署的用户是否应允许审批者。
requiredApproverCount	integer (int32)	推进发布所需的审批数。 “0”表示所需的所有审批。
timeoutInMinutes	integer (int32)	审批超时。审批默认超时为 30 天。允许的最大超时时间为 365 天。 “0”表示默认超时，即 30 天。

Artifact

Object

名称	类型	说明
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（external）”、“ExternalTFSBuild”、“Git”、“TFVC”、“ExternalTfsXamlBuild”。

ArtifactSourceReference

Object

名称	类型	说明
id	string	项目源的 ID。
name	string	项目源的名称。

AuthorizationHeader

Object

名称	类型	说明
name	string
value	string

Condition

Object

名称	类型	说明
conditionType	ConditionType	获取或设置条件类型。
name	string	获取或设置条件的名称。例如“ReleaseStarted”。
value	string	获取或设置条件的值。

ConditionType

枚举

获取或设置条件类型。

值	说明
artifact	条件类型为项目。
environmentState	条件类型为环境状态。
event	条件类型为事件。
undefined	条件类型未定义。

ConfigurationVariableValue

Object

名称	类型	说明
allowOverride	boolean	获取和设置是否可以在部署时重写变量。
isSecret	boolean	获取或设置变量为机密或不机密。
value	string	获取和设置配置变量的值。

DataSourceBindingBase

Object

表示服务终结点请求的数据源绑定。

名称	类型	说明
callbackContextTemplate	string	此数据源支持的分页格式（ContinuationToken/SkipTop）。
callbackRequiredTemplate	string	需要后续调用？
dataSourceName	string	获取或设置数据源的名称。
endpointId	string	获取或设置终结点 ID。
endpointUrl	string	获取或设置服务终结点的 URL。
headers	AuthorizationHeader[]	获取或设置授权标头。
initialContextTemplate	string	定义查询参数的初始值
parameters	object	获取或设置数据源的参数。
requestContent	string	获取或设置 http 请求正文
requestVerb	string	获取或设置 http 请求谓词
resultSelector	string	获取或设置结果选择器。
resultTemplate	string	获取或设置结果模板。
target	string	获取或设置数据源的目标。

Demand

Object

名称	类型	说明
name	string	获取和设置需求的名称。
value	string	获取和设置需求值。

DeployPhase

Object

名称	类型	说明
name	string	获取和设置部署阶段的名称。
phaseType	DeployPhaseTypes	指示部署阶段类型。
rank	integer (int32)	获取和设置部署阶段的排名。
refName	string	获取和设置部署阶段的引用名称。
workflowTasks	WorkflowTask[]	获取和设置部署阶段的工作流任务。

DeployPhaseTypes

枚举

指示部署阶段类型。

值	说明
agentBasedDeployment	阶段类型，其中包含在代理上执行的任务。
deploymentGates	阶段类型，其中包含充当入口的任务，以便进行部署。
machineGroupBasedDeployment	阶段类型，其中包含在部署组计算机上执行的任务。
runOnServer	包含服务器执行的任务的阶段类型。
undefined	未定义阶段类型。请勿使用此。

EnvironmentExecutionPolicy

Object

定义发布管理端队列中的环境队列策略。仅当满足提到的策略时，才会发送到环境运行程序 [创建预部署和其他步骤]。

名称	类型	说明
concurrencyCount	integer (int32)	此策略决定环境运行程序将有多少环境。
queueDepthCount	integer (int32)	EnvironmentQueue 表中的队列深度，此表会保留环境条目，直到环境运行程序是免费的（根据环境运行程序的策略），以采用另一个环境来运行。

EnvironmentOptions

Object

名称	类型	说明
autoLinkWorkItems	boolean	获取和设置为自动链接工作项。
badgeEnabled	boolean	获取和设置为已启用锁屏提醒。
publishDeploymentStatus	boolean	获取和设置为发布部署状态。
pullRequestDeploymentEnabled	boolean	获取和设置为启用或未启用.pull 请求部署。

EnvironmentRetentionPolicy

Object

名称	类型	说明
daysToKeep	integer (int32)	获取和设置要保留环境的天数。
releasesToKeep	integer (int32)	获取并设置要保留的版本数。
retainBuild	boolean	获取并设置为要保留或不保留的生成。

EnvironmentTrigger

Object

名称	类型	说明
definitionEnvironmentId	integer (int32)	此触发器适用的定义环境 ID。
releaseDefinitionId	integer (int32)	此触发器适用的 ReleaseDefinition ID。
triggerContent	string	获取或设置触发器内容。
triggerType	EnvironmentTriggerType	获取或设置触发器类型。

EnvironmentTriggerType

枚举

获取或设置触发器类型。

值	说明
deploymentGroupRedeploy	环境触发器类型是部署组重新部署。
rollbackRedeploy	环境触发器类型为回滚。
undefined	未定义环境触发器类型。

IdentityRef

Object

名称	类型	说明
_links	ReferenceLinks	此字段包含有关图形主题的零个或多个有趣的链接。可以调用这些链接以获取有关此图形主题的其他关系或更详细的信息。
descriptor	string	描述符是在系统运行时引用图形主题的主要方法。此字段将唯一标识帐户和组织中的同一图形主题。
directoryAlias	string	已弃用 - 可以通过查询 IdentityRef“_links”字典的“self”条目中引用的 Graph 用户来检索
displayName	string	这是图形主题的非唯一显示名称。若要更改此字段，必须在源提供程序中更改其值。
id	string
imageUrl	string	已弃用 - 在 IdentityRef“_links”字典的“虚拟形象”条目中可用
inactive	boolean	已弃用 - 可以通过查询 GraphUser“_links”字典的“membershipState”条目中引用的 Graph 成员身份状态来检索
isAadIdentity	boolean	已弃用 - 可以从描述符的主题类型推断（Descriptor.IsAadUserType/Descriptor.IsAadGroupType）
isContainer	boolean	已弃用 - 可以从描述符的主题类型推断（描述符.IsGroupType）
isDeletedInOrigin	boolean
profileUrl	string	已弃用 - 不在 ToIdentityRef 的大多数预先存在的实现中使用
uniqueName	string	已弃用 - 请改用 Domain+PrincipalName
url	string	此 URL 是指向此图形主题的源资源的完整路由。

ProcessParameters

Object

名称	类型	说明
dataSourceBindings	DataSourceBindingBase[]	表示服务终结点请求的数据源绑定。
inputs	TaskInputDefinitionBase[]
sourceDefinitions	TaskSourceDefinitionBase[]

ProjectReference

Object

名称	类型	说明
id	string (uuid)	获取此字段的唯一标识符。
name	string	获取项目的名称。

PropertiesCollection

Object

类将属性包表示为键值对的集合。接受除 DBNull 以外的所有基元类型（具有 TypeCode != TypeCode.Object的任何类型）的值。 Byte[]、Int32、Double、DateType 和 String 类型的值将保留其类型，其他基元将重新调整为 String。 Byte[] 应为 base64 编码字符串。

名称	类型	说明
count	integer (int32)	集合中的属性计数。
item	object
keys	string[]	集合中的键集。
values	string[]	集合中的值集。

ReferenceLinks

Object

表示 REST 引用链接集合的类。

名称	类型	说明
links	object	链接的只读视图。由于引用链接是只读的，因此我们只想将其公开为只读链接。

ReleaseDefinition

Object

名称	类型	说明
_links	ReferenceLinks	获取指向发布定义的相关资源、API 和视图的链接。
artifacts	Artifact[]	获取或设置项目列表。
comment	string	获取或设置注释。
createdBy	IdentityRef	获取或设置创建者的标识。
createdOn	string (date-time)	获取其创建日期。
description	string	获取或设置说明。
environments	ReleaseDefinitionEnvironment[]	获取或设置环境列表。
id	integer (int32)	获取发布定义的唯一标识符。
isDeleted	boolean	是否删除发布定义。
lastRelease	ReleaseReference	获取上一版本的引用。
modifiedBy	IdentityRef	获取或设置修改的标识。
modifiedOn	string (date-time)	获取修改日期。
name	string	获取或设置发布定义的名称。
path	string	获取或设置发布定义的路径。
projectReference	ProjectReference	获取或设置项目引用。
properties	PropertiesCollection	获取或设置属性。
releaseNameFormat	string	获取或设置发布名称格式。
revision	integer (int32)	获取修订号。
source	ReleaseDefinitionSource	获取或设置发布定义的源。
tags	string[]	获取或设置标记列表。
triggers	ReleaseTriggerBase[]	获取或设置触发器列表。
url	string	获取用于访问发布定义的 REST API URL。
variableGroups	integer[] (int32)	获取或设置变量组的列表。
variables	<string, ConfigurationVariableValue>	获取或设置变量的字典。

ReleaseDefinitionApprovals

Object

名称	类型	说明
approvalOptions	ApprovalOptions	获取或设置审批选项。
approvals	ReleaseDefinitionApprovalStep[]	获取或设置审批。

ReleaseDefinitionApprovalStep

Object

名称	类型	说明
approver	IdentityRef	获取和设置审批者。
id	integer (int32)	审批或部署步骤的 ID。
isAutomated	boolean	指示审批是否自动进行。
isNotificationOn	boolean	指示审批通知集。
rank	integer (int32)	获取或设置审批步骤的排名。

ReleaseDefinitionDeployStep

Object

名称	类型	说明
id	integer (int32)	审批或部署步骤的 ID。
tasks	WorkflowTask[]	此定义的步骤列表。

ReleaseDefinitionEnvironment

Object

名称	类型	说明
badgeUrl	string	获取或设置 BadgeUrl。在发布定义环境中启用锁屏提醒时，将使用 BadgeUrl。
conditions	Condition[]	获取或设置环境条件。
currentRelease	ReleaseShallowReference	获取或设置当前发布引用。
demands	Demand[]	获取或设置需求。
deployPhases	DeployPhase[]	获取或设置环境的部署阶段。
deployStep	ReleaseDefinitionDeployStep	获取或设置 deploystep。
environmentOptions	EnvironmentOptions	获取或设置环境选项。
environmentTriggers	EnvironmentTrigger[]	获取或设置环境中的触发器。
executionPolicy	EnvironmentExecutionPolicy	获取或设置环境执行策略。
id	integer (int32)	获取并设置 ReleaseDefinitionEnvironment 的 ID。
name	string	获取并设置 ReleaseDefinitionEnvironment 的名称。
owner	IdentityRef	获取并设置 ReleaseDefinitionEnvironment 的所有者。
postDeployApprovals	ReleaseDefinitionApprovals	获取或设置部署后审批。
postDeploymentGates	ReleaseDefinitionGatesStep	获取或设置部署后入口。
preDeployApprovals	ReleaseDefinitionApprovals	获取或设置部署前审批。
preDeploymentGates	ReleaseDefinitionGatesStep	获取或设置部署前入口。
processParameters	ProcessParameters	获取或设置环境进程参数。
properties	PropertiesCollection	获取或设置环境中的属性。
queueId	integer (int32)	获取或设置队列 ID。
rank	integer (int32)	获取并设置 ReleaseDefinitionEnvironment 的排名。
retentionPolicy	EnvironmentRetentionPolicy	获取或设置环境保留策略。
schedules	ReleaseSchedule[]	获取或设置计划
variableGroups	integer[] (int32)	获取或设置变量组。
variables	<string, ConfigurationVariableValue>	获取和设置变量。

ReleaseDefinitionExpands

枚举

应在发布定义列表中展开的属性。

值	说明
artifacts	在返回对象中包含项目。
environments	在返回对象中包含环境。
lastRelease	在返回对象中包含上一个版本。
none	返回对象的顶级属性。
tags	在返回对象中包含标记。
triggers	在返回对象中包含触发器。
variables	在返回对象中包含变量。

ReleaseDefinitionGate

Object

名称	类型	说明
tasks	WorkflowTask[]	获取或设置入口工作流。

ReleaseDefinitionGatesOptions

Object

名称	类型	说明
isEnabled	boolean	获取或设置为启用或未启用的入口。
minimumSuccessDuration	integer (int32)	获取或设置成功入口评估后稳定结果的最短持续时间。
samplingInterval	integer (int32)	获取或设置入口重新计算之间的时间。
stabilizationTime	integer (int32)	获取或设置计算之前的延迟。
timeout	integer (int32)	获取或设置入口失败后的超时。

ReleaseDefinitionGatesStep

Object

名称	类型	说明
gates	ReleaseDefinitionGate[]	获取或设置入口。
gatesOptions	ReleaseDefinitionGatesOptions	获取或设置门选项。
id	integer (int32)	ReleaseDefinitionGateStep 的 ID。

ReleaseDefinitionQueryOrder

枚举

按定义的顺序获取结果。默认值为“IdAscending”。

值	说明
idAscending	根据发布定义 ID 升序返回结果。
idDescending	根据发布定义 ID 降序返回结果。
nameAscending	根据发布定义名称升序返回结果。
nameDescending	根据发布定义名称降序返回结果。

ReleaseDefinitionShallowReference

Object

名称	类型	说明
_links	ReferenceLinks	获取指向发布定义的相关资源、API 和视图的链接。
id	integer (int32)	获取发布定义的唯一标识符。
name	string	获取或设置发布定义的名称。
path	string	获取或设置发布定义的路径。
projectReference	ProjectReference	获取或设置项目引用。
url	string	获取用于访问发布定义的 REST API URL。

ReleaseDefinitionSource

枚举

获取或设置发布定义的源。

值	说明
ibiza	指示从 Ibiza 创建的 ReleaseDefinition。
portalExtensionApi	指示从 PortalExtension API 创建的 ReleaseDefinition。
restApi	指示使用 REST API 创建的 ReleaseDefinition。
undefined	指示未定义 ReleaseDefinition 源。
userInterface	指示使用 UI 创建的 ReleaseDefinition。

ReleaseReason

枚举

获取发布的原因。

值	说明
continuousIntegration	指示持续集成触发的发布。
manual	指示手动触发的发布。
none	指示未设置释放触发的原因。
pullRequest	指示 PullRequest 触发的发布。
schedule	指示按计划触发的发布。

ReleaseReference

Object

名称	类型	说明
_links	ReferenceLinks	获取用于访问发布的链接。
artifacts	Artifact[]	获取项目列表。
createdBy	IdentityRef	获取创建发布的标识。
createdOn	string (date-time)	获取此版本创建日期。
description	string	获取说明。
id	integer (int32)	Release 的 ID。
modifiedBy	IdentityRef	获取修改版本的标识。
name	string	获取发布的名称。
reason	ReleaseReason	获取发布的原因。
releaseDefinition	ReleaseDefinitionShallowReference	获取发布定义浅层引用。

ReleaseSchedule

Object

名称	类型	说明
daysToRelease	ScheduleDays	要发布的一周中的天数。
jobId	string (uuid)	Team Foundation 作业定义作业 ID。
scheduleOnlyWithChanges	boolean	用于确定此计划是否应仅当关联的项目已更改或发布定义更改时才会释放的标志。
startHours	integer (int32)	要开始的本地时区小时。
startMinutes	integer (int32)	要启动的本地时区分钟。
timeZoneId	string	发布计划的时区 ID，例如“UTC”。

ReleaseShallowReference

Object

名称	类型	说明
_links	ReferenceLinks	获取指向发布的相关资源、API 和视图的链接。
id	integer (int32)	获取发布的唯一标识符。
name	string	获取或设置发布的名称。
url	string	获取用于访问发布的 REST API URL。

ReleaseTriggerBase

Object

名称	类型	说明
triggerType	ReleaseTriggerType	发布触发器的类型。

ReleaseTriggerType

枚举

发布触发器的类型。

值	说明
artifactSource	基于项目的发布触发器。
containerImage	基于容器映像的发布触发器。
package	基于包的发布触发器。
pullRequest	基于拉取请求的发布触发器。
schedule	基于计划的发布触发器。
sourceRepo	基于源存储库的发布触发器。
undefined	未设置发布触发器类型。

ScheduleDays

枚举

要发布的一周中的天数。

值	说明
all	安排在一周中的所有天数。
friday	定于星期五。
monday	计划于星期一。
none	未设置计划日期。
saturday	预定在星期六。
sunday	定于周日。
thursday	定于周四。
tuesday	定于周二。
wednesday	定于周三。

TaskInputDefinitionBase

Object

名称	类型	说明
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

Object

名称	类型	说明
expression	string	条件表达式
message	string	说明验证失败时用户如何更正的消息

TaskSourceDefinitionBase

Object

名称	类型	说明
authKey	string
endpoint	string
keySelector	string
selector	string
target	string

WorkflowTask

Object

名称	类型	说明
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 (int32)	获取或设置任务 retryCount。
taskId	string (uuid)	获取或设置任务的 ID。
timeoutInMinutes	integer (int32)	获取或设置任务超时。
version	string	获取或设置任务的版本。

通过

Definitions - List

URI 参数

响应

安全性

oauth2

作用域

示例

示例请求

示例响应

With artifacts details expanded

示例请求

示例响应

With environments details expanded

示例请求

示例响应

定义

ApprovalExecutionOrder

ApprovalOptions

Artifact

ArtifactSourceReference

AuthorizationHeader

Condition

ConditionType

ConfigurationVariableValue

DataSourceBindingBase

Demand

DeployPhase

DeployPhaseTypes

EnvironmentExecutionPolicy

EnvironmentOptions

EnvironmentRetentionPolicy

EnvironmentTrigger

EnvironmentTriggerType

IdentityRef

ProcessParameters

ProjectReference

PropertiesCollection

ReferenceLinks

ReleaseDefinition

ReleaseDefinitionApprovals

ReleaseDefinitionApprovalStep

ReleaseDefinitionDeployStep

ReleaseDefinitionEnvironment

ReleaseDefinitionExpands

ReleaseDefinitionGate

ReleaseDefinitionGatesOptions

ReleaseDefinitionGatesStep

ReleaseDefinitionQueryOrder

ReleaseDefinitionShallowReference

ReleaseDefinitionSource

ReleaseReason

ReleaseReference

ReleaseSchedule

ReleaseShallowReference

ReleaseTriggerBase

ReleaseTriggerType

ScheduleDays

TaskInputDefinitionBase

TaskInputValidation

TaskSourceDefinitionBase

WorkflowTask