Refs - Update Ref

Reference

Service:: Git

API Version:: 7.1-preview.1

Uzamčení nebo odemknutí větve

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
organization	path	True	string	Název organizace Azure DevOps.
repositoryId	path	True	string	Název nebo ID úložiště.
project	path		string	ID projektu nebo název projektu
api-version	query	True	string	Verze rozhraní API, která se má použít. Tato verze rozhraní API by měla být nastavená na 7.1-preview.1.
filter	query	True	string	Název větve, která se má uzamknout nebo odemknout
projectId	query		string	ID nebo název týmového projektu. Volitelné, pokud zadáte ID úložiště.

Text požadavku

Name	Typ	Description
isLocked	boolean
name	string
newObjectId	string
oldObjectId	string
repositoryId	string

Odpovědi

Name	Typ	Description
200 OK	GitRef	úspěšná operace

Zabezpečení

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	Uděluje možnost číst, aktualizovat a odstraňovat zdrojový kód a přistupovat k metadatům o potvrzeních, sadách změn, větvích a dalších artefaktech správy verzí. Poskytuje také možnost vytvářet a spravovat žádosti o přijetí změn a revize kódu a přijímat oznámení o událostech správy verzí prostřednictvím volání služeb.

Příklady

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

Definice

Name	Description
GitRef
GitRefUpdate
GitStatus	Tato třída obsahuje metadata služby nebo rozšíření, které zveřejňuje stav.
GitStatusContext	Kontext stavu, který jednoznačně identifikuje stav.
GitStatusState	Stav stavu.
IdentityRef
ReferenceLinks	Třída představující kolekci odkazů REST.

GitRef

Name	Typ	Description
_links	ReferenceLinks	Třída představující kolekci odkazů REST.
creator	IdentityRef
isLocked	boolean
isLockedBy	IdentityRef
name	string
objectId	string
peeledObjectId	string
statuses	GitStatus[]	Tato třída obsahuje metadata služby nebo rozšíření, které zveřejňuje stav.
url	string

GitRefUpdate

Name	Typ	Description
isLocked	boolean
name	string
newObjectId	string
oldObjectId	string
repositoryId	string

GitStatus

Tato třída obsahuje metadata služby nebo rozšíření, které zveřejňuje stav.

Name	Typ	Description
_links	ReferenceLinks	Odkazy.
context	GitStatusContext	Kontext stavu
createdBy	IdentityRef	Identita, která vytvořila stav.
creationDate	string	Datum a čas vytvoření stavu.
description	string	Popis stavu. Obvykle popisuje aktuální stav stavu.
id	integer	Identifikátor stavu.
state	GitStatusState	Stav stavu.
targetUrl	string	Adresa URL s podrobnostmi o stavu
updatedDate	string	Datum a čas poslední aktualizace stavu.

GitStatusContext

Kontext stavu, který jednoznačně identifikuje stav.

Name	Typ	Description
genre	string	Žánr stavu. Název služby nebo nástroje, který generuje stav, může být obvykle prázdný.
name	string	Identifikátor názvu stavu nesmí být null ani prázdný.

GitStatusState

Stav stavu.

Name	Typ	Description
error	string	Stav s chybou
failed	string	Stav se nezdařil.
notApplicable	string	Stav se nevztahuje na cílový objekt.
notSet	string	Stav není nastavený. Výchozí stav.
pending	string	Stav čeká na vyřízení.
succeeded	string	Stav byl úspěšný.

IdentityRef

Name	Typ	Description
_links	ReferenceLinks	Toto pole neobsahuje žádný nebo více zajímavých odkazů na téma grafu. Tyto odkazy mohou být vyvolány za účelem získání dalších relací nebo podrobnějších informací o tomto předmětu grafu.
descriptor	string	Popisovač je primárním způsobem, jak odkazovat na předmět grafu, když je systém spuštěný. Toto pole jednoznačně identifikuje stejný předmět grafu v rámci účtů i organizací.
directoryAlias	string	Zastaralé – Dá se načíst dotazem na uživatele Graphu odkazovaného v položce "self" slovníku IdentityRef "_links"
displayName	string	Toto je jedinečný zobrazovaný název předmětu grafu. Pokud chcete toto pole změnit, musíte změnit jeho hodnotu ve zdrojovém poskytovateli.
id	string
imageUrl	string	Zastaralé – k dispozici v položce "avatar" ve slovníku IdentityRef "_links"
inactive	boolean	Zastaralé – Můžete ho načíst dotazem na stav členství v Graphu, na který odkazuje položka membershipState slovníku _links GraphUser.
isAadIdentity	boolean	Zastaralé – lze odvodit z typu předmětu popisovače (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Zastaralé – Lze odvodit z typu předmětu popisovače (Descriptor.IsGroupType).
isDeletedInOrigin	boolean
profileUrl	string	Zastaralé – nepoužívá se ve většině dříve existujících implementací ToIdentityRef
uniqueName	string	Zastaralé – místo toho použijte Domain+PrincipalName.
url	string	Tato adresa URL představuje úplnou trasu ke zdrojovému prostředku tohoto předmětu grafu.

ReferenceLinks

Třída představující kolekci odkazů REST.

Name	Typ	Description
links	object	Zobrazení odkazů jen pro čtení. Vzhledem k tomu, že odkazy jsou jen pro čtení, chceme je zveřejnit jenom jako odkazy jen pro čtení.

Sdílet prostřednictvím