Git - Commit To Git

Serviço:: Core

Versão da API:: v1

Confirma as alterações feitas no espaço de trabalho para a ramificação remota 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.

Você pode optar por confirmar todas as alterações ou apenas itens alterados específicos. Para sincronizar o espaço de trabalho pela primeira vez, use essa API após as APIs Conectar e Inicializar Conexão .

Permissões

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

Escopos delegados necessários

Workspace.GitCommit.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/commitToGit

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
workspaceId	path	True	string (uuid)	O ID do espaço de trabalho.

Corpo do Pedido

Name	Necessário	Tipo	Description
mode	True	CommitMode	O modo para a operação de confirmação.
comment		string maxLength: 300	Comentário sem chamador 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 comprometidos. Isso é relevante apenas para o modo de confirmação seletiva. Os itens podem ser recuperados da API de status do Git .
workspaceHead		string	Hash SHA completo com o qual o espaço de trabalho está sincronizado. O hash pode ser recuperado da API de status do Git .

Respostas

Name	Tipo	Description
200 OK		Pedido concluído com sucesso.
202 Accepted		Pedido aceite, comprometer-se com o Git em curso. Cabeçalhos Location: string x-ms-operation-id: string 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. InsufficientPrivileges - O chamador não tem permissões de espaço de trabalho suficientes. PrincipalTypeNotSupported - O tipo de identidade do chamador não é suportado.

Name

Tipo

Description

200 OK

Pedido concluído com sucesso.

202 Accepted

Pedido aceite, comprometer-se com o Git em curso.

Cabeçalhos

Location: string
x-ms-operation-id: string
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.
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

Commit all to Git example

Commit selective items to Git example

Commit all to Git example

Pedido de amostra

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

Commit selective items to Git example

Pedido de amostra

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

Name	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.

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 é obrigado a fornecer a lista de itens a serem confirmados.
Selective	Confirme uma lista de itens especificados que tenha alterações não confirmadas.

CommitToGitRequest

Object

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

Name	Tipo	Description
comment	string maxLength: 300	Comentário sem chamador 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 comprometidos. Isso é relevante apenas para o modo de confirmação seletiva. Os itens podem ser recuperados da API de status do Git .
mode	CommitMode	O modo para a operação de confirmação.
workspaceHead	string	Hash SHA completo com o qual o espaço de trabalho está sincronizado. O hash pode ser recuperado da API de status do Git .

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

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

ErrorResponse

Object

A resposta de erro.

Name	Tipo	Description
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.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionados ao erro.
requestId	string	ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Name	Tipo	Description
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.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionados ao erro.

ItemIdentifier

Object

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

Name	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 espaço de trabalho, você poderá usar a ID do objeto.
objectId	string (uuid)	A ID do objeto do item. Quando a ID do objeto não estiver disponível porque o item foi excluído do espaço de trabalho, você poderá usar a ID lógica.

Partilhar via

Git - Commit To Git

Permissões

Escopos delegados necessários

Identidades suportadas pelo Microsoft Entra

Interfaz

Parâmetros do URI

Corpo do Pedido

Respostas

Exemplos

Commit all to Git example

Pedido de amostra

Resposta da amostra

Commit selective items to Git example

Pedido de amostra

Resposta da amostra

Definições

CommitMode

CommitToGitRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemIdentifier