Freigeben über

Git - Initialize Connection

Dienst:
Core
API-Version:
v1

Initialisieren Sie eine Verbindung für einen Arbeitsbereich, der mit Git verbunden ist.
Diese API unterstützt LRO-.

Um diese API zu verwenden, müssen die Git-Anmeldeinformationen des Aufrufers mithilfe der API "Meine Git-Anmeldeinformationen aktualisieren" konfiguriert werden. Sie können die Api " Meine Git-Anmeldeinformationen abrufen " verwenden, um die Konfiguration der Git-Anmeldeinformationen zu überprüfen.

Diese API sollte nach einem erfolgreichen Aufruf der Connect-API aufgerufen werden. Um eine vollständige Synchronisierung des Arbeitsbereichs abzuschließen, verwenden Sie den Vorgang "Erforderliche Aktion ", um den relevanten Synchronisierungsvorgang aufzurufen, entweder Commit für Git oder Update von Git.

Permissions

Der Anrufer muss über eine Administratorarbeitsbereichsrolle verfügen.

Erforderliche delegierte Bereiche

Workspace.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identity Support
User Yes
Service Principal und Verwaltete Identitäten Yes

Interface

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
workspaceId
 path True

string (uuid)

Die Arbeitsbereichs-ID.

Anforderungstext

Name Typ Beschreibung
initializationStrategy

InitializationStrategy

Die Strategie, die für einen Initialisierungsprozess erforderlich ist, wenn Inhalte sowohl auf der Remoteseite als auch auf der Arbeitsbereichseite vorhanden sind. Zusätzliche Strategien können im Laufe der Zeit hinzugefügt werden.

Antworten

Name Typ Beschreibung
200 OK

InitializeGitConnectionResponse

Die Anforderung wurde erfolgreich abgeschlossen.
202 Accepted

Anforderung akzeptiert, Verbindung in Bearbeitung initialisieren.

Header

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

ErrorResponse

Häufige Fehlercodes:

  • WorkspaceNotConnectedToGit – Arbeitsbereich ist nicht mit Git verbunden.

  • WorkspaceHasNoCapacityAssigned – Keine Kapazität zugewiesen für Arbeitsbereich.

  • MissingInitializationPolicy – Initialisierungsrichtlinie fehlt.

  • InsufficientPrivileges – Der Aufrufer verfügt nicht über ausreichende Berechtigungen für den Arbeitsbereich.

  • PrincipalTypeNotSupported – Der Identitätstyp des Anrufers wird nicht unterstützt.

Beispiele

Initialize the connection of a workspace connected to a Git example

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
200 
{
  "requiredAction": "UpdateFromGit",
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705"
}
Statuscode:
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

Definitionen

Name Beschreibung
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.
InitializationStrategy

Die Strategie, die für einen Initialisierungsprozess erforderlich ist, wenn Inhalte sowohl auf der Remoteseite als auch auf der Arbeitsbereichseite vorhanden sind. Zusätzliche Strategien können im Laufe der Zeit hinzugefügt werden.
InitializeGitConnectionRequest

Enthält die Initialisierung von Git-Verbindungsanforderungsdaten.
InitializeGitConnectionResponse

Enthält die Git-Verbindungsantwortdaten initialisieren.
RequiredAction

Erforderliche Aktion nach Abschluss des Initialisierungsprozesses. Zusätzliche Aktionen können im Laufe der Zeit hinzugefügt werden.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name Typ Beschreibung
resourceId

string

Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType

string

Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
moreDetails

ErrorResponseDetails[]

Liste der zusätzlichen Fehlerdetails.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.
requestId

string

ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.

InitializationStrategy

Enumeration

Die Strategie, die für einen Initialisierungsprozess erforderlich ist, wenn Inhalte sowohl auf der Remoteseite als auch auf der Arbeitsbereichseite vorhanden sind. Zusätzliche Strategien können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
None

Keine Strategie definiert.
PreferRemote

Bevorzugen Sie Remote-Git-Seiteninhalte.
PreferWorkspace

Bevorzugen Sie arbeitsbereichseitige Inhalte.

InitializeGitConnectionRequest

Objekt

Enthält die Initialisierung von Git-Verbindungsanforderungsdaten.

Name Typ Beschreibung
initializationStrategy

InitializationStrategy

Die Strategie, die für einen Initialisierungsprozess erforderlich ist, wenn Inhalte sowohl auf der Remoteseite als auch auf der Arbeitsbereichseite vorhanden sind. Zusätzliche Strategien können im Laufe der Zeit hinzugefügt werden.

InitializeGitConnectionResponse

Objekt

Enthält die Git-Verbindungsantwortdaten initialisieren.

Name Typ Beschreibung
remoteCommitHash

string

Vollständiger SHA-Commit-Hash für Remotezugriff.
requiredAction

RequiredAction

Erforderliche Aktion nach Abschluss des Initialisierungsprozesses. Zusätzliche Aktionen können im Laufe der Zeit hinzugefügt werden.
workspaceHead

string

Vollständiger SHA-Hash, mit dem der Arbeitsbereich synchronisiert wird.

RequiredAction

Enumeration

Erforderliche Aktion nach Abschluss des Initialisierungsprozesses. Zusätzliche Aktionen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
None

Es ist keine Aktion erforderlich.
UpdateFromGit

Update von Git ist erforderlich.
CommitToGit

Commit auf Git ist erforderlich.