Partager via

Git - Initialize Connection

Service:
Core
Version d'API:
v1

Initialisez une connexion pour un espace de travail connecté à Git.
Cette API prend en charge opérations longues (LRO).

Pour utiliser cette API, les informations d’identification Git de l’appelant doivent être configurées à l’aide de l’API Mettre à jour mes informations d’identification Git . Vous pouvez utiliser l’API Obtenir mes informations d’identification Git pour vérifier la configuration des informations d’identification Git.

Cette API doit être appelée après un appel réussi à l’API Connect . Pour effectuer une synchronisation complète de l’espace de travail, utilisez l’opération Action requise pour appeler l’opération de synchronisation appropriée, soit Valider sur Git , soit Mettre à jour à partir de Git.

Permissions

L’appelant doit avoir un rôle d’espace de travail administrateur.

Étendues déléguées requises

Workspace.ReadWrite.All

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identity Support
User Yes
Service principal et identités gérées Yes

Interface

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

Paramètres URI

Nom Dans Obligatoire Type Description
workspaceId
 path True

string (uuid)

Identifiant de l’espace de travail.

Corps de la demande

Nom Type Description
initializationStrategy

InitializationStrategy

Stratégie requise pour un processus d’initialisation lorsque le contenu existe à la fois côté distant et côté espace de travail. Des stratégies supplémentaires peuvent être ajoutées au fil du temps.

Réponses

Nom Type Description
200 OK

InitializeGitConnectionResponse

La demande s’est terminée avec succès.
202 Accepted

Demande acceptée, initialisez la connexion en cours.

En-têtes

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

ErrorResponse

Codes d’erreur courants :

  • WorkspaceNotConnectedToGit : l’espace de travail n’est pas connecté à Git.

  • WorkspaceHasNoCapacityAssigned : aucune capacité n’est affectée à l’espace de travail.

  • MissingInitializationPolicy : la stratégie d’initialisation est manquante.

  • InsufficientPrivileges : l’appelant ne dispose pas des autorisations suffisantes sur l’espace de travail.

  • PrincipalTypeNotSupported : le type d’identité de l’appelant n’est pas pris en charge.

Exemples

Initialize the connection of a workspace connected to a Git example

Exemple de requête

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

Exemple de réponse

Code d’état:
200 
{
  "requiredAction": "UpdateFromGit",
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705"
}
Code d’état:
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

Définitions

Nom Description
ErrorRelatedResource

Objet de détails de ressource associé à l’erreur.
ErrorResponse

Réponse d’erreur.
ErrorResponseDetails

Détails de la réponse d’erreur.
InitializationStrategy

Stratégie requise pour un processus d’initialisation lorsque le contenu existe à la fois côté distant et côté espace de travail. Des stratégies supplémentaires peuvent être ajoutées au fil du temps.
InitializeGitConnectionRequest

Contient les données de demande de connexion Git initialisez.
InitializeGitConnectionResponse

Contient les données de réponse de connexion Git initialisez.
RequiredAction

Action requise une fois le processus d’initialisation terminé. Des actions supplémentaires peuvent être ajoutées au fil du temps.

ErrorRelatedResource

Object

Objet de détails de ressource associé à l’erreur.

Nom Type Description
resourceId

string

ID de ressource impliqué dans l’erreur.
resourceType

string

Type de la ressource impliquée dans l’erreur.

ErrorResponse

Object

Réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
moreDetails

ErrorResponseDetails[]

Liste des détails d’erreur supplémentaires.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.
requestId

string

ID de la demande associée à l’erreur.

ErrorResponseDetails

Object

Détails de la réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.

InitializationStrategy

Énumération

Stratégie requise pour un processus d’initialisation lorsque le contenu existe à la fois côté distant et côté espace de travail. Des stratégies supplémentaires peuvent être ajoutées au fil du temps.

Valeur Description
None

Aucune stratégie définie.
PreferRemote

Préférez le contenu côté Git distant.
PreferWorkspace

Préférer le contenu côté espace de travail.

InitializeGitConnectionRequest

Object

Contient les données de demande de connexion Git initialisez.

Nom Type Description
initializationStrategy

InitializationStrategy

Stratégie requise pour un processus d’initialisation lorsque le contenu existe à la fois côté distant et côté espace de travail. Des stratégies supplémentaires peuvent être ajoutées au fil du temps.

InitializeGitConnectionResponse

Object

Contient les données de réponse de connexion Git initialisez.

Nom Type Description
remoteCommitHash

string

Hachage de validation SHA complet distant.
requiredAction

RequiredAction

Action requise une fois le processus d’initialisation terminé. Des actions supplémentaires peuvent être ajoutées au fil du temps.
workspaceHead

string

Hachage SHA complet auquel l’espace de travail est synchronisé.

RequiredAction

Énumération

Action requise une fois le processus d’initialisation terminé. Des actions supplémentaires peuvent être ajoutées au fil du temps.

Valeur Description
None

Aucune action n’est requise.
UpdateFromGit

La mise à jour à partir de Git est requise.
CommitToGit

La validation sur Git est requise.