Approvals - Update

Service:

Release

API Version:

7.1-preview.3

Onay durumunu güncelleştirme

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
approvalId	path	True	integer int32	Onay kimliği.
organization	path	True	string	Azure DevOps kuruluşunun adı.
project	path	True	string	Proje Kimliği veya proje adı
api-version	query	True	string	Kullanılacak API sürümü. Api'nin bu sürümünü kullanmak için bu değer '7.1-preview.3' olarak ayarlanmalıdır.

İstek Gövdesi

Name	Tür	Description
approvalType	ApprovalType	Onay türünü alır veya ayarlar.
approvedBy	IdentityRef	Onaylayan kimliği alır.
approver	IdentityRef	Onaylaması gereken kimliği alır veya ayarlar.
attempt	integer	Ait olduğu dağıtım girişimini belirten denemeyi alır veya ayarlar.
comments	string	Onay için açıklamaları alır veya ayarlar.
createdOn	string	Oluşturulduğu tarihi alır.
history	ReleaseApprovalHistory[]	Bu onayla ilişkili tüm onayları belirten geçmişi alır.
id	integer	Bu alanın benzersiz tanımlayıcısını alır.
isAutomated	boolean	Onay otomatikleştirilmiş veya değil olarak alır veya ayarlar.
modifiedOn	string	Değiştirildiği tarihi alır.
rank	integer	Onayın sırasını belirten dereceyi alır veya ayarlar. Örneğin, aynı derece paralel onayı belirtir.
release	ReleaseShallowReference	Bu onayın ilişkilendirildiği yayının başvurularını belirten releaseReference'ı alır.
releaseDefinition	ReleaseDefinitionShallowReference	Bu onayın ilişkilendirildiği yayın tanımının başvurularını belirten releaseDefinitionReference'ı alır.
releaseEnvironment	ReleaseEnvironmentShallowReference	Bu onayın ilişkilendirildiği yayın ortamının başvurularını belirten releaseEnvironmentReference alır.
revision	integer	Düzeltme numarasını alır.
status	ApprovalStatus	Onay durumunu alır veya ayarlar.
url	string	Onaya erişmek için URL'yi alır.

Yanıtlar

Name	Tür	Description
200 OK	ReleaseApproval	başarılı işlem

Güvenlik

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_manage	Klasörler, yayınlar, yayın tanımları ve yayın ortamı dahil olmak üzere yayın yapıtlarını okuma, güncelleştirme ve silme ve yeni bir sürümü kuyruğa alma ve onaylama olanağı verir.

Örnekler

Approve a release

Sample Request

HTTP

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

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

Sample Response

Status code:

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"
}

Tanımlar

Name	Description
ApprovalStatus	Onay durumunu alır veya ayarlar.
ApprovalType	Onay türünü alır veya ayarlar.
IdentityRef
ProjectReference
ReferenceLinks	REST başvuru bağlantıları koleksiyonunu temsil eden sınıf.
ReleaseApproval
ReleaseApprovalHistory
ReleaseDefinitionShallowReference
ReleaseEnvironmentShallowReference
ReleaseShallowReference

ApprovalStatus

Onay durumunu alır veya ayarlar.

Name	Tür	Description
approved	string	Onay onayını gösterir.
canceled	string	Onayın iptal olduğunu gösterir.
pending	string	Onayın beklemede olduğunu gösterir.
reassigned	string	Onayın yeniden atandiğini gösterir.
rejected	string	Onayın reddedildiğini gösterir.
skipped	string	Onayın atlanmış olduğunu gösterir.
undefined	string	Onayda durum ayarlanmadığını gösterir.

ApprovalType

Onay türünü alır veya ayarlar.

Name	Tür	Description
all	string	Tüm onayları gösterir.
postDeploy	string	Dağıtımdan sonra yürütülen onayları gösterir.
preDeploy	string	Dağıtımdan önce yürütülen onayları gösterir.
undefined	string	Onay türünün ayarlanmadığını gösterir.

IdentityRef

Name	Tür	Description
_links	ReferenceLinks	Bu alan, grafik konusu hakkında sıfır veya daha fazla ilgi çekici bağlantı içerir. Bu bağlantılar, bu grafik konusu hakkında daha fazla ilişki veya daha ayrıntılı bilgi edinmek için çağrılabilir.
descriptor	string	Tanımlayıcı, sistem çalışırken graf konusuna başvurmanın birincil yoludur. Bu alan, hem Hesaplar hem de Kuruluşlar genelinde aynı graf konusunu benzersiz olarak tanımlar.
directoryAlias	string	Kullanım dışı - IdentityRef "_links" sözlüğündeki "self" girişinde başvuruda bulunılan Graph kullanıcısı sorgulanarak alınabilir
displayName	string	Bu, grafik konusunun benzersiz olmayan görünen adıdır. Bu alanı değiştirmek için kaynak sağlayıcıdaki değerini değiştirmeniz gerekir.
id	string
imageUrl	string	Kullanım dışı - IdentityRef "_links" sözlüğün "avatar" girişinde kullanılabilir
inactive	boolean	Kullanım dışı - GraphUser "_links" sözlüğün "membershipState" girişinde başvurulan Graph üyelik durumu sorgulanarak alınabilir
isAadIdentity	boolean	Kullanım dışı - Tanımlayıcının konu türünden çıkarılabilir (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Kullanım dışı - Tanımlayıcının konu türünden çıkarılabilir (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Kullanım dışı - ToIdentityRef'in önceden var olan uygulamalarının çoğunda kullanımda değil
uniqueName	string	Kullanım dışı - bunun yerine Domain+PrincipalName kullanın
url	string	Bu URL, bu grafik konusunun kaynak kaynağına giden tam yoldur.

ProjectReference

Name	Tür	Description
id	string	Bu alanın benzersiz tanımlayıcısını alır.
name	string	Projenin adını alır.

ReferenceLinks

REST başvuru bağlantıları koleksiyonunu temsil eden sınıf.

Name	Tür	Description
links	object	Bağlantıların salt okunur görünümü. Başvuru bağlantıları salt okunur olduğundan, bunları yalnızca salt okunur olarak göstermek istiyoruz.

ReleaseApproval

Name	Tür	Description
approvalType	ApprovalType	Onay türünü alır veya ayarlar.
approvedBy	IdentityRef	Onaylayan kimliği alır.
approver	IdentityRef	Onaylaması gereken kimliği alır veya ayarlar.
attempt	integer	Ait olduğu dağıtım girişimini belirten denemeyi alır veya ayarlar.
comments	string	Onay için açıklamaları alır veya ayarlar.
createdOn	string	Oluşturulduğu tarihi alır.
history	ReleaseApprovalHistory[]	Bu onayla ilişkili tüm onayları belirten geçmişi alır.
id	integer	Bu alanın benzersiz tanımlayıcısını alır.
isAutomated	boolean	Onay otomatikleştirilmiş veya değil olarak alır veya ayarlar.
modifiedOn	string	Değiştirildiği tarihi alır.
rank	integer	Onayın sırasını belirten dereceyi alır veya ayarlar. Örneğin, aynı derece paralel onayı belirtir.
release	ReleaseShallowReference	Bu onayın ilişkilendirildiği yayının başvurularını belirten releaseReference'ı alır.
releaseDefinition	ReleaseDefinitionShallowReference	Bu onayın ilişkilendirildiği yayın tanımının başvurularını belirten releaseDefinitionReference'ı alır.
releaseEnvironment	ReleaseEnvironmentShallowReference	Bu onayın ilişkilendirildiği yayın ortamının başvurularını belirten releaseEnvironmentReference alır.
revision	integer	Düzeltme numarasını alır.
status	ApprovalStatus	Onay durumunu alır veya ayarlar.
url	string	Onaya erişmek için URL'yi alır.

ReleaseApprovalHistory

Name	Tür	Description
approver	IdentityRef	Onaylayanın kimliği.
changedBy	IdentityRef	Onayını değiştiren nesnenin kimliği.
comments	string	Onay geçmişi açıklamaları.
createdOn	string	Bu onayın oluşturulduğu zaman.
modifiedOn	string	Bu onayın değiştirildiği zaman.
revision	integer	Onay geçmişi düzeltmesi.

ReleaseDefinitionShallowReference

Name	Tür	Description
_links	ReferenceLinks	Yayın tanımı için ilgili kaynaklara, API'lere ve görünümlere bağlantıları alır.
id	integer	Yayın tanımının benzersiz tanımlayıcısını alır.
name	string	Yayın tanımının adını alır veya ayarlar.
path	string	Yayın tanımının yolunu alır veya ayarlar.
projectReference	ProjectReference	Proje başvurularını alır veya ayarlar.
url	string	Yayın tanımına erişmek için REST API URL'sini alır.

ReleaseEnvironmentShallowReference

Name	Tür	Description
_links	ReferenceLinks	Yayın ortamı için ilgili kaynaklara, API'lere ve görünümlere yönelik bağlantıları alır.
id	integer	Yayın ortamının benzersiz tanımlayıcısını alır.
name	string	Yayın ortamının adını alır veya ayarlar.
url	string	Yayın ortamına erişmek için REST API URL'sini alır.

ReleaseShallowReference

Name	Tür	Description
_links	ReferenceLinks	Yayın için ilgili kaynaklara, API'lere ve görünümlere bağlantıları alır.
id	integer	Yayının benzersiz tanımlayıcısını alır.
name	string	Yayının adını alır veya ayarlar.
url	string	Yayına erişmek için REST API URL'sini alır.