Partager via

Refs - Update Ref

  • Référence
Service:
Git
Version d'API:
7.1

Verrouillez ou déverrouillez une branche.

PATCH https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/refs?filter={filter}&api-version=7.1
Avec des paramètres facultatifs: 
PATCH https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/refs?filter={filter}&projectId={projectId}&api-version=7.1

Paramètres URI

Nom Dans Obligatoire Type Description
organization
 path True

string

Nom de l’organisation Azure DevOps.
repositoryId
 path True

string

Nom ou ID du référentiel.
project
 path

string

ID de projet ou nom du projet
api-version
 query True

string

Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1 » pour utiliser cette version de l’API.
filter
 query True

string

Nom de la branche à verrouiller/déverrouiller
projectId
 query

string

ID ou nom du projet d’équipe. Facultatif si vous spécifiez un ID pour le référentiel.

Corps de la demande

Nom Type Description
isLocked

boolean

name

string

newObjectId

string

oldObjectId

string

repositoryId

string (uuid)

Réponses

Nom Type Description
200 OK

GitRef

opération réussie

Sécurité

oauth2

Type: oauth2
Flux: accessCode
URL d’autorisation: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL du jeton: 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

Étendues

Nom Description
vso.code_write Accorde la possibilité de lire, de mettre à jour et de supprimer du code source, d’accéder aux métadonnées relatives aux validations, aux ensembles de modifications, aux branches et à d’autres artefacts de contrôle de version. Accorde également la possibilité de créer et de gérer des demandes de tirage et des révisions de code et de recevoir des notifications sur les événements de contrôle de version via des hooks de service.

Exemples

Lock/unlock branch

Exemple de requête

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

{
  "isLocked": true
}

Exemple de réponse

Code d’état:
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"
}

Définitions

Nom Description
GitRef
GitRefUpdate
GitStatus

Cette classe contient les métadonnées d’un service/extension qui publie un état.
GitStatusContext

Contexte d’état qui identifie de manière unique l’état.
GitStatusState

État de l’état.
IdentityRef
ReferenceLinks

Classe à représenter une collection de liens de référence REST.

GitRef

Object
Nom Type Description
_links

ReferenceLinks

Classe à représenter une collection de liens de référence REST.
creator

IdentityRef

isLocked

boolean

isLockedBy

IdentityRef

name

string

objectId

string

peeledObjectId

string

statuses

GitStatus[]

Cette classe contient les métadonnées d’un service/extension qui publie un état.
url

string

GitRefUpdate

Object
Nom Type Description
isLocked

boolean

name

string

newObjectId

string

oldObjectId

string

repositoryId

string (uuid)

GitStatus

Object

Cette classe contient les métadonnées d’un service/extension qui publie un état.

Nom Type Description
_links

ReferenceLinks

Liens de référence.
context

GitStatusContext

Contexte de l’état.
createdBy

IdentityRef

Identité qui a créé l’état.
creationDate

string (date-time)

Date et heure de création de l’état.
description

string

Description de l’état. Décrit généralement l’état actuel de l’état.
id

integer (int32)

Identificateur d’état.
state

GitStatusState

État de l’état.
targetUrl

string

URL avec les détails de l’état.
updatedDate

string (date-time)

Date et heure de la dernière mise à jour de l’état.

GitStatusContext

Object

Contexte d’état qui identifie de manière unique l’état.

Nom Type Description
genre

string

Genre du statut. En règle générale, le nom du service/outil qui génère l’état peut être vide.
name

string

L’identificateur de nom de l’état ne peut pas être null ou vide.

GitStatusState

Énumération

État de l’état.

Valeur Description
error

État avec une erreur.
failed

Échec de l’état.
notApplicable

L’état n’est pas applicable à l’objet cible.
notSet

État non défini. État par défaut.
pending

État en attente.
succeeded

État réussi.

IdentityRef

Object
Nom Type Description
_links

ReferenceLinks

Ce champ contient zéro ou plus de liens intéressants sur le sujet du graphe. Ces liens peuvent être appelés pour obtenir des relations supplémentaires ou des informations plus détaillées sur ce sujet de graphique.
descriptor

string

Le descripteur est le principal moyen de référencer l’objet du graphique pendant l’exécution du système. Ce champ identifie de manière unique le même sujet de graphique sur les comptes et les organisations.
directoryAlias

string

Déconseillé : peut être récupéré en interrogeant l’utilisateur Graph référencé dans l’entrée « auto » du dictionnaire IdentityRef « _links »
displayName

string

Il s’agit du nom complet non unique de l’objet du graphique. Pour modifier ce champ, vous devez modifier sa valeur dans le fournisseur source.
id

string

imageUrl

string

Déconseillé - Disponible dans l’entrée « avatar » du dictionnaire IdentityRef « _links »
inactive

boolean

Déconseillé : peut être récupéré en interrogeant l’état d’appartenance Graph référencé dans l’entrée « membershipState » du dictionnaire GraphUser « _links »
isAadIdentity

boolean

Déconseillé : peut être déduit du type d’objet du descripteur (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer

boolean

Déconseillé : peut être déduit du type d’objet du descripteur (Descriptor.IsGroupType)
isDeletedInOrigin

boolean

profileUrl

string

Déconseillé : non utilisé dans la plupart des implémentations préexistantes de ToIdentityRef
uniqueName

string

Déconseillé : utiliser Domain+PrincipalName à la place
url

string

Cette URL est l’itinéraire complet vers la ressource source de ce sujet de graphe.
Object

Classe à représenter une collection de liens de référence REST.

Nom Type Description
links

object

Vue en lecture seule des liens. Étant donné que les liens de référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule.