Git - Update From Git

Dienst:

Core

API-Version:

v1

Aktualisiert den Arbeitsbereich mit Commits, die an die verbundene Verzweigung übertragen werden.
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.

Das Update wirkt sich nur auf Elemente im Arbeitsbereich aus, die in diesen Commits geändert wurden. Wenn nach den Verbindungs- und Initialisierungs-APIs aufgerufen wird, wird ein vollständiges Update des gesamten Arbeitsbereichs ausgeführt.

Erlaubnisse

Der Aufrufer muss einen Mitwirkenden oder eine höhere Arbeitsbereichsrolle haben.

Erforderliche delegierte Bereiche

Workspace.GitUpdate.All

Von Microsoft Entra unterstützte Identitäten

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

Identität	Unterstützung
Benutzer	Ja
Dienstprinzipal und verwaltete Identitäten	Wird nur unterstützt, wenn alle Elemente , die am Dienstprinzipal des Vorgangs beteiligt sind, unterstützt werden

Schnittstelle

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
workspaceId	path	True	string (uuid)	Die Arbeitsbereichs-ID.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
remoteCommitHash	True	string	Vollständiger SHA-Commit-Hash für Remotezugriff.
conflictResolution		WorkspaceConflictResolution	Konfliktauflösung, die im Update von Git-Vorgang verwendet werden soll. Wenn Elemente in Konflikt stehen und keine Konfliktauflösung angegeben ist, wird der Aktualisierungsvorgang nicht gestartet.
options		UpdateOptions	Optionen, die im Update von Git-Vorgang verwendet werden sollen
workspaceHead		string	Vollständiger SHA-Hash, mit dem der Arbeitsbereich synchronisiert wird. Dieser Wert kann erst nach der Initialisierung der Verbindung null sein. In anderen Fällen überprüft das System, dass der angegebene Wert mit dem kopf ausgerichtet ist, der dem System bekannt ist.

Antworten

Name	Typ	Beschreibung
200 OK		Die Anforderung wurde erfolgreich abgeschlossen.
202 Accepted		Anforderung angenommen, Update von Git in Bearbeitung. 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 für den Arbeitsbereich zugewiesen. WorkspaceHeadMismatch – Head in der Anforderung stimmt nicht mit dem Kopf im System überein. WorkspacePreviousOperationInProgress – Vorheriger Vorgang wird noch ausgeführt. Fehlende Abhängigkeit – Eine Abhängigkeit fehlt im Aktualisierungsvorgang. PotentialDuplicateDisplayNameAndType – Der Aktualisierungsvorgang erstellt einen doppelten Anzeigenamen und -typ. DependencyDeletionFailed – Aktualisierungsvorgang löscht die feste Abhängigkeit. InsufficientPrivileges – Der Aufrufer verfügt nicht über ausreichende Arbeitsbereichsberechtigungen. PrincipalTypeNotSupported – Der Identitätstyp des Anrufers wird nicht unterstützt.

Beispiele

Update a workspace using data from a Git example

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

200

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
ConflictResolutionPolicy	Konfliktlösungsrichtlinie. Im Laufe der Zeit können zusätzliche Richtlinien zur Konfliktlösung hinzugefügt werden.
ConflictResolutionType	Konfliktauflösungstyp. Im Laufe der Zeit können weitere Konfliktlösungstypen hinzugefügt werden.
ErrorRelatedResource	Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
UpdateFromGitRequest	Enthält das Update von Git-Anforderungsdaten.
UpdateOptions	Enthält die Optionen, die für das Update von Git aktiviert sind.
WorkspaceConflictResolution	Die grundlegenden Konfliktlösungsdaten.

ConflictResolutionPolicy

Enumeration

Konfliktlösungsrichtlinie. Im Laufe der Zeit können zusätzliche Richtlinien zur Konfliktlösung hinzugefügt werden.

Wert	Beschreibung
PreferRemote	Bevorzugen Sie Remote-Git-Seiteninhalte.
PreferWorkspace	Bevorzugen Sie arbeitsbereichseitige Inhalte.

ConflictResolutionType

Enumeration

Konfliktauflösungstyp. Im Laufe der Zeit können weitere Konfliktlösungstypen hinzugefügt werden.

Wert	Beschreibung
Workspace	Konfliktauflösung, die die Arbeitsbereichsebene darstellt.

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.

UpdateFromGitRequest

Objekt

Enthält das Update von Git-Anforderungsdaten.

Name	Typ	Beschreibung
conflictResolution	WorkspaceConflictResolution	Konfliktauflösung, die im Update von Git-Vorgang verwendet werden soll. Wenn Elemente in Konflikt stehen und keine Konfliktauflösung angegeben ist, wird der Aktualisierungsvorgang nicht gestartet.
options	UpdateOptions	Optionen, die im Update von Git-Vorgang verwendet werden sollen
remoteCommitHash	string	Vollständiger SHA-Commit-Hash für Remotezugriff.
workspaceHead	string	Vollständiger SHA-Hash, mit dem der Arbeitsbereich synchronisiert wird. Dieser Wert kann erst nach der Initialisierung der Verbindung null sein. In anderen Fällen überprüft das System, dass der angegebene Wert mit dem kopf ausgerichtet ist, der dem System bekannt ist.

UpdateOptions

Objekt

Enthält die Optionen, die für das Update von Git aktiviert sind.

Name	Typ	Beschreibung
allowOverrideItems	boolean	Der Benutzer stimmt zu, eingehende Elemente während des Updates von Git außer Kraft zu setzen. Wenn eingehende Elemente vorhanden sind und die zulassenden Außerkraftsetzungselemente nicht angegeben oder als "false" angegeben werden, wird der Aktualisierungsvorgang nicht gestartet. Der Standardwert ist "false".

WorkspaceConflictResolution

Objekt

Die grundlegenden Konfliktlösungsdaten.

Name	Typ	Beschreibung
conflictResolutionPolicy	ConflictResolutionPolicy	Konfliktlösungsrichtlinie. Im Laufe der Zeit können zusätzliche Richtlinien zur Konfliktlösung hinzugefügt werden.
conflictResolutionType	ConflictResolutionType	Konfliktauflösungstyp. Im Laufe der Zeit können weitere Konfliktlösungstypen hinzugefügt werden.