Git - Initialize Connection

Tjänst:

Core

API-version:

v1

Initiera en anslutning för en arbetsyta som är ansluten till Git.
Det här API:et stöder tidskrävande åtgärder (LRO).

Om du vill använda det här API:et måste anroparens Git-autentiseringsuppgifter konfigureras med api:et Uppdatera mina Git-autentiseringsuppgifter . Du kan använda API:et Hämta mina Git-autentiseringsuppgifter för att kontrollera konfigurationen av Git-autentiseringsuppgifter.

Det här API:et ska anropas efter ett lyckat anrop till Connect-API :et. Om du vill slutföra en fullständig synkronisering av arbetsytan använder du åtgärden Nödvändig åtgärd för att anropa relevant synkroniseringsåtgärd, antingen Checka in till Git eller Uppdatera från Git.

Permissions

Anroparen måste ha en administratörsroll för arbetsytan.

Obligatoriska delegerade omfång

Workspace.ReadWrite.All

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identity	Support
User	Yes
Tjänsthuvudnamn och hanterade identiteter	Yes

Interface

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
workspaceId	path	True	string (uuid)	Arbetsmiljöns ID.

Begärandetext

Name	Typ	Description
initializationStrategy	InitializationStrategy	Den strategi som krävs för en initieringsprocess när innehåll finns på både fjärrsidan och arbetsytans sida. Ytterligare strategier kan läggas till över tid.

Svar

Name	Typ	Description
200 OK	InitializeGitConnectionResponse	Begäran har slutförts.
202 Accepted		Begäran har godkänts och initierar pågående anslutning. Sidhuvuden Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Vanliga felkoder: ArbetsytaNotConnectedToGit – Arbetsytan är inte ansluten till git. ArbetsytaHasNoCapacityAssigned – Ingen kapacitet tilldelad till Arbetsyta. MissingInitializationPolicy – Initieringsprincipen saknas. InsufficientPrivileges – anroparen har inte tillräcklig behörighet på arbetsytan. PrincipalTypeNotSupported – Nummerpresentationstypen stöds inte.

Exempel

Initialize the connection of a workspace connected to a Git example

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

200

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

Statuskod:

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

Definitioner

Name	Description
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
InitializationStrategy	Den strategi som krävs för en initieringsprocess när innehåll finns på både fjärrsidan och arbetsytans sida. Ytterligare strategier kan läggas till över tid.
InitializeGitConnectionRequest	Innehåller initieringsdata för Git-anslutningsbegäran.
InitializeGitConnectionResponse	Innehåller initiering av Svarsdata för Git-anslutning.
RequiredAction	Nödvändig åtgärd när initieringsprocessen har slutförts. Ytterligare åtgärder kan läggas till över tid.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name	Typ	Description
resourceId	string	Det resurs-ID som ingår i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.
requestId	string	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.

InitializationStrategy

Uppräkning

Den strategi som krävs för en initieringsprocess när innehåll finns på både fjärrsidan och arbetsytans sida. Ytterligare strategier kan läggas till över tid.

Värde	Description
None	Ingen strategi har definierats.
PreferRemote	Föredrar fjärranslutet Innehåll på Git-sidan.
PreferWorkspace	Föredrar innehåll på arbetsytans sida.

InitializeGitConnectionRequest

Objekt

Innehåller initieringsdata för Git-anslutningsbegäran.

Name	Typ	Description
initializationStrategy	InitializationStrategy	Den strategi som krävs för en initieringsprocess när innehåll finns på både fjärrsidan och arbetsytans sida. Ytterligare strategier kan läggas till över tid.

InitializeGitConnectionResponse

Objekt

Innehåller initiering av Svarsdata för Git-anslutning.

Name	Typ	Description
remoteCommitHash	string	Fullständig SHA-incheckningshash för fjärranslutning.
requiredAction	RequiredAction	Nödvändig åtgärd när initieringsprocessen har slutförts. Ytterligare åtgärder kan läggas till över tid.
workspaceHead	string	Fullständig SHA-hash som arbetsytan synkroniseras till.

RequiredAction

Uppräkning

Nödvändig åtgärd när initieringsprocessen har slutförts. Ytterligare åtgärder kan läggas till över tid.

Värde	Description
None	Ingen åtgärd krävs.
UpdateFromGit	Uppdatering från Git krävs.
CommitToGit	Incheckning till Git krävs.