Releases - Get Release Environment

服务:

Release

API 版本:

7.1

获取发布环境。

GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/releases/{releaseId}/environments/{environmentId}?api-version=7.1

具有可选参数:

GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/releases/{releaseId}/environments/{environmentId}?$expand={$expand}&api-version=7.1

URI 参数

名称	在	必需	类型	说明
environmentId	path	True	integer (int32)	发布环境的 ID。
organization	path	True	string	Azure DevOps 组织的名称。
project	path	True	string	项目 ID 或项目名称
releaseId	path	True	integer (int32)	版本的 ID。
api-version	query	True	string	要使用的 API 版本。 这应设置为“7.1”才能使用此版本的 API。
$expand	query		ReleaseEnvironmentExpands	应在环境中扩展的属性。

响应

名称	类型	说明
200 OK	ReleaseEnvironment	成功作

安全性

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	授予读取发布项目（包括文件夹、发布、发布定义和发布环境）的能力。

定义

名称	说明
ApprovalExecutionOrder	审批执行顺序。
ApprovalOptions
ApprovalStatus	获取或设置审批的状态。
ApprovalType	获取或设置审批的类型。
AuthorizationHeader
ConditionType	获取或设置条件类型。
ConfigurationVariableValue
DataSourceBindingBase	表示服务终结点请求的数据源绑定。
DeploymentAttempt
DeploymentJob
DeploymentOperationStatus	获取部署的作状态。
DeploymentReason	获取部署的原因。
DeploymentStatus	获取部署的状态。
DeployPhase
DeployPhaseStatus	阶段的状态。
DeployPhaseTypes	指示部署阶段类型。
EnvironmentOptions
EnvironmentStatus	获取环境状态。
GateStatus	释放门的状态。
IdentityRef
IgnoredGate
Issue
ManualIntervention
ManualInterventionStatus	获取或设置手动干预的状态。
ProcessParameters
ProjectReference
ReferenceLinks	表示 REST 引用链接集合的类。
ReleaseApproval
ReleaseApprovalHistory
ReleaseCondition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionShallowReference
ReleaseDeployPhase
ReleaseEnvironment
ReleaseEnvironmentExpands	应在环境中扩展的属性。
ReleaseEnvironmentShallowReference
ReleaseGates
ReleaseSchedule
ReleaseShallowReference
ReleaseTask
ScheduleDays	要发布的一周中的天数。
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
TaskStatus	发布任务的状态。
VariableGroup
VariableGroupProjectReference	变量组引用是对变量组的浅表引用。
VariableGroupProviderData
VariableValue
WorkflowTask
WorkflowTaskReference

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 天。

ApprovalStatus

枚举

获取或设置审批的状态。

值	说明
approved	指示批准。
canceled	指示审批已取消。
pending	指示审批处于挂起状态。
reassigned	指示重新分配审批。
rejected	指示审批被拒绝。
skipped	指示跳过审批。
undefined	指示审批没有状态集。

ApprovalType

枚举

获取或设置审批的类型。

值	说明
all	指示所有审批。
postDeploy	指示部署后执行的审批。
preDeploy	指示在部署之前执行的审批。
undefined	指示未设置审批类型。

AuthorizationHeader

Object

名称	类型	说明
name	string
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	获取或设置数据源的目标。

DeploymentAttempt

Object

名称	类型	说明
attempt	integer (int32)	部署尝试。
deploymentId	integer (int32)	部署的 ID。
hasStarted	boolean	指定部署是否已启动。
id	integer (int32)	部署的 ID。
issues	Issue[]	与部署相关的所有问题。
lastModifiedBy	IdentityRef	上次修改此部署的标识。
lastModifiedOn	string (date-time)	上次修改此部署的时间。
operationStatus	DeploymentOperationStatus	部署作状态。
postDeploymentGates	ReleaseGates	在此部署中执行的部署入口后。
preDeploymentGates	ReleaseGates	在此部署中执行的预部署门。
queuedOn	string (date-time)	此部署排队时。
reason	DeploymentReason	部署的原因。
releaseDeployPhases	ReleaseDeployPhase[]	在此部署中执行的发布部署阶段的列表。
requestedBy	IdentityRef	请求此部署的标识。
requestedFor	IdentityRef	请求的此部署的标识。
status	DeploymentStatus	部署的状态。

DeploymentJob

Object

名称	类型	说明
job	ReleaseTask	所有已执行任务的父任务。
tasks	ReleaseTask[]	作业中已执行的任务列表。

DeploymentOperationStatus

枚举

获取部署的作状态。

值	说明
all	部署作状态全部。
approved	部署作状态已获得批准。
canceled	部署作状态已取消。
cancelling	部署作状态正在取消。
deferred	部署作状态延迟。
evaluatingGates	部署作状态为 EvaluatingGates。
gateFailed	部署作状态为 GateFailed。
manualInterventionPending	部署作状态为手动交互挂起。
pending	部署作状态挂起。
phaseCanceled	部署作状态已取消。
phaseFailed	部署作状态为阶段失败。
phaseInProgress	部署作状态正在进行阶段。
phasePartiallySucceeded	部署作状态为部分成功阶段。
phaseSucceeded	部署作状态为阶段成功。
queued	部署作状态已排队。
queuedForAgent	部署作状态已排队等待代理。
queuedForPipeline	部署作状态已排队等待管道。
rejected	部署作状态被拒绝。
scheduled	计划部署作状态。
undefined	部署作状态未定义。

DeploymentReason

枚举

获取部署的原因。

值	说明
automated	部署原因是自动化的。
manual	部署原因为手动。
none	部署原因为 none。
redeployTrigger	部署原因是 RedeployTrigger。
scheduled	计划部署原因。

DeploymentStatus

枚举

获取部署的状态。

值	说明
all	部署状态全部。
failed	部署状态失败。
inProgress	部署状态正在进行中。
notDeployed	部署状态未部署。
partiallySucceeded	部署状态已部分完成。
succeeded	部署状态成功。
undefined	部署状态未定义。

DeployPhase

Object

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

DeployPhaseStatus

枚举

阶段的状态。

值	说明
canceled	阶段执行已取消。
cancelling	阶段处于取消状态。
failed	阶段执行失败。
inProgress	正在进行阶段执行。
notStarted	阶段执行未启动。
partiallySucceeded	阶段执行部分成功。
skipped	已跳过阶段执行。
succeeded	阶段执行成功。
undefined	未设置阶段状态。

DeployPhaseTypes

枚举

指示部署阶段类型。

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

EnvironmentOptions

Object

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

EnvironmentStatus

枚举

获取环境状态。

值	说明
canceled	环境处于已取消状态。
inProgress	环境处于正在进行状态。
notStarted	环境处于未启动状态。
partiallySucceeded	环境处于部分成功状态。
queued	环境处于排队状态。
rejected	环境处于拒绝状态。
scheduled	环境处于计划状态。
succeeded	环境处于成功状态。
undefined	未设置环境状态。

GateStatus

枚举

释放门的状态。

值	说明
canceled	门执行已取消。
failed	门执行失败。
inProgress	大门目前正在进行中。
none	门没有状态集。
pending	门处于挂起状态。
succeeded	大门成功完成。

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 是指向此图形主题的源资源的完整路由。

IgnoredGate

Object

名称	类型	说明
lastModifiedOn	string (date-time)	获取上次忽略门的日期。
name	string	忽略门的名称。

Issue

Object

名称	类型	说明
data	object	问题数据。
issueType	string	问题类型，例如错误、警告或信息。
message	string	问题消息。

ManualIntervention

Object

名称	类型	说明
approver	IdentityRef	获取或设置应批准的身份。
comments	string	获取或设置审批的注释。
createdOn	string (date-time)	获取其创建日期。
id	integer (int32)	获取手动干预的唯一标识符。
instructions	string	获取或设置审批说明。
modifiedOn	string (date-time)	获取修改日期。
name	string	获取或设置名称。
release	ReleaseShallowReference	获取 releaseReference 进行手动干预。
releaseDefinition	ReleaseDefinitionShallowReference	获取 releaseDefinitionReference 进行手动干预。
releaseEnvironment	ReleaseEnvironmentShallowReference	获取 releaseEnvironmentReference 进行手动干预。
status	ManualInterventionStatus	获取或设置手动干预的状态。
taskInstanceId	string (uuid)	获取任务实例标识符。
url	string	获取用于访问手动干预的 URL。

ManualInterventionStatus

枚举

获取或设置手动干预的状态。

值	说明
approved	手动干预已获得批准。
canceled	手动干预已取消。
pending	手动干预处于挂起状态。
rejected	手动干预被拒绝。
unknown	手动干预没有状态集。

ProcessParameters

Object

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

ProjectReference

Object

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

ReferenceLinks

Object

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

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

ReleaseApproval

Object

名称	类型	说明
approvalType	ApprovalType	获取或设置审批的类型。
approvedBy	IdentityRef	获取已批准的标识。
approver	IdentityRef	获取或设置应批准的身份。
attempt	integer (int32)	获取或设置指定其所属部署尝试的尝试。
comments	string	获取或设置审批的注释。
createdOn	string (date-time)	获取其创建日期。
history	ReleaseApprovalHistory[]	获取指定与此审批关联的所有审批的历史记录。
id	integer (int32)	获取此字段的唯一标识符。
isAutomated	boolean	获取或设置审批是自动化的。
modifiedOn	string (date-time)	获取修改日期。
rank	integer (int32)	获取或设置指定审批顺序的排名。 例如，同一排名表示并行审批。
release	ReleaseShallowReference	获取 releaseReference，它指定与此审批关联的版本的引用。
releaseDefinition	ReleaseDefinitionShallowReference	获取 releaseDefinitionReference，它指定与此审批关联的发布定义的引用。
releaseEnvironment	ReleaseEnvironmentShallowReference	获取 releaseEnvironmentReference，它指定与此审批关联的发布环境的引用。
revision	integer (int32)	获取修订号。
status	ApprovalStatus	获取或设置审批的状态。
url	string	获取用于访问审批的 URL。

ReleaseApprovalHistory

Object

名称	类型	说明
approver	IdentityRef	审批者的标识。
changedBy	IdentityRef	更改审批的对象标识。
comments	string	审批历史记录注释。
createdOn	string (date-time)	创建此审批的时间。
modifiedOn	string (date-time)	此审批修改的时间。
revision	integer (int32)	审批历史记录修订。

ReleaseCondition

Object

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

ReleaseDefinitionApprovals

Object

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

ReleaseDefinitionApprovalStep

Object

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

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。

ReleaseDefinitionShallowReference

Object

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

ReleaseDeployPhase

Object

名称	类型	说明
deploymentJobs	DeploymentJob[]	阶段的部署作业。
errorLog	string	阶段执行错误日志。
manualInterventions	ManualIntervention[]	阶段手动干预任务执行信息的列表。
name	string	阶段的名称。
phaseId	string	阶段的 ID。
phaseType	DeployPhaseTypes	阶段的类型。
rank	integer (int32)	阶段的排名。
runPlanId	string (uuid)	运行阶段的计划 ID。
startedOn	string (date-time)	阶段开始时间。
status	DeployPhaseStatus	阶段的状态。

ReleaseEnvironment

Object

名称	类型	说明
conditions	ReleaseCondition[]	获取条件列表。
createdOn	string (date-time)	获取其创建日期。
definitionEnvironmentId	integer (int32)	获取定义环境 ID。
deployPhasesSnapshot	DeployPhase[]	获取部署阶段快照的列表。
deploySteps	DeploymentAttempt[]	获取部署步骤。
environmentOptions	EnvironmentOptions	获取环境选项。
id	integer (int32)	获取此字段的唯一标识符。
modifiedOn	string (date-time)	获取修改日期。
name	string	获取名称。
nextScheduledUtcTime	string (date-time)	获取下一个计划的 UTC 时间。
owner	IdentityRef	获取谁是发布环境的所有者的标识。
postApprovalsSnapshot	ReleaseDefinitionApprovals	获取部署后审批快照的列表。
postDeployApprovals	ReleaseApproval[]	获取部署后审批的列表。
postDeploymentGatesSnapshot	ReleaseDefinitionGatesStep	部署后门快照数据。
preApprovalsSnapshot	ReleaseDefinitionApprovals	获取预部署审批快照的列表。
preDeployApprovals	ReleaseApproval[]	获取预部署审批的列表。
preDeploymentGatesSnapshot	ReleaseDefinitionGatesStep	部署前门快照数据。
processParameters	ProcessParameters	获取进程参数。
rank	integer (int32)	获取排名。
release	ReleaseShallowReference	获取发布引用，该引用指定与此发布环境关联的版本引用。
releaseCreatedBy	IdentityRef	获取创建发布的标识。
releaseDefinition	ReleaseDefinitionShallowReference	获取 releaseDefinitionReference，它指定与此发布环境关联的发布定义的引用。
releaseId	integer (int32)	获取发布 ID。
scheduledDeploymentTime	string (date-time)	获取发布环境的计划部署时间。
schedules	ReleaseSchedule[]	获取计划列表。
status	EnvironmentStatus	获取环境状态。
timeToDeploy	number (double)	获取部署时间。
triggerReason	string	获取触发器原因。
variableGroups	VariableGroup[]	获取变量组的列表。
variables	<string,  ConfigurationVariableValue>	获取变量的字典。

ReleaseEnvironmentExpands

枚举

应在环境中扩展的属性。

值	说明
none	返回对象的顶级属性。
tasks	使用任务展开环境。

ReleaseEnvironmentShallowReference

Object

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

ReleaseGates

Object

名称	类型	说明
deploymentJobs	DeploymentJob[]	包含每个评估的入口作业详细信息。
id	integer (int32)	发布入口的 ID。
ignoredGates	IgnoredGate[]	忽略的门的列表。
lastModifiedOn	string (date-time)	盖茨上次修改时间。
runPlanId	string (uuid)	运行入口的计划 ID。
stabilizationCompletedOn	string (date-time)	盖茨稳定完成日期和时间。
startedOn	string (date-time)	盖茨评估开始时间。
status	GateStatus	释放门的状态。
succeedingSince	string (date-time)	成功执行所有入口的日期和时间。

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。

ReleaseTask

Object

名称	类型	说明
agentName	string	执行任务的代理名称。
finishTime	string (date-time)	完成发布任务的时间。
id	integer (int32)	发布任务的 ID。
issues	Issue[]	执行任务时出现的问题列表。
lineCount	integer (int64)	日志发布任务包含的行数。
logUrl	string	任务的日志 URL。
name	string	任务的名称。
percentComplete	integer (int32)	任务执行完成预先完成。
rank	integer (int32)	发布任务的排名。
resultCode	string	任务的结果代码。
startTime	string (date-time)	发布任务的 ID。
status	TaskStatus	发布任务的状态。
task	WorkflowTaskReference	工作流任务参考。
timelineRecordId	string (uuid)	发布任务的时间线记录 ID。

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

TaskStatus

枚举

发布任务的状态。

值	说明
canceled	任务执行已取消。
failed	任务执行失败。
failure	任务执行失败。
inProgress	任务当前正在进行中。
partiallySucceeded	任务执行部分成功。
pending	任务处于挂起状态。
skipped	已跳过任务执行。
succeeded	任务已成功完成。
success	任务已成功完成。
unknown	任务没有状态集。

VariableGroup

Object

名称	类型	说明
createdBy	IdentityRef	获取或设置创建者的标识。
createdOn	string (date-time)	获取其创建日期。
description	string	获取或设置说明。
id	integer (int32)	获取此字段的唯一标识符。
isShared	boolean	表示变量组是否与其他项目共享。
modifiedBy	IdentityRef	获取或设置修改的标识。
modifiedOn	string (date-time)	获取修改日期。
name	string	获取或设置名称。
providerData	VariableGroupProviderData	获取或设置提供程序数据。
type	string	获取或设置类型。
variableGroupProjectReferences	VariableGroupProjectReference[]	变量组与其他项目共享的所有项目引用。
variables	<string,  VariableValue>	获取和设置变量的字典。

VariableGroupProjectReference

Object

变量组引用是对变量组的浅表引用。

名称	类型	说明
description	string	获取或设置变量组的说明。
name	string	获取或设置变量组的名称。
projectReference	ProjectReference	获取或设置变量组的项目引用。

VariableGroupProviderData

Object

VariableValue

Object

名称	类型	说明
isReadOnly	boolean	获取或设置变量是否为只读。
isSecret	boolean	获取或设置变量为机密或不机密。
value	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	获取或设置任务的版本。

WorkflowTaskReference

Object

名称	类型	说明
id	string (uuid)	任务标识符。
name	string	任务的名称。
version	string	任务的版本。