Refs - Update Ref

Başvuru

Service:: Git

API Version:: 7.1-preview.1

Dalı kilitleme veya kilidini açma.

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

With optional parameters:

PATCH https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/refs?filter={filter}&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 sürümü. Api'nin bu sürümünü kullanmak için bu değer '7.1-preview.1' olarak ayarlanmalıdır.
filter	query	True	string	Kilitlenmek/kilidini açmak için dalın adı
projectId	query		string	Takım projesinin kimliği veya adı. Depo için kimlik belirtilmesi durumunda isteğe bağlı.

İstek Gövdesi

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

Yanıtlar

Name	Tür	Description
200 OK	GitRef	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

Lock/unlock branch

Sample Request

HTTP

PATCH https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/refs?filter=heads/master&api-version=7.1-preview.1

{
  "isLocked": true
}

Sample Response

Status code:: 200

{
  "name": "refs/heads/master",
  "objectId": "ffe9cba521f00d7f60e322845072238635edb451",
  "isLockedBy": {
    "displayName": "Normal Paulk",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
      }
    },
    "id": "ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
    "uniqueName": "dev@mailserver.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
    "descriptor": "aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
  },
  "isLocked": true,
  "creator": {
    "displayName": "Normal Paulk",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
      }
    },
    "id": "ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
    "uniqueName": "dev@mailserver.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
    "descriptor": "aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
  },
  "url": "https://dev.azure.com/fabrikam/7484f783-66a3-4f27-b7cd-6b08b0b077ed/_apis/git/repositories/d3d1760b-311c-4175-a726-20dfc6a7f885/refs?filter=heads%2Fmaster"
}

Tanımlar

Name	Description
GitRef
GitRefUpdate
GitStatus	Bu sınıf, durum gönderen bir hizmetin/uzantının meta verilerini içerir.
GitStatusContext	Durumu benzersiz olarak tanımlayan durum bağlamı.
GitStatusState	Durumun durumu.
IdentityRef
ReferenceLinks	REST başvuru bağlantıları koleksiyonunu temsil eden sınıf.

GitRef

Name	Tür	Description
_links	ReferenceLinks	REST başvuru bağlantıları koleksiyonunu temsil eden sınıf.
creator	IdentityRef
isLocked	boolean
isLockedBy	IdentityRef
name	string
objectId	string
peeledObjectId	string
statuses	GitStatus[]	Bu sınıf, durum gönderen bir hizmetin/uzantının meta verilerini içerir.
url	string

GitRefUpdate

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

GitStatus

Bu sınıf, durum gönderen bir hizmetin/uzantının meta verilerini içerir.

Name	Tür	Description
_links	ReferenceLinks	Başvuru bağlantıları.
context	GitStatusContext	Durumun bağlamı.
createdBy	IdentityRef	Durumu oluşturan kimlik.
creationDate	string	Durumun oluşturulma tarihi ve saati.
description	string	Durum açıklaması. Genellikle durumun geçerli durumunu açıklar.
id	integer	Durum tanımlayıcısı.
state	GitStatusState	Durumun durumu.
targetUrl	string	Durum ayrıntılarını içeren URL.
updatedDate	string	Durumun son güncelleştirme tarihi ve saati.

GitStatusContext

Durumu benzersiz olarak tanımlayan durum bağlamı.

Name	Tür	Description
genre	string	Durumun türü. Genellikle durumu oluşturan hizmetin/aracın adı boş olabilir.
name	string	Durumun ad tanımlayıcısı null veya boş olamaz.

GitStatusState

Durumun durumu.

Name	Tür	Description
error	string	Hata içeren durum.
failed	string	Durum başarısız oldu.
notApplicable	string	Durum hedef nesne için geçerli değil.
notSet	string	Durum durumu ayarlanmadı. Varsayılan durum.
pending	string	Durum bekleniyor.
succeeded	string	Durum başarılı oldu.

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.

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.

Aracılığıyla paylaş