Definitions - Get

Service:

Release

API Version:

5.0

릴리스 정의를 가져옵니다.

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

With optional parameters:

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
definitionId	path	True	integer int32	릴리스 정의의 ID입니다.
organization	path	True	string	Azure DevOps 조직의 이름입니다.
project	path	True	string	프로젝트 ID 또는 프로젝트 이름
api-version	query	True	string	사용할 API의 버전입니다. 이 버전의 api를 사용하려면 '5.0'으로 설정해야 합니다.
propertyFilters	query		string array (string)	검색할 확장 속성의 쉼표로 구분된 목록입니다. 설정된 경우 반환된 릴리스 정의에는 지정된 속성 ID(있는 경우)에 대한 값이 포함됩니다. 설정하지 않으면 속성이 포함되지 않습니다.

응답

Name	형식	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

Name	Description
vso.release	릴리스, 릴리스 정의 및 릴리스 환경을 포함하여 릴리스 아티팩트 읽기 기능을 부여합니다.

정의

Name	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

Name	형식	Description
afterGatesAlways	string
afterSuccessfulGates	string
beforeGates	string

ApprovalOptions

Name	형식	Description
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped	boolean
enforceIdentityRevalidation	boolean
executionOrder	ApprovalExecutionOrder
releaseCreatorCanBeApprover	boolean
requiredApproverCount	integer
timeoutInMinutes	integer

Artifact

Name	형식	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

Name	형식	Description
id	string
name	string

AuthorizationHeader

Name	형식	Description
name	string
value	string

Condition

Name	형식	Description
conditionType	ConditionType	조건 유형을 가져오거나 설정합니다.
name	string	조건의 이름을 가져오거나 설정합니다. 예: 'ReleaseStarted'.
value	string	조건의 값을 가져오거나 설정합니다.

ConditionType

조건 유형을 가져오거나 설정합니다.

Name	형식	Description
artifact	string	조건 유형이 아티팩트입니다.
environmentState	string	조건 유형은 환경 상태입니다.
event	string	조건 유형은 이벤트입니다.
undefined	string	조건 유형이 정의되지 않았습니다.

ConfigurationVariableValue

Name	형식	Description
allowOverride	boolean	배포 시 변수를 재정의할 수 있는지 여부를 가져오거나 설정합니다.
isSecret	boolean	변수가 비밀인지 여부를 가져오거나 설정합니다.
value	string	구성 변수의 값을 가져오거나 설정합니다.

DataSourceBindingBase

서비스 엔드포인트 요청에 대한 데이터 원본의 바인딩을 나타냅니다.

Name	형식	Description
callbackContextTemplate	string	이 데이터 원본에서 지원하는 페이지 매김 형식(ContinuationToken/SkipTop).
callbackRequiredTemplate	string	후속 호출이 필요하신가요?
dataSourceName	string	데이터 원본의 이름을 가져오거나 설정합니다.
endpointId	string	엔드포인트 ID를 가져오거나 설정합니다.
endpointUrl	string	서비스 엔드포인트의 URL을 가져오거나 설정합니다.
headers	AuthorizationHeader[]	권한 부여 헤더를 가져오거나 설정합니다.
initialContextTemplate	string	쿼리 매개 변수의 초기 값을 정의합니다.
parameters	object	데이터 원본에 대한 매개 변수를 가져오거나 설정합니다.
resultSelector	string	결과 선택기를 가져오거나 설정합니다.
resultTemplate	string	결과 템플릿을 가져오거나 설정합니다.
target	string	데이터 원본의 대상을 가져오거나 설정합니다.

Demand

Name	형식	Description
name	string
value	string

DeployPhase

Name	형식	Description
name	string
phaseType	DeployPhaseTypes
rank	integer
refName	string
workflowTasks	WorkflowTask[]

DeployPhaseTypes

Name	형식	Description
agentBasedDeployment	string
deploymentGates	string	배포가 진행되도록 게이트 역할을 하는 작업을 포함하는 단계 유형입니다.
machineGroupBasedDeployment	string
runOnServer	string
undefined	string

EnvironmentExecutionPolicy

Release Management 쪽 큐에서 환경 큐에 대한 정책을 정의합니다. 언급된 정책이 충족되는 경우에만 환경 실행기 [사전 배포 및 기타 단계 만들기]로 보냅니다.

Name	형식	Description
concurrencyCount	integer	이 정책은 Environment Runner를 사용하는 환경 수를 결정합니다.
queueDepthCount	integer	EnvironmentQueue 테이블의 큐 깊이에서 이 테이블은 환경 실행기가 실행하기 위해 다른 환경을 사용할 수 있도록 [정책에 따라] 무료가 될 때까지 환경 항목을 유지합니다.

EnvironmentOptions

Name	형식	Description
autoLinkWorkItems	boolean
badgeEnabled	boolean
emailNotificationType	string
emailRecipients	string
enableAccessToken	boolean
publishDeploymentStatus	boolean
pullRequestDeploymentEnabled	boolean
skipArtifactsDownload	boolean
timeoutInMinutes	integer

EnvironmentRetentionPolicy

Name	형식	Description
daysToKeep	integer
releasesToKeep	integer
retainBuild	boolean

EnvironmentTrigger

Name	형식	Description
definitionEnvironmentId	integer
releaseDefinitionId	integer
triggerContent	string
triggerType	EnvironmentTriggerType

EnvironmentTriggerType

Name	형식	Description
deploymentGroupRedeploy	string
rollbackRedeploy	string
undefined	string

IdentityRef

Name	형식	Description
_links	ReferenceLinks	이 필드에는 그래프 제목에 대한 0개 이상의 흥미로운 링크가 포함되어 있습니다. 이러한 링크를 호출하여 이 그래프 제목에 대한 추가 관계 또는 자세한 정보를 얻을 수 있습니다.
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은 이 그래프 주체의 원본 리소스에 대한 전체 경로입니다.

ProcessParameters

Name	형식	Description
dataSourceBindings	DataSourceBindingBase[]	서비스 엔드포인트 요청에 대한 데이터 원본의 바인딩을 나타냅니다.
inputs	TaskInputDefinitionBase[]
sourceDefinitions	TaskSourceDefinitionBase[]

ProjectReference

Name	형식	Description
id	string	이 필드의 고유 식별자를 가져옵니다.
name	string	프로젝트의 이름을 가져옵니다.

PropertiesCollection

클래스는 키-값 쌍의 컬렉션으로 속성 모음을 나타냅니다. 를 제외한 모든 기본 형식의 값(을 TypeCode != TypeCode.Object제외한 DBNull 모든 형식)이 허용됩니다. Byte[], Int32, Double, DateType 및 String 형식의 값은 해당 형식을 유지하며 다른 기본 형식은 String으로 다시 조정됩니다. byte[] base64로 인코딩된 문자열로 예상됩니다.

Name	형식	Description
count	integer	컬렉션의 속성 수입니다.
item	object
keys	string[]	컬렉션의 키 집합입니다.
values	string[]	컬렉션의 값 집합입니다.

ReferenceLinks

REST 참조 링크의 컬렉션을 나타내는 클래스입니다.

Name	형식	Description
links	object	링크의 읽기 전용 보기입니다. 참조 링크는 읽기 전용이므로 읽기 전용으로만 노출하려고 합니다.

ReleaseDefinition

Name	형식	Description
_links	ReferenceLinks	릴리스 정의에 대한 관련 리소스, API 및 뷰에 대한 링크를 가져옵니다.
artifacts	Artifact[]	아티팩트 목록을 가져오거나 설정합니다.
comment	string	주석을 가져오거나 설정합니다.
createdBy	IdentityRef	만든 ID를 가져오거나 설정합니다.
createdOn	string	만든 날짜를 가져옵니다.
description	string	설명을 가져오거나 설정합니다.
environments	ReleaseDefinitionEnvironment[]	환경 목록을 가져오거나 설정합니다.
id	integer	릴리스 정의의 고유 식별자를 가져옵니다.
isDeleted	boolean	릴리스 정의를 삭제할지 여부입니다.
lastRelease	ReleaseReference	마지막 릴리스의 참조를 가져옵니다.
modifiedBy	IdentityRef	수정한 ID를 가져오거나 설정합니다.
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

Name	형식	Description
approvalOptions	ApprovalOptions
approvals	ReleaseDefinitionApprovalStep[]

ReleaseDefinitionApprovalStep

Name	형식	Description
approver	IdentityRef
id	integer
isAutomated	boolean
isNotificationOn	boolean
rank	integer

ReleaseDefinitionDeployStep

Name	형식	Description
id	integer
tasks	WorkflowTask[]	이 정의에 대한 단계 목록입니다.

ReleaseDefinitionEnvironment

Name	형식	Description
badgeUrl	string
conditions	Condition[]
currentRelease	ReleaseShallowReference
demands	Demand[]
deployPhases	DeployPhase[]
deployStep	ReleaseDefinitionDeployStep
environmentOptions	EnvironmentOptions
environmentTriggers	EnvironmentTrigger[]
executionPolicy	EnvironmentExecutionPolicy	Release Management 쪽 큐에서 환경 큐에 대한 정책을 정의합니다. 언급된 정책이 충족되는 경우에만 환경 실행기 [사전 배포 및 기타 단계 만들기]로 보냅니다.
id	integer
name	string
owner	IdentityRef
postDeployApprovals	ReleaseDefinitionApprovals
postDeploymentGates	ReleaseDefinitionGatesStep
preDeployApprovals	ReleaseDefinitionApprovals
preDeploymentGates	ReleaseDefinitionGatesStep
processParameters	ProcessParameters
properties	PropertiesCollection	클래스는 키-값 쌍의 컬렉션으로 속성 모음을 나타냅니다. 를 제외한 모든 기본 형식의 값(을 TypeCode != TypeCode.Object제외한 DBNull 모든 형식)이 허용됩니다. Byte[], Int32, Double, DateType 및 String 형식의 값은 해당 형식을 유지하며 다른 기본 형식은 String으로 다시 조정됩니다. byte[] base64로 인코딩된 문자열로 예상됩니다.
queueId	integer
rank	integer
retentionPolicy	EnvironmentRetentionPolicy
schedules	ReleaseSchedule[]
variableGroups	integer[]
variables	<string,  ConfigurationVariableValue>

ReleaseDefinitionGate

Name	형식	Description
tasks	WorkflowTask[]

ReleaseDefinitionGatesOptions

Name	형식	Description
isEnabled	boolean
minimumSuccessDuration	integer
samplingInterval	integer
stabilizationTime	integer
timeout	integer

ReleaseDefinitionGatesStep

Name	형식	Description
gates	ReleaseDefinitionGate[]
gatesOptions	ReleaseDefinitionGatesOptions
id	integer

ReleaseDefinitionShallowReference

Name	형식	Description
_links	ReferenceLinks	릴리스 정의에 대한 관련 리소스, API 및 뷰에 대한 링크를 가져옵니다.
id	integer	릴리스 정의의 고유 식별자를 가져옵니다.
name	string	릴리스 정의의 이름을 가져오거나 설정합니다.
path	string	릴리스 정의의 경로를 가져오거나 설정합니다.
projectReference	ProjectReference	프로젝트 참조를 가져오거나 설정합니다.
url	string	릴리스 정의에 액세스하기 위한 REST API URL을 가져옵니다.

ReleaseDefinitionSource

릴리스 정의의 원본을 가져오거나 설정합니다.

Name	형식	Description
ibiza	string
portalExtensionApi	string
restApi	string
undefined	string
userInterface	string

ReleaseReason

릴리스 이유를 가져옵니다.

Name	형식	Description
continuousIntegration	string
manual	string
none	string
pullRequest	string
schedule	string

ReleaseReference

Name	형식	Description
_links	ReferenceLinks	릴리스에 액세스할 링크를 가져옵니다.
artifacts	Artifact[]	아티팩트 목록을 가져옵니다.
createdBy	IdentityRef	만든 ID를 가져옵니다.
createdOn	string	만든 날짜를 가져옵니다.
description	string	설명을 가져옵니다.
id	integer	이 필드의 고유 식별자를 가져옵니다.
modifiedBy	IdentityRef	수정한 ID를 가져옵니다.
name	string	릴리스의 이름을 가져옵니다.
reason	ReleaseReason	릴리스 이유를 가져옵니다.
releaseDefinition	ReleaseDefinitionShallowReference	릴리스 정의 단순 참조를 가져옵니다.

ReleaseSchedule

Name	형식	Description
daysToRelease	ScheduleDays	릴리스할 요일
jobId	string	Team Foundation 작업 정의 작업 ID
startHours	integer	시작하는 현지 표준 시간대 시간
startMinutes	integer	시작할 현지 표준 시간대 분
timeZoneId	string	'UTC'와 같은 릴리스 일정의 표준 시간대 ID

ReleaseShallowReference

Name	형식	Description
_links	ReferenceLinks	릴리스에 대한 관련 리소스, API 및 뷰에 대한 링크를 가져옵니다.
id	integer	릴리스의 고유 식별자를 가져옵니다.
name	string	릴리스의 이름을 가져오거나 설정합니다.
url	string	릴리스에 액세스할 REST API URL을 가져옵니다.

ReleaseTriggerBase

Name	형식	Description
triggerType	ReleaseTriggerType

ReleaseTriggerType

Name	형식	Description
artifactSource	string
containerImage	string
package	string
pullRequest	string
schedule	string
sourceRepo	string
undefined	string

ScheduleDays

릴리스할 요일

Name	형식	Description
all	string
friday	string
monday	string
none	string
saturday	string
sunday	string
thursday	string
tuesday	string
wednesday	string

TaskInputDefinitionBase

Name	형식	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

Name	형식	Description
expression	string	조건 식
message	string	유효성 검사에 실패할 경우 사용자가 수정할 수 있는 방법을 설명하는 메시지

TaskSourceDefinitionBase

Name	형식	Description
authKey	string
endpoint	string
keySelector	string
selector	string
target	string

WorkflowTask

Name	형식	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