Share via

Definitions - Get

  • 参考
Service:
Release
API Version:
7.1-preview.4

获取发布定义。

GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions/{definitionId}?api-version=7.1-preview.4
With optional parameters: 
GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions/{definitionId}?propertyFilters={propertyFilters}&api-version=7.1-preview.4

URI 参数

名称 在 必需 类型 说明
definitionId
 path True

integer

int32

发布定义的 ID。
organization
 path True

string

Azure DevOps 组织的名称。
project
 path True

string

项目 ID 或项目名称
api-version
 query True

string

要使用的 API 版本。 这应设置为“7.1-preview.4”才能使用此版本的 API。
propertyFilters
 query

string

array (string)

要检索的扩展属性的逗号分隔列表。 如果设置，则返回的发布定义将包含指定属性 ID 的值 (（如果它们存在于) ）。 如果未设置，则不包括属性。

响应

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

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

示例

Get a release definition

Sample Request

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

Sample Response

Status code:
200 
{
  "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-11T04:48:42.657Z",
  "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-11T04:48:42.657Z",
  "isDeleted": false,
  "variables": {},
  "variableGroups": [],
  "environments": [
    {
      "id": 40,
      "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": 118
          }
        ],
        "approvalOptions": {
          "requiredApproverCount": 0,
          "releaseCreatorCanBeApprover": true,
          "autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
          "enforceIdentityRevalidation": false,
          "timeoutInMinutes": 0,
          "executionOrder": "beforeGates"
        }
      },
      "deployStep": {
        "id": 119
      },
      "postDeployApprovals": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 120
          }
        ]
      },
      "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/40/40"
    }
  ],
  "artifacts": [],
  "triggers": [],
  "releaseNameFormat": "",
  "tags": [],
  "properties": {},
  "id": 40,
  "name": "Fabrikam-web",
  "path": "\\",
  "projectReference": null,
  "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/40",
  "_links": {
    "self": {
      "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/40"
    },
    "web": {
      "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=40"
    }
  }
}

定义

名称 说明
ApprovalExecutionOrder

审批执行顺序。
ApprovalOptions
Artifact
ArtifactSourceReference
AuthorizationHeader
Condition
ConditionType

获取或设置条件类型。
ConfigurationVariableValue
DataSourceBindingBase

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

指示部署阶段类型。
EnvironmentExecutionPolicy

定义Release Management端队列的环境队列策略。 仅当满足上述策略时，才会发送到环境运行器[创建预部署和其他步骤]。
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
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionShallowReference
ReleaseDefinitionSource

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

获取发布的原因。
ReleaseReference
ReleaseSchedule
ReleaseShallowReference
ReleaseTriggerBase
ReleaseTriggerType

发布触发器的类型。
ScheduleDays

要发布的星期数。
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
WorkflowTask

ApprovalExecutionOrder

审批执行顺序。

名称 类型 说明
afterGatesAlways

string

执行入口后始终显示审批。
afterSuccessfulGates

string

成功执行入口后显示的审批。
beforeGates

string

入口前显示的审批。

ApprovalOptions

名称 类型 说明
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped

boolean

指定如果同一审批者批准上一阶段，是否可以跳过审批。
enforceIdentityRevalidation

boolean

指定在完成审批之前是否重新验证审批者的标识。
executionOrder

ApprovalExecutionOrder

审批执行顺序。
releaseCreatorCanBeApprover

boolean

指定请求发布或部署的用户是否应允许审批者。
requiredApproverCount

integer

推进发布所需的审批数。 “0”表示需要的所有审批。
timeoutInMinutes

integer

审批超时。 审批默认超时为 30 天。 允许的最大超时时间为 365 天。 “0”表示默认超时，即 30 天。

Artifact

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

名称 类型 说明
id

string

项目源的 ID。
name

string

项目源的名称。

AuthorizationHeader

名称 类型 说明
name

string

value

string

Condition

名称 类型 说明
conditionType

ConditionType

获取或设置条件类型。
name

string

获取或设置条件的名称。 例如“ReleaseStarted”。
value

string

获取或设置条件的值。

ConditionType

获取或设置条件类型。

名称 类型 说明
artifact

string

条件类型为项目。
environmentState

string

条件类型为环境状态。
event

string

条件类型为事件。
undefined

string

条件类型未定义。

ConfigurationVariableValue

名称 类型 说明
allowOverride

boolean

获取并设置变量是否可以在部署时重写。
isSecret

boolean

获取或设置变量是否为机密。
value

string

获取并设置配置变量的值。

DataSourceBindingBase

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

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

名称 类型 说明
name

string

获取并设置需求的名称。
value

string

获取并设置 demand 的值。

DeployPhase

名称 类型 说明
name

string

获取并设置部署阶段的名称。
phaseType

DeployPhaseTypes

指示部署阶段类型。
rank

integer

获取并设置部署阶段的排名。
refName

string

获取并设置部署阶段的引用名称。
workflowTasks

WorkflowTask[]

获取并设置部署阶段的工作流任务。

DeployPhaseTypes

指示部署阶段类型。

名称 类型 说明
agentBasedDeployment

string

阶段类型，其中包含在代理上执行的任务。
deploymentGates

string

阶段类型，其中包含充当部署进一步的入口的任务。
machineGroupBasedDeployment

string

阶段类型，包含部署组计算机上执行的任务。
runOnServer

string

包含服务器执行的任务的阶段类型。
undefined

string

未定义阶段类型。 不要使用此参数。

EnvironmentExecutionPolicy

定义Release Management端队列的环境队列策略。 仅当满足上述策略时，才会发送到环境运行器[创建预部署和其他步骤]。

名称 类型 说明
concurrencyCount

integer

此策略决定使用环境运行器的环境数量。
queueDepthCount

integer

在 EnvironmentQueue 表中的队列深度，此表会保留环境条目，直到环境运行器（根据策略）可用，以采用另一个环境运行。

EnvironmentOptions

名称 类型 说明
autoLinkWorkItems

boolean

获取并设置为是否自动链接工作项。
badgeEnabled

boolean

获取并设置为是否启用锁屏提醒。
publishDeploymentStatus

boolean

获取和设置是否为发布部署状态。
pullRequestDeploymentEnabled

boolean

获取 并设置为 。是否启用拉取请求部署。

EnvironmentRetentionPolicy

名称 类型 说明
daysToKeep

integer

获取并设置要保留环境的天数。
releasesToKeep

integer

获取并设置要保留的版本数。
retainBuild

boolean

获取并设置为要保留或不保留的生成。

EnvironmentTrigger

名称 类型 说明
definitionEnvironmentId

integer

此触发器适用的定义环境 ID。
releaseDefinitionId

integer

适用于此触发器的 ReleaseDefinition ID。
triggerContent

string

获取或设置触发器内容。
triggerType

EnvironmentTriggerType

获取或设置触发器类型。

EnvironmentTriggerType

获取或设置触发器类型。

名称 类型 说明
deploymentGroupRedeploy

string

环境触发器类型为部署组重新部署。
rollbackRedeploy

string

环境触发器类型为 Rollback。
undefined

string

环境触发器类型未定义。

IdentityRef

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

名称 类型 说明
dataSourceBindings

DataSourceBindingBase[]

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

TaskInputDefinitionBase[]

sourceDefinitions

TaskSourceDefinitionBase[]

ProjectReference

名称 类型 说明
id

string

获取此字段的唯一标识符。
name

string

获取项目的名称。

PropertiesCollection

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

名称 类型 说明
count

integer

集合中的属性计数。
item

object

keys

string[]

集合中的键集。
values

string[]

集合中的值集。

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

名称 类型 说明
links

object

链接的只读视图。 由于引用链接是只读的，因此我们只想将其公开为只读。

ReleaseDefinition

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

名称 类型 说明
approvalOptions

ApprovalOptions

获取或设置审批选项。
approvals

ReleaseDefinitionApprovalStep[]

获取或设置审批。

ReleaseDefinitionApprovalStep

名称 类型 说明
approver

IdentityRef

获取并设置审批者。
id

integer

审批或部署步骤的 ID。
isAutomated

boolean

指示审批是否自动执行。
isNotificationOn

boolean

指示是否设置了审批通知。
rank

integer

获取或设置审批步骤的排名。

ReleaseDefinitionDeployStep

名称 类型 说明
id

integer

审批或部署步骤的 ID。
tasks

WorkflowTask[]

此定义的步骤列表。

ReleaseDefinitionEnvironment

名称 类型 说明
badgeUrl

string

获取或设置 BadgeUrl。 在发布定义环境中启用 Badge 时，将使用 BadgeUrl。
conditions

Condition[]

获取或设置环境条件。
currentRelease

ReleaseShallowReference

获取或设置当前版本引用。
demands

Demand[]

获取或设置要求。
deployPhases

DeployPhase[]

获取或设置环境的部署阶段。
deployStep

ReleaseDefinitionDeployStep

获取或设置部署步骤。
environmentOptions

EnvironmentOptions

获取或设置环境选项。
environmentTriggers

EnvironmentTrigger[]

获取或设置环境中的触发器。
executionPolicy

EnvironmentExecutionPolicy

获取或设置环境执行策略。
id

integer

获取并设置 ReleaseDefinitionEnvironment 的 ID。
name

string

获取并设置 ReleaseDefinitionEnvironment 的名称。
owner

IdentityRef

获取并设置 ReleaseDefinitionEnvironment 的所有者。
postDeployApprovals

ReleaseDefinitionApprovals

获取或设置部署后审批。
postDeploymentGates

ReleaseDefinitionGatesStep

获取或设置部署后入口。
preDeployApprovals

ReleaseDefinitionApprovals

获取或设置部署前审批。
preDeploymentGates

ReleaseDefinitionGatesStep

获取或设置部署前入口。
processParameters

ProcessParameters

获取或设置环境进程参数。
properties

PropertiesCollection

获取或设置环境的属性。
queueId

integer

获取或设置队列 ID。
rank

integer

获取并设置 ReleaseDefinitionEnvironment 的排名。
retentionPolicy

EnvironmentRetentionPolicy

获取或设置环境保留策略。
schedules

ReleaseSchedule[]

获取或设置计划
variableGroups

integer[]

获取或设置变量组。
variables

<string,  ConfigurationVariableValue>

获取和设置变量。

ReleaseDefinitionGate

名称 类型 说明
tasks

WorkflowTask[]

获取或设置入口工作流。

ReleaseDefinitionGatesOptions

名称 类型 说明
isEnabled

boolean

获取或设置为启用或未启用的门。
minimumSuccessDuration

integer

获取或设置成功门评估后稳定结果的最短持续时间。
samplingInterval

integer

获取或设置门的重新计算之间的时间。
stabilizationTime

integer

获取或设置计算前的延迟。
timeout

integer

获取或设置超时，在此超时后门会失败。

ReleaseDefinitionGatesStep

名称 类型 说明
gates

ReleaseDefinitionGate[]

获取或设置门。
gatesOptions

ReleaseDefinitionGatesOptions

获取或设置门选项。
id

integer

ReleaseDefinitionGateStep 的 ID。

ReleaseDefinitionShallowReference

名称 类型 说明
_links

ReferenceLinks

获取指向发布定义的相关资源、API 和视图的链接。
id

integer

获取发布定义的唯一标识符。
name

string

获取或设置发布定义的名称。
path

string

获取或设置发布定义的路径。
projectReference

ProjectReference

获取或设置项目引用。
url

string

获取用于访问发布定义的 REST API URL。

ReleaseDefinitionSource

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

名称 类型 说明
ibiza

string

指示从 Ibiza 创建的 ReleaseDefinition。
portalExtensionApi

string

指示从 PortalExtension API 创建的 ReleaseDefinition。
restApi

string

指示使用 REST API 创建的 ReleaseDefinition。
undefined

string

指示未定义 ReleaseDefinition 源。
userInterface

string

指示使用 UI 创建的 ReleaseDefinition。

ReleaseReason

获取发布的原因。

名称 类型 说明
continuousIntegration

string

指示由持续集成触发的发布。
manual

string

指示手动触发的释放。
none

string

指示未设置发布触发的原因。
pullRequest

string

指示 PullRequest 触发的发布。
schedule

string

指示按计划触发的发布。

ReleaseReference

名称 类型 说明
_links

ReferenceLinks

获取用于访问发布的链接。
artifacts

Artifact[]

获取项目列表。
createdBy

IdentityRef

获取创建发布的标识。
createdOn

string

获取创建此版本的日期。
description

string

获取说明。
id

integer

Release 的 ID。
modifiedBy

IdentityRef

获取修改了版本的标识。
name

string

获取发布的名称。
reason

ReleaseReason

获取发布的原因。
releaseDefinition

ReleaseDefinitionShallowReference

获取发布定义浅表引用。

ReleaseSchedule

名称 类型 说明
daysToRelease

ScheduleDays

要发布的星期数。
jobId

string

Team Foundation 作业定义作业 ID。
scheduleOnlyWithChanges

boolean

用于确定此计划是否仅在关联的项目已更改或发布定义发生更改时发布。
startHours

integer

要开始的本地时区小时。
startMinutes

integer

要开始的本地时区分钟数。
timeZoneId

string

发布计划的时区 ID，例如“UTC”。

ReleaseShallowReference

名称 类型 说明
_links

ReferenceLinks

获取指向发布的相关资源、API 和视图的链接。
id

integer

获取发布的唯一标识符。
name

string

获取或设置发布的名称。
url

string

获取用于访问发布的 REST API URL。

ReleaseTriggerBase

名称 类型 说明
triggerType

ReleaseTriggerType

发布触发器的类型。

ReleaseTriggerType

发布触发器的类型。

名称 类型 说明
artifactSource

string

基于项目的发布触发器。
containerImage

string

基于容器映像的发布触发器。
package

string

基于包的发布触发器。
pullRequest

string

基于拉取请求的发布触发器。
schedule

string

基于计划的发布触发器。
sourceRepo

string

基于源存储库的发布触发器。
undefined

string

未设置释放触发器类型。

ScheduleDays

要发布的星期数。

名称 类型 说明
all

string

计划于一周中的所有日期。
friday

string

计划于星期五。
monday

string

计划于星期一。
none

string

未设置计划日期。
saturday

string

计划于星期六。
sunday

string

计划于星期日。
thursday

string

计划于星期四。
tuesday

string

计划于星期二。
wednesday

string

计划于星期三。

TaskInputDefinitionBase

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

名称 类型 说明
expression

string

条件表达式
message

string

说明用户在验证失败时如何更正的消息

TaskSourceDefinitionBase

名称 类型 说明
authKey

string

endpoint

string

keySelector

string

selector

string

target

string

WorkflowTask

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

获取或设置任务的 ID。
timeoutInMinutes

integer

获取或设置任务超时。
version

string

获取或设置任务的版本。