Approvals - Update

참조

서비스:: Release

API 버전:: 7.1

승인 상태 업데이트

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
approvalId	path	True	integer (int32)	승인의 ID입니다.
organization	path	True	string	Azure DevOps 조직의 이름입니다.
project	path	True	string	프로젝트 ID 또는 프로젝트 이름
api-version	query	True	string	사용할 API의 버전입니다. 이 버전의 API를 사용하려면 '7.1'로 설정해야 합니다.

요청 본문

Name	형식	Description
approvalType	ApprovalType	승인 유형을 가져오거나 설정합니다.
approvedBy	IdentityRef	승인된 ID를 가져옵니다.
approver	IdentityRef	승인할 ID를 가져오거나 설정합니다.
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을 가져옵니다.

응답

Name	형식	Description
200 OK	ReleaseApproval	성공한 작업

보안

oauth2

형식: oauth2
Flow: 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

범위

Name	Description
vso.release_manage	폴더, 릴리스, 릴리스 정의 및 릴리스 환경을 포함하여 릴리스 아티팩트를 읽고 업데이트하고 삭제하는 기능과 새 릴리스를 큐에 대기하고 승인하는 기능을 부여합니다.

예제

Approve a release

샘플 요청

HTTP

PATCH https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/approvals/{approvalId}?api-version=7.1

{
  "status": "approved",
  "comments": "Good to go!"
}

샘플 응답

상태 코드:: 200

{
  "id": 20,
  "revision": 1,
  "approver": {
    "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"
  },
  "approvedBy": {
    "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"
  },
  "approvalType": "preDeploy",
  "createdOn": "2017-05-31T18:07:40.45Z",
  "modifiedOn": "2017-05-31T18:08:09.577Z",
  "status": "approved",
  "comments": "Good to go!",
  "isAutomated": false,
  "isNotificationOn": true,
  "trialNumber": 1,
  "attempt": 1,
  "rank": 1,
  "history": [],
  "release": {
    "id": 3,
    "name": "Release-3",
    "url": "https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/Release/releases/3",
    "_links": {}
  },
  "releaseDefinition": {
    "id": 1,
    "name": "MyShuttle.CD",
    "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
    "_links": {}
  },
  "releaseEnvironment": {
    "id": 9,
    "name": "Dev",
    "_links": {}
  },
  "url": "https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/Release/approvals/20"
}

정의

Name	Description
ApprovalStatus	승인 상태를 가져오거나 설정합니다.
ApprovalType	승인 유형을 가져오거나 설정합니다.
IdentityRef
ProjectReference
ReferenceLinks	REST 참조 링크의 컬렉션을 나타내는 클래스입니다.
ReleaseApproval
ReleaseApprovalHistory
ReleaseDefinitionShallowReference
ReleaseEnvironmentShallowReference
ReleaseShallowReference

ApprovalStatus

열거형

승인 상태를 가져오거나 설정합니다.

값	Description
approved	승인이 승인되었음을 나타냅니다.
canceled	승인이 취소되었음을 나타냅니다.
pending	승인이 보류 중임을 나타냅니다.
reassigned	승인이 다시 할당되었음을 나타냅니다.
rejected	승인이 거부되었음을 나타냅니다.
skipped	승인을 건너뛰었다는 것을 나타냅니다.
undefined	승인에 상태 집합이 없음을 나타냅니다.

ApprovalType

열거형

승인 유형을 가져오거나 설정합니다.

값	Description
all	모든 승인을 나타냅니다.
postDeploy	배포 후 실행된 승인을 나타냅니다.
preDeploy	배포 전에 실행된 승인을 나타냅니다.
undefined	승인 유형이 설정되지 않음을 나타냅니다.

IdentityRef

Object

Name	형식	Description
_links	ReferenceLinks	이 필드에는 그래프 제목에 대한 0개 이상의 흥미로운 링크가 포함되어 있습니다. 이러한 링크를 호출하여 이 그래프 제목에 대한 추가 관계 또는 자세한 정보를 얻을 수 있습니다.
descriptor	string	설명자는 시스템이 실행되는 동안 그래프 제목을 참조하는 기본 방법입니다. 이 필드는 계정과 조직 모두에서 동일한 그래프 제목을 고유하게 식별합니다.
directoryAlias	string	사용되지 않음 - IdentityRef "_links" 사전의 "자체" 항목에서 참조된 Graph 사용자를 쿼리하여 검색할 수 있습니다.
displayName	string	그래프 주체의 고유하지 않은 표시 이름입니다. 이 필드를 변경하려면 원본 공급자에서 해당 값을 변경해야 합니다.
id	string
imageUrl	string	사용되지 않음 - IdentityRef "_links" 사전의 "아바타" 항목에서 사용할 수 있습니다.
inactive	boolean	사용되지 않음 - GraphUser "_links" 사전의 "membershipState" 항목에서 참조되는 Graph 멤버 자격 상태를 쿼리하여 검색할 수 있습니다.
isAadIdentity	boolean	사용되지 않음 - 설명자의 주체 형식(Descriptor.IsAadUserType/Descriptor.IsAadGroupType)에서 유추할 수 있습니다.
isContainer	boolean	사용되지 않음 - 설명자의 주체 형식에서 유추할 수 있음(Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	사용되지 않음 - ToIdentityRef의 기존 구현에서 사용되지 않음
uniqueName	string	사용되지 않음 - 대신 Domain+PrincipalName 사용
url	string	이 URL은 이 그래프 주체의 원본 리소스에 대한 전체 경로입니다.

ProjectReference

Object

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

ReferenceLinks

Object

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

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

ReleaseApproval

Object

Name	형식	Description
approvalType	ApprovalType	승인 유형을 가져오거나 설정합니다.
approvedBy	IdentityRef	승인된 ID를 가져옵니다.
approver	IdentityRef	승인할 ID를 가져오거나 설정합니다.
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

Name	형식	Description
approver	IdentityRef	승인자의 ID입니다.
changedBy	IdentityRef	승인을 변경한 개체의 ID입니다.
comments	string	승인 기록 주석입니다.
createdOn	string (date-time)	이 승인이 만들어진 시간입니다.
modifiedOn	string (date-time)	이 승인이 수정된 시간입니다.
revision	integer (int32)	승인 기록 수정.

ReleaseDefinitionShallowReference

Object

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

ReleaseEnvironmentShallowReference

Object

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

ReleaseShallowReference

Object

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

다음을 통해 공유

Approvals - Update

URI 매개 변수

요청 본문

응답

보안

oauth2

범위

예제

Approve a release

샘플 요청

샘플 응답

정의

ApprovalStatus

ApprovalType

IdentityRef

ProjectReference

ReferenceLinks

ReleaseApproval

ReleaseApprovalHistory

ReleaseDefinitionShallowReference

ReleaseEnvironmentShallowReference

ReleaseShallowReference