Git - Initialize Connection

Služba:

Core

Verzia rozhrania API:

v1

Inicializácia pripojenia pre pracovný priestor, ktorý je pripojený k systému Git.
Toto rozhranie API podporuje dlhotrvajúce operácie (LRO).

Na používanie tohto rozhrania API musia byť poverenia Git volajúceho nakonfigurované pomocou rozhrania API Aktualizovať moje poverenia Git . Na kontrolu konfigurácie poverení Git môžete použiť rozhranie API Načítať moje poverenia Git .

Toto rozhranie API by sa malo volať po úspešnom volaní rozhrania API pripojenia . Na dokončenie úplnej synchronizácie pracovného priestoru použite operáciu Požadovaná akcia , ktorá vyvolá príslušnú operáciu synchronizácie– Potvrdiť v Git alebo Aktualizovať zo systému Git.

Permissions

Volajúci musí mať rolu pracovného priestoru správcu .

Povinné delegované rozsahy

Workspace.ReadWrite.All

Podporované identity v aplikácii Microsoft Entra

Toto rozhranie API podporuje identity Microsoft uvedené v tejto časti.

Identity	Support
User	Yes
Objekt služby a spravované identity	Yes

Interface

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

Parametre URI

Name	V	Povinné	Typ	Description
workspaceId	path	True	string (uuid)	ID pracovného priestoru.

Text požiadavky

Name	Typ	Description
initializationStrategy	InitializationStrategy	Stratégia potrebná na inicializačný proces, keď existuje obsah na vzdialenej aj strane pracovného priestoru. V priebehu času je možné pridať ďalšie stratégie.

Odpovede

Name	Typ	Description
200 OK	InitializeGitConnectionResponse	Požiadavka sa úspešne dokončila.
202 Accepted		Požiadavka prijatá, inicializácia prebiehajúceho pripojenia. Hlavičky Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Prekročil sa limit rýchlosti služby. Server vráti hlavičku Retry-After v sekundách, ako dlho musí klient počkať, kým odošle ďalšie požiadavky. Hlavičky Retry-After: integer
Other Status Codes	ErrorResponse	Bežné kódy chýb: WorkspaceNotConnectedToGit – pracovný priestor nie je pripojený k službe git. WorkspaceHasNoCapacityAssigned – žiadna kapacita priradená k pracovnému priestoru. MissingInitializationPolicy – chýba politika inicializácie. InsufficientPrivileges – volajúci nemá dostatočné povolenia pre pracovný priestor. PrincipalTypeNotSupported – Typ identity volajúceho nie je podporovaný.

Príklady

Initialize the connection of a workspace connected to a Git example

Vzorová požiadavka

HTTP

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

Vzorová odpoveď

Kód stavu:

200

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

Kód stavu:

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

Definície

Name	Description
ErrorRelatedResource	Objekt s podrobnosťami o zdroji súvisiacej s chybou.
ErrorResponse	Odpoveď na chybu.
ErrorResponseDetails	Podrobnosti o chybovej odpovedi.
InitializationStrategy	Stratégia potrebná na inicializačný proces, keď existuje obsah na vzdialenej aj strane pracovného priestoru. V priebehu času je možné pridať ďalšie stratégie.
InitializeGitConnectionRequest	Obsahuje inicializujte údaje žiadosti o pripojenie systému Git.
InitializeGitConnectionResponse	Obsahuje inicializáciu údajov odpovede pripojenia Git.
RequiredAction	Požadovaná akcia po dokončení procesu inicializácie. V priebehu času je možné pridať ďalšie akcie.

ErrorRelatedResource

Object

Objekt s podrobnosťami o zdroji súvisiacej s chybou.

Name	Typ	Description
resourceId	string	ID prostriedku, ktoré je súčasťou chyby.
resourceType	string	Typ prostriedku, ktorý je zapojený do chyby.

ErrorResponse

Object

Odpoveď na chybu.

Name	Typ	Description
errorCode	string	Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
message	string	Zobrazenie chyby čitateľné ľuďmi.
moreDetails	ErrorResponseDetails[]	Zoznam ďalších podrobností o chybe.
relatedResource	ErrorRelatedResource	Podrobnosti o zdrojoch súvisiacich s chybou.
requestId	string (uuid)	ID požiadavky súvisiacej s chybou.

ErrorResponseDetails

Object

Podrobnosti o chybovej odpovedi.

Name	Typ	Description
errorCode	string	Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
message	string	Zobrazenie chyby čitateľné ľuďmi.
relatedResource	ErrorRelatedResource	Podrobnosti o zdrojoch súvisiacich s chybou.

InitializationStrategy

Enumerácia

Stratégia potrebná na inicializačný proces, keď existuje obsah na vzdialenej aj strane pracovného priestoru. V priebehu času je možné pridať ďalšie stratégie.

Hodnota	Description
None	Bez definovanej stratégie.
PreferRemote	Preferujte vzdialený obsah na strane Git.
PreferWorkspace	Preferujte obsah na strane pracovného priestoru.

InitializeGitConnectionRequest

Object

Obsahuje inicializujte údaje žiadosti o pripojenie systému Git.

Name	Typ	Description
initializationStrategy	InitializationStrategy	Stratégia potrebná na inicializačný proces, keď existuje obsah na vzdialenej aj strane pracovného priestoru. V priebehu času je možné pridať ďalšie stratégie.

InitializeGitConnectionResponse

Object

Obsahuje inicializáciu údajov odpovede pripojenia Git.

Name	Typ	Description
remoteCommitHash	string	Vzdialená úplná hash hlásenia SHA.
requiredAction	RequiredAction	Požadovaná akcia po dokončení procesu inicializácie. V priebehu času je možné pridať ďalšie akcie.
workspaceHead	string	Celkový hash SHA, s ktorým je pracovný priestor synchronizovaný.

RequiredAction

Enumerácia

Požadovaná akcia po dokončení procesu inicializácie. V priebehu času je možné pridať ďalšie akcie.

Hodnota	Description
None	Nevyžaduje sa žiadna akcia.
UpdateFromGit	Vyžaduje sa aktualizácia zo systému Git.
CommitToGit	Vyžaduje sa potvrdenie pre Git.