Del via

Git - Initialize Connection

Tjeneste:
Core
API-versjon:
v1

Initialiser en tilkobling for et arbeidsområde som er koblet til Git.
Denne API-en støtter langvarige operasjoner (LRO).

Hvis du vil bruke denne API-en, må oppringerens Git-legitimasjon konfigureres ved hjelp av API-en for Oppdater Min Git-legitimasjon . Du kan bruke API-en Hent Min Git-legitimasjon til å kontrollere konfigurasjonen av Git-legitimasjon.

Denne API-en skal kalles opp etter et vellykket kall til Connect-API-en. Hvis du vil fullføre en fullstendig synkronisering av arbeidsområdet, bruker du operasjonen Obligatorisk handling til å kalle den relevante synkroniseringsoperasjonen, enten Utfør til Git eller Oppdater fra Git.

Permissions

Innringeren må ha en arbeidsområderolle for administratorer .

Nødvendige delegerte omfang

Workspace.ReadWrite.All

Microsoft Entra-støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identity Support
User Yes
tjenestekontohaver og administrerte identiteter Yes

Interface

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

URI-parametere

Navn I Obligatorisk Type Beskrivelse
workspaceId
 path True

string (uuid)

Arbeidsområde-ID-en.

Brødtekst for forespørsel

Navn Type Beskrivelse
initializationStrategy

InitializationStrategy

Strategien som kreves for en initialiseringsprosess når innhold finnes både på den eksterne siden og på arbeidsområdesiden. Flere strategier kan legges til over tid.

Svar

Navn Type Beskrivelse
200 OK

InitializeGitConnectionResponse

Forespørselen er fullført.
202 Accepted

Forespørsel godtatt, initialiser tilkobling pågår.

Overskrifter

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

ErrorResponse

Vanlige feilkoder:

  • WorkspaceNotConnectedToGit – arbeidsområdet er ikke koblet til git.

  • WorkspaceHasNoCapacityAssigned – ingen kapasitet tilordnet arbeidsområdet.

  • MissingInitializationPolicy – Initialiseringspolicy mangler.

  • InsufficientPrivileges – Innringeren har ikke tilstrekkelige tillatelser på arbeidsområdet.

  • PrincipalTypeNotSupported – identitetstypen Anroper støttes ikke.

Eksempler

Initialize the connection of a workspace connected to a Git example

Eksempelforespørsel

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

Definisjoner

Navn Beskrivelse
ErrorRelatedResource

Objektet for feilrelaterte ressursdetaljer.
ErrorResponse

Feilsvaret.
ErrorResponseDetails

Feilsvardetaljene.
InitializationStrategy

Strategien som kreves for en initialiseringsprosess når innhold finnes både på den eksterne siden og på arbeidsområdesiden. Flere strategier kan legges til over tid.
InitializeGitConnectionRequest

Inneholder dataene for git-tilkoblingsforespørsel for initialisering.
InitializeGitConnectionResponse

Inneholder svardataene for Git-tilkoblingen som initialiseres.
RequiredAction

Obligatorisk handling etter at initialiseringsprosessen er fullført. Flere handlinger kan legges til over tid.

ErrorRelatedResource

Object

Objektet for feilrelaterte ressursdetaljer.

Navn Type Beskrivelse
resourceId

string

Ressurs-ID-en som er involvert i feilen.
resourceType

string

Typen ressurs som er involvert i feilen.

ErrorResponse

Object

Feilsvaret.

Navn Type Beskrivelse
errorCode

string

En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message

string

En menneskelig lesbar representasjon av feilen.
moreDetails

ErrorResponseDetails[]

Liste over flere feildetaljer.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.
requestId

string

ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Object

Feilsvardetaljene.

Navn Type Beskrivelse
errorCode

string

En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message

string

En menneskelig lesbar representasjon av feilen.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.

InitializationStrategy

Opplisting

Strategien som kreves for en initialiseringsprosess når innhold finnes både på den eksterne siden og på arbeidsområdesiden. Flere strategier kan legges til over tid.

Verdi Beskrivelse
None

Ingen strategi er definert.
PreferRemote

Foretrekker eksternt Git-sideinnhold.
PreferWorkspace

Foretrekker arbeidsområdesideinnhold.

InitializeGitConnectionRequest

Object

Inneholder dataene for git-tilkoblingsforespørsel for initialisering.

Navn Type Beskrivelse
initializationStrategy

InitializationStrategy

Strategien som kreves for en initialiseringsprosess når innhold finnes både på den eksterne siden og på arbeidsområdesiden. Flere strategier kan legges til over tid.

InitializeGitConnectionResponse

Object

Inneholder svardataene for Git-tilkoblingen som initialiseres.

Navn Type Beskrivelse
remoteCommitHash

string

Ekstern fullstendig SHA-utføringsnummer.
requiredAction

RequiredAction

Obligatorisk handling etter at initialiseringsprosessen er fullført. Flere handlinger kan legges til over tid.
workspaceHead

string

Fullstendig SHA-hash som arbeidsområdet er synkronisert til.

RequiredAction

Opplisting

Obligatorisk handling etter at initialiseringsprosessen er fullført. Flere handlinger kan legges til over tid.

Verdi Beskrivelse
None

Ingen handling er nødvendig.
UpdateFromGit

Oppdatering fra Git kreves.
CommitToGit

Utfør til Git er nødvendig.