Git - Update From Git

Usługa:: Core

Wersja interfejsu API:: v1

Aktualizuje obszar roboczy za pomocą zatwierdzeń wypychanych do połączonej gałęzi.
Ten interfejs API obsługuje długotrwałych operacji (LRO).

Aby można było używać tego interfejsu API, należy skonfigurować poświadczenia usługi Git elementu wywołującego przy użyciu interfejsu API Aktualizacji poświadczeń usługi Git . Aby sprawdzić konfigurację poświadczeń usługi Git, możesz użyć interfejsu API Uzyskiwanie poświadczeń usługi Git .

Aktualizacja ma wpływ tylko na elementy w obszarze roboczym, które zostały zmienione w tych zatwierdzeniach. Jeśli zostanie wywołana po interfejsach API łączenia i inicjowania połączenia , wykona pełną aktualizację całego obszaru roboczego.

Uprawnienia

Obiekt wywołujący musi mieć rolę współautora lub nowszego obszaru roboczego.

Wymagane zakresy delegowane

Workspace.GitUpdate.All

Tożsamości obsługiwane przez Microsoft Entra

Ten interfejs API obsługuje tożsamości firmy Microsoft wymienione w tej sekcji.

Tożsamość	Wsparcie
Użytkownik	Tak
Główne usługi i Tożsamości zarządzane	Obsługiwane tylko wtedy, gdy wszystkie elementy zaangażowane w operację obsługują jednostki usługi

Interfejs

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
workspaceId	path	True	string (uuid)	Identyfikator obszaru roboczego.

Treść żądania

Nazwa	Wymagane	Typ	Opis
remoteCommitHash	True	string	Zdalny pełny skrót zatwierdzenia SHA.
conflictResolution		WorkspaceConflictResolution	Rozwiązanie konfliktu, które ma być używane w aktualizacji z operacji git. Jeśli elementy są w konflikcie i nie określono rozwiązania konfliktu, operacja aktualizacji nie zostanie uruchomiona.
options		UpdateOptions	Opcje, które mają być używane w aktualizacji z operacji git
workspaceHead		string	Pełny skrót SHA synchronizowany z obszarem roboczym. Ta wartość może mieć wartość null tylko po zainicjowaniu połączenia. W innych przypadkach system sprawdzi, czy dana wartość jest zgodna z głową znaną systemowi.

Odpowiedzi

Nazwa	Typ	Opis
200 OK		Żądanie zostało ukończone pomyślnie.
202 Accepted		Żądanie zaakceptowane, aktualizacja z usługi Git w toku. Nagłówki Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący `Retry-After` w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań. Nagłówki Retry-After: integer
Other Status Codes	ErrorResponse	Typowe kody błędów: WorkspaceNotConnectedToGit — obszar roboczy nie jest połączony z usługą git. WorkspaceHasNoCapacityAssigned — brak pojemności przypisanej do obszaru roboczego. WorkspaceHeadMismatch — nagłówek w żądaniu nie pasuje do nagłówka w systemie. WorkspacePreviousOperationInProgress — poprzednia operacja jest nadal w toku. MissingDependency — brak zależności w operacji aktualizacji. PotentialDuplicateDisplayNameAndType — operacja aktualizacji spowoduje utworzenie zduplikowanej nazwy wyświetlanej i typu. DependencyDeletionFailed — operacja aktualizacji spowoduje usunięcie twardej zależności. InsufficientPrivileges — obiekt wywołujący nie ma wystarczających uprawnień obszaru roboczego. PrincipalTypeNotSupported — typ tożsamości obiektu wywołującego nie jest obsługiwany.

Przykłady

Update a workspace from Git with options example

Update a workspace using data from a Git example

Update a workspace from Git with options example

Przykładowe żądanie

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,
    "itemOptionsByLogicalId": [
      {
        "logicalId": "88436e65-6ed1-8185-49ff-f61077fc73d4",
        "options": {
          "validateOnly": true
        }
      }
    ]
  }
}

Przykładowa odpowiedź

Kod stanu:: 200

Kod stanu:: 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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 200

Kod stanu:: 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

Definicje

Nazwa	Opis
ConflictResolutionPolicy	Zasady rozwiązywania konfliktów. Dodatkowe zasady rozwiązywania konfliktów można dodawać z upływem czasu.
ConflictResolutionType	Typ rozwiązywania konfliktów. Dodatkowe typy rozwiązywania konfliktów można dodawać z upływem czasu.
ErrorParameter	Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
ItemOptionsByLogicalIdEntry	Wpis opcji poszczególnych elementów, który jest przeznaczony dla jego elementu według identyfikatora logicznego. Każdy element docelowy może być wyświetlany co najwyżej raz.
UpdateFromGitRequest	Zawiera aktualizację z danych żądania Git.
UpdateOptions	Zawiera opcje włączone dla aktualizacji z usługi Git.
WorkspaceConflictResolution	Podstawowe dane rozwiązywania konfliktów.

ConflictResolutionPolicy

Wyliczenie

Zasady rozwiązywania konfliktów. Dodatkowe zasady rozwiązywania konfliktów można dodawać z upływem czasu.

Wartość	Opis
PreferRemote	Preferuj zdalną zawartość po stronie usługi Git.
PreferWorkspace	Preferuj zawartość po stronie obszaru roboczego.

ConflictResolutionType

Wyliczenie

Typ rozwiązywania konfliktów. Dodatkowe typy rozwiązywania konfliktów można dodawać z upływem czasu.

Wartość	Opis
Workspace	Rozwiązywanie konfliktów reprezentujące poziom obszaru roboczego.

ErrorParameter

Objekt

Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.

Nazwa	Typ	Opis
message	string	Czytelny dla człowieka opis znaczenia parametru.
name	string	Identyfikator parametru.
value	string	Wartość parametru.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa	Typ	Opis
resourceId	string	Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType	string	Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
isRetriable	boolean	Jeśli to prawda, żądanie można ponowić. Użyj nagłówka `Retry-After` odpowiedzi, aby określić opóźnienie, jeśli jest dostępne.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
parameters	ErrorParameter[]	Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string (uuid)	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
parameters	ErrorParameter[]	Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.

ItemOptionsByLogicalIdEntry

Objekt

Wpis opcji poszczególnych elementów, który jest przeznaczony dla jego elementu według identyfikatora logicznego. Każdy element docelowy może być wyświetlany co najwyżej raz.

Nazwa	Typ	Opis
logicalId	string (uuid)	Identyfikator logiczny elementu docelowego.
options	object	Opcje elementu docelowego. Nazwy właściwości są nazwami opcji prawidłowymi dla typu elementu; wartości to wartości opcji. Aby uzyskać opcje obsługiwane przez określony typ elementu, zobacz dokumentację interfejsu `Update-Definition` API tego typu elementu.

UpdateFromGitRequest

Objekt

Zawiera aktualizację z danych żądania Git.

Nazwa	Typ	Opis
conflictResolution	WorkspaceConflictResolution	Rozwiązanie konfliktu, które ma być używane w aktualizacji z operacji git. Jeśli elementy są w konflikcie i nie określono rozwiązania konfliktu, operacja aktualizacji nie zostanie uruchomiona.
options	UpdateOptions	Opcje, które mają być używane w aktualizacji z operacji git
remoteCommitHash	string	Zdalny pełny skrót zatwierdzenia SHA.
workspaceHead	string	Pełny skrót SHA synchronizowany z obszarem roboczym. Ta wartość może mieć wartość null tylko po zainicjowaniu połączenia. W innych przypadkach system sprawdzi, czy dana wartość jest zgodna z głową znaną systemowi.

UpdateOptions

Objekt

Zawiera opcje włączone dla aktualizacji z usługi Git.

Nazwa	Typ	Opis
allowOverrideItems	boolean	Zgoda użytkownika na zastępowanie elementów przychodzących podczas procesu aktualizacji z usługi Git. Gdy elementy przychodzące są obecne i pozycja zezwalania na przesłanianie nie jest określona lub jest podana jako false, operacja aktualizacji nie zostanie uruchomiona. Wartość domyślna to false.
itemOptionsByLogicalId	ItemOptionsByLogicalIdEntry[]	Opcje aktualizacji poszczególnych elementów. Każdy wpis jest przeznaczony dla jego elementu według identyfikatora logicznego i stosuje jego opcje do tego elementu.

WorkspaceConflictResolution

Objekt

Podstawowe dane rozwiązywania konfliktów.

Nazwa	Typ	Opis
conflictResolutionPolicy	ConflictResolutionPolicy	Zasady rozwiązywania konfliktów. Dodatkowe zasady rozwiązywania konfliktów można dodawać z upływem czasu.
conflictResolutionType	ConflictResolutionType	Typ rozwiązywania konfliktów. Dodatkowe typy rozwiązywania konfliktów można dodawać z upływem czasu.