Refs - Update Ref

Odwołanie

Service:: Git

API Version:: 5.0

Zablokuj lub odblokuj gałąź.

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

With optional parameters:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
repositoryId	path	True	string	Nazwa lub identyfikator repozytorium.
project	path		string	Identyfikator projektu lub nazwa projektu
api-version	query	True	string	Wersja interfejsu API do użycia. Powinno to być ustawione na wartość "5.0", aby używać tej wersji interfejsu API.
filter	query	True	string	Nazwa gałęzi do blokowania/odblokowywania
projectId	query		string	Identyfikator lub nazwa projektu zespołowego. Opcjonalnie, jeśli określono identyfikator repozytorium.

Treść żądania

Nazwa	Typ	Opis
isLocked	boolean
name	string
newObjectId	string
oldObjectId	string
repositoryId	string

Odpowiedzi

Nazwa	Typ	Opis
200 OK	GitRef	operacja zakończona powodzeniem

Zabezpieczenia

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

Nazwa	Opis
vso.code_write	Umożliwia odczytywanie, aktualizowanie i usuwanie kodu źródłowego, uzyskiwanie dostępu do metadanych dotyczących zatwierdzeń, zestawów zmian, gałęzi i innych artefaktów kontroli wersji. Umożliwia również tworzenie żądań ściągnięcia i przeglądów kodu oraz zarządzanie nimi oraz odbieranie powiadomień o zdarzeniach kontroli wersji za pośrednictwem punktów zaczepienia usługi.

Nazwa

Opis

vso.code_write

Umożliwia odczytywanie, aktualizowanie i usuwanie kodu źródłowego, uzyskiwanie dostępu do metadanych dotyczących zatwierdzeń, zestawów zmian, gałęzi i innych artefaktów kontroli wersji. Umożliwia również tworzenie żądań ściągnięcia i przeglądów kodu oraz zarządzanie nimi oraz odbieranie powiadomień o zdarzeniach kontroli wersji za pośrednictwem punktów zaczepienia usługi.

Przykłady

Lock/unlock branch

Sample Request

HTTP

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

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

Definicje

Nazwa	Opis
GitRef
GitRefUpdate
GitStatus	Ta klasa zawiera metadane usługi/rozszerzenia publikujące stan.
GitStatusContext	Kontekst stanu, który jednoznacznie identyfikuje stan.
GitStatusState	Stan stanu.
IdentityRef
ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.

GitRef

Nazwa	Typ	Opis
_links	ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
creator	IdentityRef
isLocked	boolean
isLockedBy	IdentityRef
name	string
objectId	string
peeledObjectId	string
statuses	GitStatus[]	Ta klasa zawiera metadane usługi/rozszerzenia publikujące stan.
url	string

GitRefUpdate

Nazwa	Typ	Opis
isLocked	boolean
name	string
newObjectId	string
oldObjectId	string
repositoryId	string

GitStatus

Ta klasa zawiera metadane usługi/rozszerzenia publikujące stan.

Nazwa	Typ	Opis
_links	ReferenceLinks	Linki referencyjne.
context	GitStatusContext	Kontekst stanu.
createdBy	IdentityRef	Tożsamość, która utworzyła stan.
creationDate	string	Data i godzina utworzenia stanu.
description	string	Opis stanu. Zazwyczaj opisuje bieżący stan stanu.
id	integer	Identyfikator stanu.
state	GitStatusState	Stan stanu.
targetUrl	string	Adres URL ze szczegółami stanu.
updatedDate	string	Data i godzina ostatniej aktualizacji stanu.

GitStatusContext

Kontekst stanu, który jednoznacznie identyfikuje stan.

Nazwa	Typ	Opis
genre	string	Gatunek stanu. Zazwyczaj nazwa usługi/narzędzia generującego stan może być pusta.
name	string	Identyfikator nazwy stanu nie może mieć wartości null ani być pusty.

GitStatusState

Stan stanu.

Nazwa	Typ	Opis
error	string	Stan z błędem.
failed	string	Stan nie powiodło się.
notApplicable	string	Stan nie ma zastosowania do obiektu docelowego.
notSet	string	Stan nie jest ustawiony. Stan domyślny.
pending	string	Stan oczekujący.
succeeded	string	Stan zakończył się pomyślnie.

IdentityRef

Nazwa	Typ	Opis
_links	ReferenceLinks	To pole zawiera zero lub więcej interesujących linków dotyczących tematu grafu. Te linki mogą być wywoływane w celu uzyskania dodatkowych relacji lub bardziej szczegółowych informacji na temat tego tematu grafu.
descriptor	string	Deskryptor jest podstawowym sposobem odwołowania się do tematu grafu podczas działania systemu. To pole będzie jednoznacznie identyfikować ten sam temat grafu zarówno w ramach kont, jak i organizacji.
directoryAlias	string
displayName	string	Jest to unikatowa nazwa wyświetlana tematu grafu. Aby zmienić to pole, musisz zmienić jego wartość u dostawcy źródłowego.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Ten adres URL jest pełną trasą do zasobu źródłowego tego tematu grafu.

ReferenceLinks

Klasa reprezentująca kolekcję linków referencyjnych REST.

Nazwa	Typ	Opis
links	object	Czytelny widok linków. Ponieważ linki referencyjne są czytelne, chcemy uwidocznić je tylko jako tylko do odczytu.

Udostępnij za pośrednictwem