Refs - Update Ref

Referencia

Service:: Git

API Version:: 5.0

Bloquear o desbloquear una rama.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
organization	path	True	string	El nombre de la organización de Azure DevOps.
repositoryId	path	True	string	Nombre o identificador del repositorio.
project	path		string	Id. de proyecto o nombre del proyecto
api-version	query	True	string	Versión de la API que se va a usar. Debe establecerse en "5.0" para usar esta versión de la API.
filter	query	True	string	Nombre de la rama que se va a bloquear o desbloquear
projectId	query		string	Identificador o nombre del proyecto de equipo. Opcional si especifica un identificador para el repositorio.

Cuerpo de la solicitud

Nombre	Tipo	Description
isLocked	boolean
name	string
newObjectId	string
oldObjectId	string
repositoryId	string

Respuestas

Nombre	Tipo	Description
200 OK	GitRef	operación correcta

Seguridad

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

Nombre	Description
vso.code_write	Concede la capacidad de leer, actualizar y eliminar código fuente, acceder a metadatos sobre confirmaciones, conjuntos de cambios, ramas y otros artefactos de control de versiones. También concede la capacidad de crear y administrar solicitudes de incorporación de cambios y revisiones de código y recibir notificaciones sobre eventos de control de versiones a través de enlaces de servicio.

Ejemplos

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

Definiciones

Nombre	Description
GitRef
GitRefUpdate
GitStatus	Esta clase contiene los metadatos de un servicio o extensión que publica un estado.
GitStatusContext	Contexto de estado que identifica de forma única el estado.
GitStatusState	Estado del estado.
IdentityRef
ReferenceLinks	Clase que se va a representar una colección de vínculos de referencia de REST.

GitRef

Nombre	Tipo	Description
_links	ReferenceLinks	Clase que se va a representar una colección de vínculos de referencia de REST.
creator	IdentityRef
isLocked	boolean
isLockedBy	IdentityRef
name	string
objectId	string
peeledObjectId	string
statuses	GitStatus[]	Esta clase contiene los metadatos de un servicio o extensión que publica un estado.
url	string

GitRefUpdate

Nombre	Tipo	Description
isLocked	boolean
name	string
newObjectId	string
oldObjectId	string
repositoryId	string

GitStatus

Esta clase contiene los metadatos de un servicio o extensión que publica un estado.

Nombre	Tipo	Description
_links	ReferenceLinks	Vínculos de referencia.
context	GitStatusContext	Contexto del estado.
createdBy	IdentityRef	Identidad que creó el estado.
creationDate	string	Fecha y hora de creación del estado.
description	string	Descripción del estado. Normalmente se describe el estado actual del estado.
id	integer	Identificador de estado.
state	GitStatusState	Estado del estado.
targetUrl	string	Dirección URL con detalles de estado.
updatedDate	string	Fecha y hora de la última actualización del estado.

GitStatusContext

Contexto de estado que identifica de forma única el estado.

Nombre	Tipo	Description
genre	string	Género del estado. Normalmente, el nombre del servicio o herramienta que genera el estado puede estar vacío.
name	string	El identificador de nombre del estado no puede ser nulo ni estar vacío.

GitStatusState

Estado del estado.

Nombre	Tipo	Description
error	string	Estado con un error.
failed	string	Error de estado.
notApplicable	string	El estado no es aplicable al objeto de destino.
notSet	string	Estado de estado no establecido. Estado predeterminado.
pending	string	Estado pendiente.
succeeded	string	El estado se realizó correctamente.

IdentityRef

Nombre	Tipo	Description
_links	ReferenceLinks	Este campo contiene cero o más vínculos interesantes sobre el tema del grafo. Estos vínculos se pueden invocar para obtener relaciones adicionales o información más detallada sobre este tema del grafo.
descriptor	string	El descriptor es la forma principal de hacer referencia al asunto del grafo mientras se ejecuta el sistema. Este campo identificará de forma única el mismo asunto del grafo en cuentas y organizaciones.
directoryAlias	string
displayName	string	Este es el nombre para mostrar no único del asunto del grafo. Para cambiar este campo, debe modificar su valor en el proveedor de origen.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Esta dirección URL es la ruta completa al recurso de origen de este tema del grafo.

ReferenceLinks

Clase que se va a representar una colección de vínculos de referencia de REST.

Nombre	Tipo	Description
links	object	Vista de lectura de los vínculos. Dado que los vínculos de referencia son de solo lectura, solo queremos exponerlos como de solo lectura.

Compartir a través de