Refs - Update Ref

Referência

Serviço:: Git

Versão da API:: 7.1

Bloquear ou desbloquear um branch.

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

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
organization	path	True	string	O nome da organização do Azure DevOps.
repositoryId	path	True	string	O nome ou a ID do repositório.
project	path		string	ID do projeto ou nome do projeto
api-version	query	True	string	Versão da API a ser usada. Isso deve ser definido como '7.1' para usar essa versão da api.
filter	query	True	string	O nome do branch a ser bloqueado/desbloqueado
projectId	query		string	ID ou nome do projeto de equipe. Opcional se especificar uma ID para o repositório.

Corpo da solicitação

Nome	Tipo	Description
isLocked	boolean
name	string
newObjectId	string
oldObjectId	string
repositoryId	string (uuid)

Respostas

Nome	Tipo	Description
200 OK	GitRef	operação bem-sucedida

Segurança

oauth2

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL do Token: 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

Escopos

Nome	Description
vso.code_write	Concede a capacidade de ler, atualizar e excluir código-fonte, acessar metadados sobre confirmações, conjuntos de alterações, branches e outros artefatos de controle de versão. Também concede a capacidade de criar e gerenciar solicitações de pull e revisões de código e receber notificações sobre eventos de controle de versão por meio de ganchos de serviço.

Exemplos

Lock/unlock branch

Solicitação de exemplo

HTTP

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

{
  "isLocked": true
}

Resposta de exemplo

Código de status:: 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"
}

Definições

Nome	Description
GitRef
GitRefUpdate
GitStatus	Essa classe contém os metadados de um serviço/extensão postando um status.
GitStatusContext	Contexto de status que identifica exclusivamente o status.
GitStatusState	Estado do status.
IdentityRef
ReferenceLinks	A classe para representar uma coleção de links de referência REST.

GitRef

Objeto

Nome	Tipo	Description
_links	ReferenceLinks	A classe para representar uma coleção de links de referência REST.
creator	IdentityRef
isLocked	boolean
isLockedBy	IdentityRef
name	string
objectId	string
peeledObjectId	string
statuses	GitStatus[]	Essa classe contém os metadados de um serviço/extensão postando um status.
url	string

GitRefUpdate

Objeto

Nome	Tipo	Description
isLocked	boolean
name	string
newObjectId	string
oldObjectId	string
repositoryId	string (uuid)

GitStatus

Objeto

Essa classe contém os metadados de um serviço/extensão postando um status.

Nome	Tipo	Description
_links	ReferenceLinks	Links de referência.
context	GitStatusContext	Contexto do status.
createdBy	IdentityRef	Identidade que criou o status.
creationDate	string (date-time)	Data e hora de criação do status.
description	string	Descrição do status. Normalmente descreve o estado atual do status.
id	integer (int32)	Identificador de status.
state	GitStatusState	Estado do status.
targetUrl	string	URL com detalhes de status.
updatedDate	string (date-time)	Data e hora da última atualização do status.

GitStatusContext

Objeto

Contexto de status que identifica exclusivamente o status.

Nome	Tipo	Description
genre	string	Gênero do status. Normalmente, o nome do serviço/ferramenta que gera o status pode estar vazio.
name	string	O identificador de nome do status não pode ser nulo ou vazio.

GitStatusState

Enumeração

Estado do status.

Valor	Description
error	Status com um erro.
failed	Falha no status.
notApplicable	O status não é aplicável ao objeto de destino.
notSet	Estado de status não definido. Estado padrão.
pending	Status pendente.
succeeded	Status bem-sucedido.

IdentityRef

Objeto

Nome	Tipo	Description
_links	ReferenceLinks	Este campo contém zero ou mais links interessantes sobre o assunto do grafo. Esses links podem ser invocados para obter relações adicionais ou informações mais detalhadas sobre esse assunto do grafo.
descriptor	string	O descritor é a principal maneira de referenciar o assunto do grafo enquanto o sistema está em execução. Esse campo identificará exclusivamente o mesmo assunto de grafo em contas e organizações.
directoryAlias	string	Preterido – pode ser recuperado consultando o usuário do Graph referenciado na entrada "self" do dicionário "_links" identityRef
displayName	string	Esse é o nome de exibição não exclusivo do assunto do grafo. Para alterar esse campo, você deve alterar seu valor no provedor de origem.
id	string
imageUrl	string	Preterido – Disponível na entrada "avatar" do dicionário "_links" do IdentityRef
inactive	boolean	Preterido – pode ser recuperado consultando o estado de associação do Graph referenciado na entrada "membershipState" do dicionário "_links" do GraphUser
isAadIdentity	boolean	Preterido – pode ser adiado do tipo de assunto do descritor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Preterido – pode ser inferido do tipo de assunto do descritor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Preterido - não em uso na maioria das implementações pré-existentes de ToIdentityRef
uniqueName	string	Preterido – use Domain+PrincipalName em vez disso
url	string	Essa URL é a rota completa para o recurso de origem desta entidade de grafo.

ReferenceLinks

Objeto

A classe para representar uma coleção de links de referência REST.

Nome	Tipo	Description
links	object	A exibição somente leitura dos links. Como os links de referência são somente leitura, só queremos expô-los como somente leitura.

Partilhar via

Refs - Update Ref

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

oauth2

Escopos

Exemplos

Lock/unlock branch

Solicitação de exemplo

Resposta de exemplo

Definições

GitRef

GitRefUpdate

GitStatus

GitStatusContext

GitStatusState

IdentityRef

ReferenceLinks