Refs - Update Refs

Referenz

Dienst:: Git

API-Version:: 7.1

Erstellen, Aktualisieren oder Löschen von Refs(Branches).

Das Aktualisieren eines Bezugs bedeutet, dass er auf einen anderen Commit verweist als bei dem verwendeten Commit. Sie müssen sowohl den alten als auch den neuen Commit angeben, um Rennbedingungen zu vermeiden.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
organization	path	True	string	Der Name der Azure DevOps-Organisation.
repositoryId	path	True	string	Der Name oder die ID des Repositorys.
project	path		string	Projekt-ID oder Projektname
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "7.1" festgelegt werden, um diese Version der API zu verwenden.
projectId	query		string	ID oder Name des Teamprojekts. Optional, wenn Sie eine ID für das Repository angeben.

Anforderungstext

Name	Typ	Beschreibung
body	GitRefUpdate[]	Liste der Referenzaktualisierungen, die versucht werden sollen, auszuführen

Antworten

Name	Typ	Beschreibung
200 OK	GitRefUpdateResult[]	Erfolgreicher Vorgang

Sicherheit

oauth2

Typ: oauth2
Ablauf: accessCode
Autorisierungs-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

Bereiche

Name	Beschreibung
vso.code_write	Gewährt die Möglichkeit, Quellcode zu lesen, zu aktualisieren und zu löschen, auf Metadaten zu Commits, Änderungenets, Verzweigungen und anderen Versionssteuerungsartefakten zuzugreifen. Gewährt außerdem die Möglichkeit, Pullanforderungen und Codeüberprüfungen zu erstellen und zu verwalten und Benachrichtigungen über Versionssteuerungsereignisse über Dienst-Hooks zu erhalten.

Beispiele

Create/Update/Delete a ref by repositoryId

Beispielanforderung

HTTP

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

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

Beispiel für eine Antwort

Statuscode:: 200

transfer-Encoding: chunked

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

Definitionen

Name	Beschreibung
GitRefUpdate
GitRefUpdateResult
GitRefUpdateStatus	Status des Updates vom TFS-Server.

GitRefUpdate

Objekt

Name	Typ	Beschreibung
isLocked	boolean
name	string
newObjectId	string
oldObjectId	string
repositoryId	string (uuid)

GitRefUpdateResult