Compartir a través de

Git - Commit To Git

Servicio:
Core
Versión de la API:
v1

Confirma los cambios realizados en el área de trabajo en la rama remota conectada.
Esta API admite operaciones de larga duración (LRO).

Para usar esta API, las credenciales de Git del autor de la llamada deben configurarse mediante Update My Git Credentials API (Actualizar mis credenciales de Git ). Puede usar la API Obtener mis credenciales de Git para comprobar la configuración de credenciales de Git.

Puede optar por confirmar todos los cambios o solo elementos modificados específicos. Para sincronizar el área de trabajo por primera vez, use esta API después de conectar e inicializar las API de conexión .

Permisos

El autor de la llamada debe tener un rol de colaborador o superior.

Ámbitos delegados necesarios

Workspace.GitCommit.All.

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

identidad Apoyo
Usuario Sí
de entidad de servicio y identidades administradas Solo se admite cuando todos los elementos implicados en la operación admiten entidades de servicio.

Interfaz

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
workspaceId
 path True

string (uuid)

Identificador del área de trabajo.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
mode True

CommitMode

Modo para la operación de confirmación.
comment

string

maxLength: 300

Comentario gratuito del autor de la llamada para esta confirmación. La longitud máxima es de 300 caracteres. Si el autor de la llamada no proporciona ningún comentario, use el comentario del proveedor de Git predeterminado.
items

ItemIdentifier[]

Elementos específicos que se van a confirmar. Esto solo es relevante para el modo de confirmación selectiva. Los elementos se pueden recuperar de la API de estado de Git .
workspaceHead

string

Hash sha completo al que se sincroniza el área de trabajo. El hash se puede recuperar de la API de estado de Git .

Respuestas

Nombre Tipo Description
200 OK

Solicitud completada correctamente.
202 Accepted

Solicitud aceptada, confirmación en Git en curso.

Encabezados

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Códigos de error comunes:

  • WorkspaceNotConnectedToGit: el área de trabajo no está conectada a Git.

  • WorkspaceHasNoCapacityAssigned: no hay capacidad asignada al área de trabajo.

  • WorkspaceHeadMismatch: el encabezado de la solicitud no coincide con el encabezado del sistema.

  • WorkspacePreviousOperationInProgress: la operación anterior todavía está en curso.

  • InsufficientPrivileges: el autor de la llamada no tiene suficientes permisos de área de trabajo.

  • PrincipalTypeNotSupported: no se admite el tipo de identidad llamador.

Ejemplos

Commit all to Git example
Commit selective items to Git example

Commit all to Git example

Solicitud de ejemplo

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."
}

Respuesta de muestra

status code:
200
status code:
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

Solicitud de ejemplo

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"
    }
  ]
}

Respuesta de muestra

status code:
200
status code:
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

Definiciones

Nombre Description
CommitMode

Modos para la operación de confirmación. Se pueden agregar modos adicionales a lo largo del tiempo.
CommitToGitRequest

Contiene la solicitud de confirmación.
ErrorRelatedResource

Objeto de detalles del recurso relacionado con el error.
ErrorResponse

Respuesta de error.
ErrorResponseDetails

Detalles de la respuesta de error.
ItemIdentifier

Contiene el identificador de elemento. Se debe definir al menos una de las propiedades.

CommitMode

Enumeración

Modos para la operación de confirmación. Se pueden agregar modos adicionales a lo largo del tiempo.

Valor Description
All

Confirme todos los cambios no confirmados. No es necesario que el autor de la llamada proporcione la lista de elementos que se van a confirmar.
Selective

Confirme una lista de elementos especificada que tenga cambios no confirmados.

CommitToGitRequest

Object

Contiene la solicitud de confirmación.

Nombre Tipo Description
comment

string

maxLength: 300

Comentario gratuito del autor de la llamada para esta confirmación. La longitud máxima es de 300 caracteres. Si el autor de la llamada no proporciona ningún comentario, use el comentario del proveedor de Git predeterminado.
items

ItemIdentifier[]

Elementos específicos que se van a confirmar. Esto solo es relevante para el modo de confirmación selectiva. Los elementos se pueden recuperar de la API de estado de Git .
mode

CommitMode

Modo para la operación de confirmación.
workspaceHead

string

Hash sha completo al que se sincroniza el área de trabajo. El hash se puede recuperar de la API de estado de Git .

ErrorRelatedResource

Object

Objeto de detalles del recurso relacionado con el error.

Nombre Tipo Description
resourceId

string

Identificador de recurso implicado en el error.
resourceType

string

Tipo del recurso implicado en el error.

ErrorResponse

Object

Respuesta de error.

Nombre Tipo Description
errorCode

string

Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message

string

Representación legible del error.
moreDetails

ErrorResponseDetails[]

Lista de detalles de error adicionales.
relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.
requestId

string

Identificador de la solicitud asociada al error.

ErrorResponseDetails

Object

Detalles de la respuesta de error.

Nombre Tipo Description
errorCode

string

Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message

string

Representación legible del error.
relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.

ItemIdentifier

Object

Contiene el identificador de elemento. Se debe definir al menos una de las propiedades.

Nombre Tipo Description
logicalId

string (uuid)

Identificador lógico del elemento. Cuando el identificador lógico no está disponible porque el elemento aún no se ha agregado al área de trabajo, puede usar el identificador de objeto.
objectId

string (uuid)

Identificador de objeto del elemento. Cuando el identificador de objeto no está disponible porque el elemento se eliminó del área de trabajo, puede usar el identificador lógico.