Del via

Git - Initialize Connection

Tjeneste:
Core
API-version:
v1

Initialiser en forbindelse for et arbejdsområde, der har forbindelse til Git.
Denne API understøtter LRO-handlinger (Long Running Operations).

Hvis du vil bruge denne API, skal den kaldendes Git-legitimationsoplysninger konfigureres ved hjælp af API'en Opdater Mine Git-legitimationsoplysninger . Du kan bruge API'en Hent Mine Git-legitimationsoplysninger til at kontrollere konfigurationen af Git-legitimationsoplysningerne.

Denne API skal kaldes efter et vellykket kald til Connect-API'en. Hvis du vil fuldføre en fuld synkronisering af arbejdsområdet, skal du bruge handlingen Påkrævet handling til at kalde den relevante synkroniseringshandling, enten Bekræft til Git eller Opdater fra Git.

Permissions

Den, der ringer op, skal have en administratorarbejdsområderolle.

Påkrævede delegerede områder

Workspace.ReadWrite.All

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identity Support
User Yes
tjenesteprincipal og administrerede identiteter Yes

Interface

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

URI-parametre

Name I Påkrævet Type Beskrivelse
workspaceId
 path True

string (uuid)

Arbejdsområde-id'et.

Brødtekst for anmodning

Name Type Beskrivelse
initializationStrategy

InitializationStrategy

Den strategi, der kræves til en initialiseringsproces, når indhold findes på både fjernsiden og arbejdsområdesiden. Der kan tilføjes yderligere strategier over tid.

Svar

Name Type Beskrivelse
200 OK

InitializeGitConnectionResponse

Anmodningen blev fuldført.
202 Accepted

Anmodningen er accepteret. Initialiser forbindelsen er i gang.

Headere

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Almindelige fejlkoder:

  • WorkspaceNotConnectedToGit – Arbejdsområdet har ikke forbindelse til git.

  • WorkspaceHasNoCapacityAssigned – Der er ikke tildelt nogen kapacitet til arbejdsområdet.

  • MissingInitializationPolicy – Initialiseringspolitikken mangler.

  • InsufficientPrivileges – Den kaldende bruger har ikke tilstrækkelige tilladelser til arbejdsområdet.

  • PrincipalTypeNotSupported – Opkaldsidentitetstypen understøttes ikke.

Eksempler

Initialize the connection of a workspace connected to a Git example

Eksempelanmodning

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

Eksempelsvar

Statuskode:
200 
{
  "requiredAction": "UpdateFromGit",
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705"
}
Statuskode:
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 Beskrivelse
ErrorRelatedResource

Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse

Fejlsvaret.
ErrorResponseDetails

Oplysninger om fejlsvar.
InitializationStrategy

Den strategi, der kræves til en initialiseringsproces, når indhold findes på både fjernsiden og arbejdsområdesiden. Der kan tilføjes yderligere strategier over tid.
InitializeGitConnectionRequest

Indeholder dataene til initialisering af Git-forbindelsesanmodningen.
InitializeGitConnectionResponse

Indeholder initialiser Svardata for Git-forbindelse.
RequiredAction

Påkrævet handling, når initialiseringsprocessen er afsluttet. Der kan tilføjes yderligere handlinger over tid.

ErrorRelatedResource

Object

Objektet med fejlrelaterede ressourceoplysninger.

Name Type Beskrivelse
resourceId

string

Det ressource-id, der er involveret i fejlen.
resourceType

string

Typen af ressource, der er involveret i fejlen.

ErrorResponse

Object

Fejlsvaret.

Name Type Beskrivelse
errorCode

string

Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message

string

En menneskelig læsbar gengivelse af fejlen.
moreDetails

ErrorResponseDetails[]

Liste over yderligere oplysninger om fejl.
relatedResource

ErrorRelatedResource

De fejlrelaterede ressourceoplysninger.
requestId

string

Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Object

Oplysninger om fejlsvar.

Name Type Beskrivelse
errorCode

string

Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message

string

En menneskelig læsbar gengivelse af fejlen.
relatedResource

ErrorRelatedResource

De fejlrelaterede ressourceoplysninger.

InitializationStrategy

Optælling

Den strategi, der kræves til en initialiseringsproces, når indhold findes på både fjernsiden og arbejdsområdesiden. Der kan tilføjes yderligere strategier over tid.

Værdi Beskrivelse
None

Der er ikke defineret nogen strategi.
PreferRemote

Foretrækker fjernindhold på Git-siden.
PreferWorkspace

Foretrækker indhold på arbejdsområdesiden.

InitializeGitConnectionRequest

Object

Indeholder dataene til initialisering af Git-forbindelsesanmodningen.

Name Type Beskrivelse
initializationStrategy

InitializationStrategy

Den strategi, der kræves til en initialiseringsproces, når indhold findes på både fjernsiden og arbejdsområdesiden. Der kan tilføjes yderligere strategier over tid.

InitializeGitConnectionResponse

Object

Indeholder initialiser Svardata for Git-forbindelse.

Name Type Beskrivelse
remoteCommitHash

string

Fuldstændig SHA-bekræftelses-hash for fjernforbindelse.
requiredAction

RequiredAction

Påkrævet handling, når initialiseringsprocessen er afsluttet. Der kan tilføjes yderligere handlinger over tid.
workspaceHead

string

Fuld SHA-hash, som arbejdsområdet synkroniseres til.

RequiredAction

Optælling

Påkrævet handling, når initialiseringsprocessen er afsluttet. Der kan tilføjes yderligere handlinger over tid.

Værdi Beskrivelse
None

Der kræves ingen handling.
UpdateFromGit

Opdatering fra Git er påkrævet.
CommitToGit

Commit to Git er påkrævet.