Git - Initialize Connection

Služba:

Core

Verze rozhraní API:

v1

Inicializuje připojení pro pracovní prostor připojený k Gitu.
Toto rozhraní API podporuje dlouhotrvajících operací (LRO).

Pokud chcete toto rozhraní API použít, musí být přihlašovací údaje Git volajícího nakonfigurované pomocí rozhraní UPDATE MY Git CREDENTIALS API. Ke kontrole konfigurace přihlašovacích údajů Gitu můžete použít rozhraní API Získat moje přihlašovací údaje Gitu .

Toto rozhraní API by se mělo volat po úspěšném volání rozhraní API connect . Pokud chcete dokončit úplnou synchronizaci pracovního prostoru, použijte operaci Povinná akce k volání příslušné operace synchronizace, a to buď potvrzení do Gitu , nebo aktualizace z Gitu.

Permissions

Volající musí mít roli pracovního prostoru správce .

Požadované delegovaná rozsahy

Workspace.ReadWrite.All

Podporované identity Microsoft Entra

Toto rozhraní API podporuje identity Microsoft uvedené v této části.

Identity	Support
User	Yes
Hlavní služba a Spravované identity	Yes

Interface

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
workspaceId	path	True	string (uuid)	ID pracovního prostoru.

Text požadavku

Name	Typ	Description
initializationStrategy	InitializationStrategy	Strategie potřebná pro inicializační proces, pokud existuje obsah na vzdálené straně i na straně pracovního prostoru. V průběhu času je možné přidat další strategie.

Odpovědi

Name	Typ	Description
200 OK	InitializeGitConnectionResponse	Žádost byla úspěšně dokončena.
202 Accepted		Žádost byla přijata a inicializovala probíhající připojení. Hlavičky Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Běžné kódy chyb: WorkspaceNotConnectedToGit – Pracovní prostor není připojený k Gitu. WorkspaceHasNoCapacityAssigned – k pracovnímu prostoru není přiřazena žádná kapacita. MissingInitializationPolicy – Chybí zásada inicializace. InsufficientPrivileges – Volající nemá dostatečná oprávnění k pracovnímu prostoru. PrincipalTypeNotSupported – Typ identity volajícího není podporován.

Příklady

Initialize the connection of a workspace connected to a Git example

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

200

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

Stavový kód:

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

Definice

Name	Description
ErrorRelatedResource	Chyba související s objektem podrobností o prostředku.
ErrorResponse	Odpověď na chybu.
ErrorResponseDetails	Podrobnosti o odpovědi na chybu.
InitializationStrategy	Strategie potřebná pro inicializační proces, pokud existuje obsah na vzdálené straně i na straně pracovního prostoru. V průběhu času je možné přidat další strategie.
InitializeGitConnectionRequest	Obsahuje data inicializace požadavků na připojení Git.
InitializeGitConnectionResponse	Obsahuje data odpovědi na připojení Git inicializace.
RequiredAction	Požadovaná akce po dokončení procesu inicializace V průběhu času se můžou přidat další akce.

ErrorRelatedResource

Objekt

Chyba související s objektem podrobností o prostředku.

Name	Typ	Description
resourceId	string	ID prostředku, které je součástí chyby.
resourceType	string	Typ prostředku, který je součástí chyby.

ErrorResponse

Objekt

Odpověď na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message	string	Lidské čitelné vyjádření chyby.
moreDetails	ErrorResponseDetails[]	Seznam dalších podrobností o chybě
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou
requestId	string	ID požadavku přidruženého k chybě.

ErrorResponseDetails

Objekt

Podrobnosti o odpovědi na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message	string	Lidské čitelné vyjádření chyby.
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou

InitializationStrategy

Výčet

Strategie potřebná pro inicializační proces, pokud existuje obsah na vzdálené straně i na straně pracovního prostoru. V průběhu času je možné přidat další strategie.

Hodnota	Description
None	Nebyla definována žádná strategie.
PreferRemote	Preferujte vzdálený obsah na straně Gitu.
PreferWorkspace	Upřednostněte obsah na straně pracovního prostoru.

InitializeGitConnectionRequest

Objekt

Obsahuje data inicializace požadavků na připojení Git.

Name	Typ	Description
initializationStrategy	InitializationStrategy	Strategie potřebná pro inicializační proces, pokud existuje obsah na vzdálené straně i na straně pracovního prostoru. V průběhu času je možné přidat další strategie.

InitializeGitConnectionResponse

Objekt

Obsahuje data odpovědi na připojení Git inicializace.

Name	Typ	Description
remoteCommitHash	string	Vzdálená úplná hodnota hash potvrzení SHA
requiredAction	RequiredAction	Požadovaná akce po dokončení procesu inicializace V průběhu času se můžou přidat další akce.
workspaceHead	string	Úplná hodnota hash SHA, se kterou se pracovní prostor synchronizuje.

RequiredAction

Výčet

Požadovaná akce po dokončení procesu inicializace V průběhu času se můžou přidat další akce.

Hodnota	Description
None	Nevyžaduje se žádná akce.
UpdateFromGit	Vyžaduje se aktualizace z Gitu.
CommitToGit	Je vyžadováno potvrzení do Gitu.