Git - Initialize Connection

Usługa:

Core

Wersja interfejsu API:

v1

Zainicjuj połączenie dla obszaru roboczego połączonego z usługą Git.
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 .

Ten interfejs API powinien być wywoływany po pomyślnym wywołaniu interfejsu API connect . Aby ukończyć pełną synchronizację obszaru roboczego, użyj operacji Wymagane działanie, aby wywołać odpowiednią operację synchronizacji— Zatwierdź do usługi Git lub Zaktualizuj z usługi Git.

Permissions

Obiekt wywołujący musi mieć rolę obszaru roboczego administratora.

Wymagane zakresy delegowane

Workspace.ReadWrite.All

Tożsamości obsługiwane przez Microsoft Entra

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Identity	Support
User	Yes
Główne usługi i Tożsamości zarządzane	Yes

Interface

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

Parametry identyfikatora URI

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

Treść żądania

Nazwa	Typ	Opis
initializationStrategy	InitializationStrategy	Strategia wymagana do procesu inicjowania, gdy zawartość istnieje zarówno po stronie zdalnej, jak i po stronie obszaru roboczego. Dodatkowe strategie mogą być dodawane w czasie.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	InitializeGitConnectionResponse	Żądanie zostało ukończone pomyślnie.
202 Accepted		Żądanie zaakceptowane, inicjowanie połączenia w toku. Nagłówki Location: string x-ms-operation-id: string 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. MissingInitializationPolicy — brak zasad inicjowania. InsufficientPrivileges — obiekt wywołujący nie ma wystarczających uprawnień w obszarze roboczym. PrincipalTypeNotSupported — typ tożsamości obiektu wywołującego nie jest obsługiwany.

Przykłady

Initialize the connection of a workspace connected to a Git example

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

200

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

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
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
InitializationStrategy	Strategia wymagana do procesu inicjowania, gdy zawartość istnieje zarówno po stronie zdalnej, jak i po stronie obszaru roboczego. Dodatkowe strategie mogą być dodawane w czasie.
InitializeGitConnectionRequest	Zawiera dane inicjowania żądania połączenia Usługi Git.
InitializeGitConnectionResponse	Zawiera inicjowanie danych odpowiedzi na połączenie usługi Git.
RequiredAction	Wymagana akcja po zakończeniu procesu inicjowania. Dodatkowe akcje mogą być dodawane w czasie.

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.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string	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.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.

InitializationStrategy

Wyliczanie

Strategia wymagana do procesu inicjowania, gdy zawartość istnieje zarówno po stronie zdalnej, jak i po stronie obszaru roboczego. Dodatkowe strategie mogą być dodawane w czasie.

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

InitializeGitConnectionRequest

Objekt

Zawiera dane inicjowania żądania połączenia Usługi Git.

Nazwa	Typ	Opis
initializationStrategy	InitializationStrategy	Strategia wymagana do procesu inicjowania, gdy zawartość istnieje zarówno po stronie zdalnej, jak i po stronie obszaru roboczego. Dodatkowe strategie mogą być dodawane w czasie.

InitializeGitConnectionResponse

Objekt

Zawiera inicjowanie danych odpowiedzi na połączenie usługi Git.

Nazwa	Typ	Opis
remoteCommitHash	string	Zdalny pełny skrót zatwierdzenia SHA.
requiredAction	RequiredAction	Wymagana akcja po zakończeniu procesu inicjowania. Dodatkowe akcje mogą być dodawane w czasie.
workspaceHead	string	Pełny skrót SHA synchronizowany z obszarem roboczym.

RequiredAction

Wyliczanie

Wymagana akcja po zakończeniu procesu inicjowania. Dodatkowe akcje mogą być dodawane w czasie.

Wartość	Opis
None	Nie jest wymagana żadna akcja.
UpdateFromGit	Aktualizacja z usługi Git jest wymagana.
CommitToGit	Zatwierdzenie w usłudze Git jest wymagane.