Refs - Update Refs

Başvuru

Service:: Git

API Version:: 7.1-preview.1

Refs(dallar) oluşturma, güncelleştirme veya silme.

Ref'i güncelleştirmek, bunu eskisinden farklı bir işlemeye işaret etmek anlamına gelir. Yarış koşullarından kaçınmak için hem eski hem de yeni işlemeyi belirtmeniz gerekir.

POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/refs?api-version=7.1-preview.1

With optional parameters:

POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/refs?projectId={projectId}&api-version=7.1-preview.1

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
organization	path	True	string	Azure DevOps kuruluşunun adı.
repositoryId	path	True	string	Deponun adı veya kimliği.
project	path		string	Proje Kimliği veya proje adı
api-version	query	True	string	Kullanılacak API'nin sürümü. Bu, api'nin bu sürümünü kullanmak için '7.1-preview.1' olarak ayarlanmalıdır.
projectId	query		string	Takım projesinin kimliği veya adı. Depo için bir kimlik belirtilmesi durumunda isteğe bağlı.

İstek Gövdesi

Name	Tür	Description
body	GitRefUpdate[]	Gerçekleştirmeye çalışacak başvuru güncelleştirmelerinin listesi

Yanıtlar

Name	Tür	Description
200 OK	GitRefUpdateResult[]	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.code_write	Kaynak kodu okuma, güncelleştirme ve silme, işlemeler, değişiklik kümeleri, dallar ve diğer sürüm denetimi yapıtları hakkındaki meta verilere erişme olanağı verir. Ayrıca çekme istekleri ve kod incelemeleri oluşturup yönetme ve hizmet kancaları aracılığıyla sürüm denetimi olayları hakkında bildirim alma olanağı sağlar.

Örnekler

Create/Update/Delete a ref by repositoryId

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/refs?api-version=7.1-preview.1

[
  {
    "name": "refs/heads/vsts-api-sample/answer-woman-flame",
    "oldObjectId": "0000000000000000000000000000000000000000",
    "newObjectId": "ffe9cba521f00d7f60e322845072238635edb451"
  }
]

Sample Response

Status code:: 200

transfer-Encoding: chunked

Response Body

{
  "value": [
    {
      "repositoryId": "d3d1760b-311c-4175-a726-20dfc6a7f885",
      "name": "refs/heads/vsts-api-sample/answer-woman-flame",
      "oldObjectId": "0000000000000000000000000000000000000000",
      "newObjectId": "ffe9cba521f00d7f60e322845072238635edb451",
      "isLocked": false,
      "updateStatus": "succeeded",
      "success": true
    }
  ],
  "count": 1
}

Tanımlar

Name	Description
GitRefUpdate
GitRefUpdateResult
GitRefUpdateStatus	TFS sunucusundan güncelleştirmenin durumu.

GitRefUpdate

Name	Tür	Description
isLocked	boolean
name	string
newObjectId	string
oldObjectId	string
repositoryId	string

GitRefUpdateResult

Name	Tür	Description
customMessage	string	Sonuç nesnesi için özel ileti Örneğin, Başarısız olma nedeni.
isLocked	boolean	Başvurunun kilitli olup olmadığı
name	string	Başvuru adı
newObjectId	string	Yeni nesne kimliği
oldObjectId	string	Eski nesne kimliği
rejectedBy	string	Güncelleştirilen eklentiyi reddeden eklentinin adı.
repositoryId	string	Depo Kimliği
success	boolean	Başvuru güncelleştirmesi başarılı olduysa True, aksi takdirde false
updateStatus	GitRefUpdateStatus	TFS sunucusundan güncelleştirmenin durumu.

GitRefUpdateStatus

TFS sunucusundan güncelleştirmenin durumu.

Name	Tür	Description
createBranchPermissionRequired	string	Kullanıcı dal oluşturma iznine sahip olmadığından başvuru güncelleştirme isteği tamamlanamadı
createTagPermissionRequired	string	Kullanıcı etiket oluşturma iznine sahip olmadığından başvuru güncelleştirme isteği tamamlanamadı
forcePushRequired	string	Grafın bir bölümü bu değişiklikle kesileceğinden ve çağıranın depoda ForcePush izni olmadığından başvuru güncelleştirme isteğinin tamamlanamadığından emin olunamadığını gösterir.
invalidRefName	string	İstekte sunulan başvuru adı geçerli olmadığından başvuru güncelleştirme isteğinin tamamlanamadığından emin olunamadığını gösterir.
locked	string	Başvuru başka bir kullanıcı tarafından kilitlendiğinden başvuru güncelleştirmesi tamamlanamadı.
manageNotePermissionRequired	string	Kullanıcı bu notu yazmak için gereken not oluşturma izinlerine sahip olmadığından başvuru güncelleştirme isteği tamamlanamadı
refNameConflict	string	Başv güncelleştirmesi tamamlanamadı çünkü büyük/küçük harfe duyarlı olmayan modda başv adı mevcut, farklı büyük/küçük harfe sahip bir başvuru adıyla çakılabilir.
rejectedByPlugin	string	Başvuru güncelleştirmesi eklenti tarafından reddedildiği için tamamlanamadı.
rejectedByPolicy	string	başvuru güncelleştirmesi, ilke tarafından reddedildiği için tamamlanamadı.
staleOldObjectId	string	İstekte sunulan eski nesne kimliği, veritabanı güncelleştirmeyi denediğinde başvurunun nesne kimliği olmadığından, başvuru güncelleştirme isteğinin tamamlanamadığnı gösterir. En olası senaryo, çağıranın başvuruyu güncelleştirmek için bir yarışı kaybetmesidir.
succeeded	string	Başvuru güncelleştirme isteğinin başarıyla tamamlandığını gösterir.
succeededCorruptRef	string	Başvuru güncelleştirme isteğinin başarıyla tamamlandığını, ancak geçirilen başvurunun bozuk olduğunu gösterir. Örneğin, eski nesne kimliği hatalıydı. Bu yalnızca silme işlemleri sırasında gerçekleşmelidir.
succeededNonExistentRef	string	Başvuru güncelleştirme isteğinin başarıyla tamamlandığını, ancak başvurunun gerçekten mevcut olmadığını, dolayısıyla hiçbir değişiklik yapılmadığını gösterir. Bu yalnızca silme işlemleri sırasında gerçekleşmelidir.
unprocessed	string	İstek işlenmedi
unresolvableToCommit	string	Başv için yeni nesne kimliği bir işleme nesnesine çözümlenemediğinden (büyük olasılıkla herhangi bir sayıda etiket aracılığıyla) başvuru güncelleştirme isteği tamamlanamadı
writePermissionRequired	string	Kullanıcı bu başvuruyu yazmak için gereken yazma izinlerine sahip olmadığından başvuru güncelleştirme isteği tamamlanamadı

Aracılığıyla paylaş