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.

Pode optar por fazer commit de todas as alterações, itens específicos ou ficheiros específicos dentro de itens usando o modo FileLevelSelective. 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

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
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. Isto é relevante apenas para o modo de commit seletivo. Mutuamente exclusivo com itemsWithFileSelection. Os itens podem ser recuperados da API de status do Git .
itemsWithFileSelection		ItemIdentifierWithFileSelection[]	Itens com seleção por ficheiro para o modo de commit FileLevelSelective. É mutuamente exclusivo com os objetos. Cada entrada especifica um item e, opcionalmente, uma lista de caminhos de ficheiros a comprometer. Se selectedFiles estiver nulo ou vazio para um item, todos os ficheiros desse item são confirmados.
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

Nome	Tipo	Descrição
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
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. 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 file-level selective 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 file-level selective to Git example

Pedido de amostra

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

Nome	Descrição
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.
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.
ItemIdentifier	Contém o identificador do item. Pelo menos uma das propriedades deve ser definida.
ItemIdentifierWithFileSelection	Contém o identificador do item com seleção opcional ao nível do ficheiro para operações de commit.

CommitMode

Enumeração

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

Valor	Descrição
All	Confirme todas as alterações não confirmadas. O chamador não é obrigado a fornecer a lista de itens a serem confirmados.
Selective	Compromete uma lista específica de itens que têm alterações não comprometidas. Use a `items` propriedade para especificar os itens.
FileLevelSelective	Confirme ficheiros especificados dentro dos itens especificados. Use a `itemsWithFileSelection` propriedade para especificar itens e ficheiros.

CommitToGitRequest

Object

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

Nome	Tipo	Descriçã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. Isto é relevante apenas para o modo de commit seletivo. Mutuamente exclusivo com itemsWithFileSelection. Os itens podem ser recuperados da API de status do Git .
itemsWithFileSelection	ItemIdentifierWithFileSelection[]	Itens com seleção por ficheiro para o modo de commit FileLevelSelective. É mutuamente exclusivo com os objetos. Cada entrada especifica um item e, opcionalmente, uma lista de caminhos de ficheiros a comprometer. Se selectedFiles estiver nulo ou vazio para um item, todos os ficheiros desse item são confirmados.
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 .

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.

ItemIdentifier

Object

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

Nome	Tipo	Descrição
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.

ItemIdentifierWithFileSelection

Object

Contém o identificador do item com seleção opcional ao nível do ficheiro para operações de commit.

Nome	Tipo	Descrição
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.
selectedFiles	string[]	Caminhos de ficheiros a comprometer, em relação à raiz do item. Os caminhos usam apenas barras para a frente, sem barras iniciais, apenas caminhos de ficheiros completos (sem diretórios ou curingas), sem segmentos vazios ou apenas com espaços em branco, e os segmentos não podem terminar com um ponto ou um espaço em branco final. Se nulo ou vazio, todos os ficheiros deste item são confirmados.