Git - Update From Git

Serviço:
Core
Versão da API:
v1

Atualiza o espaço de trabalho com confirmações enviadas por push para a ramificação conectada.
Esta API suporta operações de longa duração (LRO).

Para usar essa API, as credenciais do Git do chamador devem ser configuradas usando Update My Git Credentials API. Você pode usar a API Get My Git Credentials para verificar a configuração das credenciais do Git.

A atualização afeta apenas os itens no espaço de trabalho que foram alterados nessas confirmações. Se chamado após as APIs Conectar e Inicializar Conexão , ele executará uma atualização completa de todo o espaço de trabalho.

Permissões

O chamador deve ter uma função de de espaço de trabalho de contribuidor ou superior.

Escopos delegados necessários

Workspace.GitUpdate.All

Identidades suportadas pelo Microsoft Entra

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identidade Apoio
Utilizador Sim
Entidade de serviço e identidades geridas Suportado apenas quando todos os itens envolvidos na operação suportam entidades de serviço

Interfaz

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/updateFromGit

Parâmetros do URI

Nome Em Obrigatório Tipo Descrição
workspaceId
 path True

string (uuid)

O ID do espaço de trabalho.

Corpo do Pedido

Nome Obrigatório Tipo Descrição
remoteCommitHash True

string

Hash de confirmação SHA completo remoto.
conflictResolution

WorkspaceConflictResolution

Resolução de conflitos a ser usada na atualização da operação Git. Se os itens estiverem em conflito e uma resolução de conflito não for especificada, a operação de atualização não será iniciada.
options

UpdateOptions

Opções a serem usadas na atualização da operação Git
workspaceHead

string

Hash SHA completo com o qual o espaço de trabalho está sincronizado. Esse valor pode ser nulo somente após Initialize Connection. Em outros casos, o sistema validará se o valor dado está alinhado com a cabeça conhecida pelo sistema.

Respostas

Nome Tipo Descrição
200 OK

Pedido concluído com sucesso.
202 Accepted

Solicitação aceita, atualização do Git em andamento.

Cabeçalhos

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
429 Too Many Requests

ErrorResponse

O limite de tarifa de serviço foi ultrapassado. O servidor devolve um Retry-After cabeçalho que indica, em segundos, quanto tempo o cliente deve esperar antes de enviar pedidos adicionais.

Cabeçalhos

Retry-After: integer
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • WorkspaceNotConnectedToGit - O espaço de trabalho não está conectado ao git.

  • WorkspaceHasNoCapacityAssigned - Nenhuma capacidade atribuída ao espaço de trabalho.

  • WorkspaceHeadMismatch - O cabeçalho na solicitação não corresponde ao cabeçalho no sistema.

  • WorkspacePreviousOperationInProgress - A operação anterior ainda está em andamento.

  • MissingDependency - Uma dependência está faltando na operação de atualização.

  • PotentialDuplicateDisplayNameAndType - A operação de atualização criará um nome e um tipo de exibição duplicados.

  • DependencyDeletionFailed - A operação de atualização excluirá a dependência rígida.

  • InsufficientPrivileges - O chamador não tem permissões de espaço de trabalho suficientes.

  • PrincipalTypeNotSupported - O tipo de identidade do chamador não é suportado.

Exemplos

Update a workspace from Git with options example
Update a workspace using data from a Git example

Update a workspace from Git with options example

Pedido de amostra

POST https://api.fabric.microsoft.com/v1/workspaces/1565e6a3-c020-4c0c-dda7-92bafe99eec5/git/updateFromGit

{
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705",
  "conflictResolution": {
    "conflictResolutionType": "Workspace",
    "conflictResolutionPolicy": "PreferWorkspace"
  },
  "options": {
    "allowOverrideItems": true,
    "itemOptionsByLogicalId": [
      {
        "logicalId": "88436e65-6ed1-8185-49ff-f61077fc73d4",
        "options": {
          "validateOnly": true
        }
      }
    ]
  }
}

Resposta da amostra

Código de estado:
200
Código de estado:
202 
Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Update a workspace using data from a Git example

Pedido de amostra

POST https://api.fabric.microsoft.com/v1/workspaces/1565e6a3-c020-4c0c-dda7-92bafe99eec5/git/updateFromGit

{
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705",
  "conflictResolution": {
    "conflictResolutionType": "Workspace",
    "conflictResolutionPolicy": "PreferWorkspace"
  },
  "options": {
    "allowOverrideItems": true
  }
}

Resposta da amostra

Código de estado:
200
Código de estado:
202 
Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Definições

Nome Descrição
ConflictResolutionPolicy

Política de resolução de conflitos. Políticas adicionais de resolução de conflitos podem ser adicionadas ao longo do tempo.
ConflictResolutionType

Tipo de resolução de conflitos. Tipos adicionais de resolução de conflitos podem ser adicionados ao longo do tempo.
ErrorParameter

Um parâmetro estruturado que fornece contexto adicional legível por máquina sobre um erro.
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
ItemOptionsByLogicalIdEntry

Uma entrada de opções por item que direciona o seu item por ID lógico. Cada item alvo pode aparecer no máximo uma vez.
UpdateFromGitRequest

Contém a atualização dos dados de solicitação do Git.
UpdateOptions

Contém as opções habilitadas para a atualização do Git.
WorkspaceConflictResolution

Os dados básicos de resolução de conflitos.

ConflictResolutionPolicy

Enumeração

Política de resolução de conflitos. Políticas adicionais de resolução de conflitos podem ser adicionadas ao longo do tempo.

Valor Descrição
PreferRemote

Prefira conteúdo remoto do lado Git.
PreferWorkspace

Prefira o conteúdo do lado do espaço de trabalho.

ConflictResolutionType

Enumeração

Tipo de resolução de conflitos. Tipos adicionais de resolução de conflitos podem ser adicionados ao longo do tempo.

Valor Descrição
Workspace

Resolução de conflitos que representa o nível do espaço de trabalho.

ErrorParameter

Object

Um parâmetro estruturado que fornece contexto adicional legível por máquina sobre um erro.

Nome Tipo Descrição
message

string

Uma descrição legível para humanos do significado do parâmetro.
name

string

O identificador de parâmetro.
value

string

O valor do parâmetro.

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Nome Tipo Descrição
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Nome Tipo Descrição
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
isRetriable

boolean

Quando confirmado, o pedido pode ser retentado. Use o Retry-After cabeçalho de resposta para determinar o atraso, se disponível.
message

string

Uma representação legível por humanos do erro.
moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
parameters

ErrorParameter[]

Parâmetros estruturados que fornecem contexto adicional legível pela máquina sobre o erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.
requestId

string (uuid)

ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Nome Tipo Descrição
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
parameters

ErrorParameter[]

Parâmetros estruturados que fornecem contexto adicional legível pela máquina sobre o erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.

ItemOptionsByLogicalIdEntry

Object

Uma entrada de opções por item que direciona o seu item por ID lógico. Cada item alvo pode aparecer no máximo uma vez.

Nome Tipo Descrição
logicalId

string (uuid)

O ID lógico do item-alvo.
options

object

As opções para o item alvo. Os nomes das propriedades são nomes de opções válidos para o tipo de item; valores são os valores das opções. Para as opções suportadas por um tipo específico de item, consulte a documentação da API desse Update-Definition tipo de item.

UpdateFromGitRequest

Object

Contém a atualização dos dados de solicitação do Git.

Nome Tipo Descrição
conflictResolution

WorkspaceConflictResolution

Resolução de conflitos a ser usada na atualização da operação Git. Se os itens estiverem em conflito e uma resolução de conflito não for especificada, a operação de atualização não será iniciada.
options

UpdateOptions

Opções a serem usadas na atualização da operação Git
remoteCommitHash

string

Hash de confirmação SHA completo remoto.
workspaceHead

string

Hash SHA completo com o qual o espaço de trabalho está sincronizado. Esse valor pode ser nulo somente após Initialize Connection. Em outros casos, o sistema validará se o valor dado está alinhado com a cabeça conhecida pelo sistema.

UpdateOptions

Object

Contém as opções habilitadas para a atualização do Git.

Nome Tipo Descrição
allowOverrideItems

boolean

Consentimento do usuário para substituir itens recebidos durante a atualização do processo Git. Quando os itens de entrada estiverem presentes e a permissão de substituição de itens não for especificada ou for fornecida como falsa, a operação de atualização não será iniciada. O valor predefinido é falso.
itemOptionsByLogicalId

ItemOptionsByLogicalIdEntry[]

Opções de atualização por item. Cada entrada direciona o seu item por ID lógico e aplica as suas opções a esse item.

WorkspaceConflictResolution

Object

Os dados básicos de resolução de conflitos.

Nome Tipo Descrição
conflictResolutionPolicy

ConflictResolutionPolicy

Política de resolução de conflitos. Políticas adicionais de resolução de conflitos podem ser adicionadas ao longo do tempo.
conflictResolutionType

ConflictResolutionType

Tipo de resolução de conflitos. Tipos adicionais de resolução de conflitos podem ser adicionados ao longo do tempo.