Git - Update From Git

Servicio:
Core
Versión de la API:
v1

Actualiza el área de trabajo con confirmaciones insertadas en la rama conectada.

Note

La compatibilidad con el plan de implementación en esta API forma parte de una versión beta y solo se proporciona con fines de evaluación y desarrollo. Puede cambiar en función de los comentarios y no se recomienda para su uso en producción. Todas las demás funcionalidades de esta API están disponibles con carácter general. Para usar la compatibilidad con el plan de implementación, los autores de llamadas deben especificar true como valor para el parámetro betade consulta .

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.

La actualización solo afecta a los elementos del área de trabajo que se cambiaron en esas confirmaciones. Si se llama después de conectar einicializar las API de conexión , realizará una actualización completa de todo el área de trabajo.

Permisos

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

Ámbitos delegados necesarios

Workspace.GitUpdate.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/updateFromGit
Con parámetros opcionales: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/updateFromGit?beta={beta}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
workspaceId
 path True

string (uuid)

Identificador del área de trabajo.
beta
 query

boolean

Establézcalo en true para habilitar la funcionalidad Beta, incluida la compatibilidad con el plan de implementación. Cuando se omite o establece en false, solo se puede acceder a la funcionalidad disponible con carácter general y no se acepta la entrada del plan de implementación.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
remoteCommitHash True

string

Hash de confirmación sha completo remoto.
conflictResolution

WorkspaceConflictResolution

Resolución de conflictos que se va a usar en la operación de actualización desde Git. Si los elementos están en conflicto y no se especifica una resolución de conflictos, la operación de actualización no se iniciará.
options

UpdateOptions

Opciones que se usarán en la operación de actualización desde Git
workspaceHead

string

Hash sha completo al que se sincroniza el área de trabajo. Este valor solo puede ser NULL después de Inicializar conexión. En otros casos, el sistema validará que el valor especificado está alineado con el encabezado conocido para el sistema.

Respuestas

Nombre Tipo Description
200 OK

Solicitud completada correctamente.
202 Accepted

Solicitud aceptada, actualización de Git en curso.

Encabezados

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

ErrorResponse

Se superó el límite de frecuencia de servicio. El servidor devuelve un Retry-After encabezado que indica, en segundos, cuánto tiempo debe esperar el cliente antes de enviar solicitudes adicionales.

Encabezados

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.

  • MissingDependency: falta una dependencia en la operación de actualización.

  • PotentialDuplicateDisplayNameAndType: la operación de actualización creará un nombre para mostrar y un tipo duplicados.

  • DependencyDeletionFailed: la operación de actualización eliminará la dependencia fuerte.

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

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

Ejemplos

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

Update a workspace from Git with options example

Solicitud de ejemplo

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

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

Update a workspace using data from a Git example

Solicitud de ejemplo

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

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

Update a workspace using data from a Git with a deployment plan example

Solicitud de ejemplo

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,
    "deploymentPlan": {
      "referenceType": "ByLogicalId",
      "logicalId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  }
}

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
ConflictResolutionPolicy

Directiva de resolución de conflictos. Se pueden agregar directivas de resolución de conflictos adicionales a lo largo del tiempo.
ConflictResolutionType

Tipo de resolución de conflictos. Se pueden agregar tipos de resolución de conflictos adicionales a lo largo del tiempo.
DeploymentPlanReferenceByItemId

Referencia del plan de implementación por identificador de elemento.
DeploymentPlanReferenceByLogicalId

Referencia de un plan de implementación por identificador lógico.
DeploymentPlanReferenceType

Tipo de referencia del plan de implementación. Se pueden agregar tipos de DeploymentPlanReferenceType adicionales a lo largo del tiempo.
ErrorParameter

Parámetro estructurado que proporciona contexto legible por máquina adicional sobre un error.
ErrorRelatedResource

Objeto de detalles del recurso relacionado con el error.
ErrorResponse

Respuesta de error.
ErrorResponseDetails

Detalles de la respuesta de error.
ItemOptionsByLogicalIdEntry

Entrada de opciones por elemento que tiene como destino su elemento por identificador lógico. Cada elemento de destino puede aparecer como máximo una vez.
UpdateFromGitRequest

Contiene la actualización de los datos de solicitud de Git.
UpdateOptions

Contiene las opciones habilitadas para la actualización desde Git.
WorkspaceConflictResolution

Datos básicos de resolución de conflictos.

ConflictResolutionPolicy

Enumeración

Directiva de resolución de conflictos. Se pueden agregar directivas de resolución de conflictos adicionales a lo largo del tiempo.

Valor Description
PreferRemote

Prefiere el contenido remoto del lado git.
PreferWorkspace

Se prefiere el contenido del lado del área de trabajo.

ConflictResolutionType

Enumeración

Tipo de resolución de conflictos. Se pueden agregar tipos de resolución de conflictos adicionales a lo largo del tiempo.

Valor Description
Workspace

Resolución de conflictos que representa el nivel del área de trabajo.

DeploymentPlanReferenceByItemId

Objeto

Referencia del plan de implementación por identificador de elemento.

Nombre Tipo Description
itemId

string (uuid)

Identificador de elemento del elemento de plan de implementación.
referenceType string:

ByItemId

Tipo de referencia del plan de implementación.

DeploymentPlanReferenceByLogicalId

Objeto

Referencia de un plan de implementación por identificador lógico.

Nombre Tipo Description
logicalId

string (uuid)

Identificador lógico del elemento de plan de implementación.
referenceType string:

ByLogicalId

Tipo de referencia del plan de implementación.

DeploymentPlanReferenceType

Enumeración

Tipo de referencia del plan de implementación. Se pueden agregar tipos de DeploymentPlanReferenceType adicionales a lo largo del tiempo.

Valor Description
ByItemId

El identificador de elemento hace referencia al plan de implementación.
ByLogicalId

El identificador lógico hace referencia al plan de implementación.

ErrorParameter

Objeto

Parámetro estructurado que proporciona contexto legible por máquina adicional sobre un error.

Nombre Tipo Description
message

string

Descripción legible del significado del parámetro.
name

string

El identificador de parámetros.
value

string

Es el valor del parámetro.

ErrorRelatedResource

Objeto

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

Objeto

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

boolean

Cuando es true, se puede reintentar la solicitud. Use el Retry-After encabezado de respuesta para determinar el retraso, si está disponible.
message

string

Representación legible del error.
moreDetails

ErrorResponseDetails[]

Lista de detalles de error adicionales.
parameters

ErrorParameter[]

Parámetros estructurados que proporcionan contexto legible por máquina adicional sobre el error.
relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.
requestId

string (uuid)

Identificador de la solicitud asociada al error.

ErrorResponseDetails

Objeto

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

ErrorParameter[]

Parámetros estructurados que proporcionan contexto legible por máquina adicional sobre el error.
relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.

ItemOptionsByLogicalIdEntry

Objeto

Entrada de opciones por elemento que tiene como destino su elemento por identificador lógico. Cada elemento de destino puede aparecer como máximo una vez.

Nombre Tipo Description
logicalId

string (uuid)

Identificador lógico del elemento de destino.
options

object

Las opciones del elemento de destino. Los nombres de propiedad son nombres de opción válidos para el tipo de elemento; los valores son los valores de opción. Para ver las opciones admitidas por un tipo de elemento específico, consulte la documentación de la API del tipo de Update-Definition elemento.

UpdateFromGitRequest

Objeto

Contiene la actualización de los datos de solicitud de Git.

Nombre Tipo Description
conflictResolution

WorkspaceConflictResolution

Resolución de conflictos que se va a usar en la operación de actualización desde Git. Si los elementos están en conflicto y no se especifica una resolución de conflictos, la operación de actualización no se iniciará.
options

UpdateOptions

Opciones que se usarán en la operación de actualización desde Git
remoteCommitHash

string

Hash de confirmación sha completo remoto.
workspaceHead

string

Hash sha completo al que se sincroniza el área de trabajo. Este valor solo puede ser NULL después de Inicializar conexión. En otros casos, el sistema validará que el valor especificado está alineado con el encabezado conocido para el sistema.

UpdateOptions

Objeto

Contiene las opciones habilitadas para la actualización desde Git.

Nombre Tipo Description
allowOverrideItems

boolean

Consentimiento del usuario para invalidar los elementos entrantes durante la actualización desde el proceso de Git. Cuando los elementos entrantes están presentes y no se especifican los elementos de invalidación de permitidos o se proporcionan como false, la operación de actualización no se iniciará. El valor predeterminado es false.
deploymentPlan DeploymentPlanReference:

Referencia a un elemento de plan de implementación para organizar la implementación. Cuando se proporciona, el plan controla el orden de implementación de elementos y ejecuta acciones anteriores o posteriores a la implementación. Cuando está ausente o null, la operación se comporta como en la actualidad. Actualmente, solo se admite el ByLogicalId tipo de referencia. La compatibilidad del plan de implementación está actualmente en beta. Esta propiedad solo se puede usar cuando el parámetro beta de consulta está establecido true en y puede cambiar en función de los comentarios.
itemOptionsByLogicalId

ItemOptionsByLogicalIdEntry[]

Opciones de actualización por elemento. Cada entrada tiene como destino su elemento por identificador lógico y aplica sus opciones a ese elemento.

WorkspaceConflictResolution

Objeto

Datos básicos de resolución de conflictos.

Nombre Tipo Description
conflictResolutionPolicy

ConflictResolutionPolicy

Directiva de resolución de conflictos. Se pueden agregar directivas de resolución de conflictos adicionales a lo largo del tiempo.
conflictResolutionType

ConflictResolutionType

Tipo de resolución de conflictos. Se pueden agregar tipos de resolución de conflictos adicionales a lo largo del tiempo.