Git - Commit To Git

Serviço:: Core

Versão da API:: v1

Confirma as alterações feitas no workspace para o branch remoto conectado.
Essa API dá suporte a LRO (operações de execução longa).

Para usar essa API, as credenciais do Git do chamador devem ser configuradas usando a API Atualizar Minhas Credenciais do Git . Você pode usar a API Obter Minhas Credenciais do Git para verificar a configuração de credenciais do Git.

Você pode optar por confirmar todas as alterações, itens específicos ou arquivos específicos em itens usando o modo FileLevelSelective. Para sincronizar o workspace pela primeira vez, use essa API após as APIs conectar e inicializar conexão .

Permissões

O chamador deve ter um colaborador ou uma função de workspace superior.

Escopos delegados necessários

Workspace.GitCommit.All.

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identidade	Apoio
Utilizador	Sim
entidade de serviço e identidades gerenciadas	Só há suporte quando todos os itens envolvidos nas entidades de serviço de suporte da operação

Interfase

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
workspaceId	path	True	string (uuid)	O identificador do espaço de trabalho.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
mode	True	CommitMode	O modo para a operação de confirmação.
comment		string maxLength: 300	Comentário sem chamadas para esta confirmação. O comprimento máximo é de 300 caracteres. Se nenhum comentário for fornecido pelo chamador, use o comentário padrão do provedor Git.
items		ItemIdentifier[]	Itens específicos a serem confirmados. Isso é relevante apenas para o modo de confirmação seletiva. Mutuamente exclusivo com itemsWithFileSelection. Os itens podem ser recuperados da API de Status do Git .
itemsWithFileSelection		ItemIdentifierWithFileSelection[]	Itens com seleção por arquivo para o modo de confirmação FileLevelSelective. Mutuamente exclusivo com itens. Cada entrada especifica um item e, opcionalmente, uma lista de caminhos de arquivo a serem confirmados. Se selectedFiles for nulo ou vazio para um item, todos os arquivos para esse item serão confirmados.
workspaceHead		string	Hash SHA completo ao qual o workspace está sincronizado. O hash pode ser recuperado da API de Status do Git .

Respostas

Nome	Tipo	Description
200 OK		Solicitação concluída com êxito.
202 Accepted		Solicitação aceita, confirmação no Git em andamento. Cabeçalhos Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	O limite de taxa de serviço foi excedido. O servidor retorna um `Retry-After` cabeçalho indicando, em segundos, quanto tempo o cliente deve aguardar antes de enviar solicitações adicionais. Cabeçalhos Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de erro comuns: WorkspaceNotConnectedToGit – O workspace não está conectado ao git. WorkspaceHasNoCapacityAssigned – nenhuma capacidade assinged para o workspace. WorkspaceHeadMismatch – Cabeçalho na solicitação não corresponde à cabeça no sistema. WorkspacePreviousOperationInProgress – A operação anterior ainda está em andamento. InsufficientPrivileges - O chamador não tem permissões de workspace suficientes. PrincipalTypeNotSupported – Não há suporte para o tipo de identidade do chamador.

Exemplos

Commit all to Git example

Commit file-level selective to Git example

Commit selective items to Git example

Commit all to Git example

Solicitação de exemplo

HTTP

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

{
  "mode": "All",
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "comment": "I'm committing all my changes."
}

Resposta de exemplo

Código de status:: 200

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

Commit file-level selective to Git example

Solicitação de exemplo

HTTP

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

{
  "mode": "FileLevelSelective",
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "comment": "Commit only the metadata change from MyNotebook",
  "itemsWithFileSelection": [
    {
      "objectId": "cfafbeb1-8037-4d0c-896e-28c4f2e65573",
      "selectedFiles": [
        "metadata.json"
      ]
    },
    {
      "objectId": "d5a2b3c4-1234-5678-abcd-ef0123456789",
      "selectedFiles": []
    }
  ]
}

Resposta de exemplo

Código de status:: 200

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

Commit selective items to Git example

Solicitação de exemplo

HTTP

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

{
  "mode": "Selective",
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "comment": "I'm committing specific changes.",
  "items": [
    {
      "logicalId": "111e8d7b-4a95-4c02-8ccd-6faef5ba1bd1",
      "objectId": "1153f3b4-dbb8-33c1-a84f-6ae4d776362d"
    },
    {
      "objectId": "7753f3b4-dbb8-44c1-a94f-6ae4d776369e"
    }
  ]
}

Resposta de exemplo

Código de status:: 200

Código de status:: 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	Description
CommitMode	Modos para a operação de confirmação. Modos adicionais podem ser adicionados ao longo do tempo.
CommitToGitRequest	Contém a solicitação de confirmação.
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
ItemIdentifier	Contém o identificador do item. Pelo menos uma das propriedades deve ser definida.
ItemIdentifierWithFileSelection	Contém o identificador de item com seleção opcional no nível do arquivo para operações de confirmação.

CommitMode

Enumeração

Modos para a operação de confirmação. Modos adicionais podem ser adicionados ao longo do tempo.

Valor	Description
All	Confirme todas as alterações não confirmadas. O chamador não é necessário para fornecer a lista de itens a serem confirmados.
Selective	Confirme uma lista especificada de itens que têm alterações não confirmadas. Use a `items` propriedade para especificar itens.
FileLevelSelective	Confirmar arquivos especificados em itens especificados. Use a `itemsWithFileSelection` propriedade para especificar itens e arquivos.

CommitToGitRequest

Objeto

Contém a solicitação de confirmação.

Nome	Tipo	Description
comment	string maxLength: 300	Comentário sem chamadas para esta confirmação. O comprimento máximo é de 300 caracteres. Se nenhum comentário for fornecido pelo chamador, use o comentário padrão do provedor Git.
items	ItemIdentifier[]	Itens específicos a serem confirmados. Isso é relevante apenas para o modo de confirmação seletiva. Mutuamente exclusivo com itemsWithFileSelection. Os itens podem ser recuperados da API de Status do Git .
itemsWithFileSelection	ItemIdentifierWithFileSelection[]	Itens com seleção por arquivo para o modo de confirmação FileLevelSelective. Mutuamente exclusivo com itens. Cada entrada especifica um item e, opcionalmente, uma lista de caminhos de arquivo a serem confirmados. Se selectedFiles for nulo ou vazio para um item, todos os arquivos para esse item serão confirmados.
mode	CommitMode	O modo para a operação de confirmação.
workspaceHead	string	Hash SHA completo ao qual o workspace está sincronizado. O hash pode ser recuperado da API de Status do Git .

ErrorRelatedResource

Objeto

O objeto de detalhes do recurso relacionado ao erro.

Nome	Tipo	Description
resourceId	string	A ID do recurso envolvida no erro.
resourceType	string	O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
isRetriable	boolean	Quando true, a solicitação pode ser repetida. Use o `Retry-After` cabeçalho de resposta para determinar o atraso, se disponível.
message	string	Uma representação legível humana do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.
requestId	string (uuid)	ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.

ItemIdentifier

Objeto

Contém o identificador do item. Pelo menos uma das propriedades deve ser definida.

Nome	Tipo	Description
logicalId	string (uuid)	A ID lógica do item. Quando a ID lógica não estiver disponível porque o item ainda não foi adicionado ao workspace, você poderá usar a ID do objeto.
objectId	string (uuid)	A ID do objeto do item. Quando a ID do objeto não está disponível porque o item foi excluído do workspace, você pode usar a ID lógica.

ItemIdentifierWithFileSelection

Objeto

Contém o identificador de item com seleção opcional no nível do arquivo para operações de confirmação.

Nome	Tipo	Description
logicalId	string (uuid)	A ID lógica do item. Quando a ID lógica não estiver disponível porque o item ainda não foi adicionado ao workspace, você poderá usar a ID do objeto.
objectId	string (uuid)	A ID do objeto do item. Quando a ID do objeto não está disponível porque o item foi excluído do workspace, você pode usar a ID lógica.
selectedFiles	string[]	Caminhos de arquivo para confirmação, em relação à raiz do item. Os caminhos usam somente barras para frente, sem barra à esquerda, somente caminhos de arquivo completos (sem diretórios ou curingas), nenhum segmento vazio ou somente espaço em branco e segmentos não podem terminar com um ponto ou espaço em branco à direita. Se nulo ou vazio, todos os arquivos para este item serão confirmados.