Git - Initialize Connection

Servicio:

Core

Versión de la API:

v1

Inicialice una conexión para un área de trabajo que esté conectada a Git.
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.

Se debe llamar a esta API después de una llamada correcta a la API de Connect . Para completar una sincronización completa del área de trabajo, use la operación Acción necesaria para llamar a la operación de sincronización pertinente, ya sea Confirmar en Git o Actualizar desde Git.

Permissions

El autor de la llamada debe tener un rol de área de trabajo de administrador .

Ámbitos delegados necesarios

Workspace.ReadWrite.All

Identidades admitidas de Microsoft Entra

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

Identity	Support
User	Yes
Entidad de servicio e Identidades administradas	Yes

Interface

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

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	Tipo	Description
initializationStrategy	InitializationStrategy	Estrategia necesaria para un proceso de inicialización cuando el contenido existe tanto en el lado remoto como en el lado del área de trabajo. Se pueden agregar estrategias adicionales a lo largo del tiempo.

Respuestas

Nombre	Tipo	Description
200 OK	InitializeGitConnectionResponse	Solicitud completada correctamente.
202 Accepted		Solicitud aceptada, inicializar la conexión 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. MissingInitializationPolicy: falta la directiva de inicialización. InsufficientPrivileges: el autor de la llamada no tiene permisos suficientes en el área de trabajo. PrincipalTypeNotSupported: no se admite el tipo de identidad llamador.

Ejemplos

Initialize the connection of a workspace connected to a Git example

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:

200

{
  "requiredAction": "UpdateFromGit",
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705"
}

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
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
InitializationStrategy	Estrategia necesaria para un proceso de inicialización cuando el contenido existe tanto en el lado remoto como en el lado del área de trabajo. Se pueden agregar estrategias adicionales a lo largo del tiempo.
InitializeGitConnectionRequest	Contiene los datos de solicitud de conexión de Git inicializar.
InitializeGitConnectionResponse	Contiene los datos de respuesta de conexión de Git inicializar.
RequiredAction	Acción necesaria una vez finalizado el proceso de inicialización. Se pueden agregar acciones adicionales a lo largo del tiempo.

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.

InitializationStrategy

Enumeración

Estrategia necesaria para un proceso de inicialización cuando el contenido existe tanto en el lado remoto como en el lado del área de trabajo. Se pueden agregar estrategias adicionales a lo largo del tiempo.

Valor	Description
None	No se ha definido ninguna estrategia.
PreferRemote	Prefiere el contenido remoto del lado git.
PreferWorkspace	Se prefiere el contenido del lado del área de trabajo.

InitializeGitConnectionRequest

Object

Contiene los datos de solicitud de conexión de Git inicializar.

Nombre	Tipo	Description
initializationStrategy	InitializationStrategy	Estrategia necesaria para un proceso de inicialización cuando el contenido existe tanto en el lado remoto como en el lado del área de trabajo. Se pueden agregar estrategias adicionales a lo largo del tiempo.

InitializeGitConnectionResponse

Object

Contiene los datos de respuesta de conexión de Git inicializar.

Nombre	Tipo	Description
remoteCommitHash	string	Hash de confirmación sha completo remoto.
requiredAction	RequiredAction	Acción necesaria una vez finalizado el proceso de inicialización. Se pueden agregar acciones adicionales a lo largo del tiempo.
workspaceHead	string	Hash sha completo al que se sincroniza el área de trabajo.

RequiredAction

Enumeración

Acción necesaria una vez finalizado el proceso de inicialización. Se pueden agregar acciones adicionales a lo largo del tiempo.

Valor	Description
None	No se requiere ninguna acción.
UpdateFromGit	Se requiere la actualización desde Git.
CommitToGit	Se requiere la confirmación en Git.