Git - Update From Git

Tjeneste:: Core

API-versjon:: v1

Oppdaterer arbeidsområdet med utføringer som sendes til den tilkoblede grenen.
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.

Oppdateringen påvirker bare elementer i arbeidsområdet som ble endret i disse utføringene. Hvis den kalles etter tilkoblings-API-ene for Tilkobling og Initialiser , utføres en fullstendig oppdatering av hele arbeidsområdet.

Tillatelser

Innringeren må ha en bidragsyter eller høyere arbeidsområderolle.

Nødvendige delegerte omfang

Workspace.GitUpdate.All

Microsoft Entra-støttede identiteter

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

Identitet	Støtte
Bruker	Ja
tjenestekontohaver og administrerte identiteter	Støttes bare når alle elementene som er involvert i tjenestekontohaverne for operasjonsstøtte

Grensesnitt

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

URI-parametere

Name	I	Obligatorisk	Type	Beskrivelse
workspaceId	path	True	string (uuid)	Arbeidsområde-ID-en.

Brødtekst for forespørsel

Name	Obligatorisk	Type	Beskrivelse
remoteCommitHash	True	string	Ekstern fullstendig SHA-utføringsnummer.
conflictResolution		WorkspaceConflictResolution	Konfliktløsning som skal brukes i oppdateringen fra Git-operasjonen. Hvis elementer er i konflikt og en konfliktløsning ikke er angitt, starter ikke oppdateringsoperasjonen.
options		UpdateOptions	Alternativer som skal brukes i oppdateringen fra Git-operasjonen
workspaceHead		string	Fullstendig SHA-hash som arbeidsområdet er synkronisert til. Denne verdien kan bare være null etter initialisering av tilkobling. I andre tilfeller vil systemet validere at den angitte verdien er justert med hodet som er kjent for systemet.

Svar

Name	Type	Beskrivelse
200 OK		Forespørselen er fullført.
202 Accepted		Forespørsel godtatt, oppdater fra Git pågår. Overskrifter Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Grensen for tjenestesats ble overskredet. Serveren returnerer en `Retry-After` topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler. Overskrifter Retry-After: integer
Other Status Codes	ErrorResponse	Vanlige feilkoder: WorkspaceNotConnectedToGit – arbeidsområdet er ikke koblet til git. WorkspaceHasNoCapacityAssigned – ingen kapasitet tilordnet til arbeidsområdet. WorkspaceHeadMismatch – Hodet i forespørselen samsvarer ikke med hodet i systemet. WorkspacePreviousOperationInProgress – Forrige operasjon pågår fortsatt. MissingDependency – En avhengighet mangler i oppdateringsoperasjonen. PotentialDuplicateDisplayNameAndType – Oppdateringsoperasjon oppretter et duplikat visningsnavn og -type. DependencyDeletionFailed – Oppdateringsoperasjon sletter hard avhengighet. InsufficientPrivileges – Innringeren har ikke tilstrekkelige arbeidsområdetillatelser. PrincipalTypeNotSupported – identitetstypen Anroper støttes ikke.

Eksempler

Update a workspace from Git with options example

Update a workspace using data from a Git example

Update a workspace from Git with options example

Eksempelforespørsel

HTTP

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

{
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705",
  "conflictResolution": {
    "conflictResolutionType": "Workspace",
    "conflictResolutionPolicy": "PreferWorkspace"
  },
  "options": {
    "allowOverrideItems": true,
    "itemOptionsByLogicalId": [
      {
        "logicalId": "88436e65-6ed1-8185-49ff-f61077fc73d4",
        "options": {
          "validateOnly": true
        }
      }
    ]
  }
}

Eksempelsvar

Statuskode:: 200

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

Update a workspace using data from a Git example

Eksempelforespørsel

HTTP

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

{
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705",
  "conflictResolution": {
    "conflictResolutionType": "Workspace",
    "conflictResolutionPolicy": "PreferWorkspace"
  },
  "options": {
    "allowOverrideItems": true
  }
}

Eksempelsvar

Statuskode:: 200

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

Name	Beskrivelse
ConflictResolutionPolicy	Policy for konfliktløsning. Flere policyer for konfliktløsning kan legges til over tid.
ConflictResolutionType	Konfliktløsningstype. Flere konfliktløsningstyper kan legges til over tid.
ErrorParameter	En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.
ErrorRelatedResource	Objektet for feilrelaterte ressursdetaljer.
ErrorResponse	Feilsvaret.
ErrorResponseDetails	Feilsvardetaljene.
ItemOptionsByLogicalIdEntry	En oppføring for alternativer per element som retter seg mot elementet etter logisk ID. Hvert målrettede element kan vises maksimalt én gang.
UpdateFromGitRequest	Inneholder oppdateringen fra Git-forespørselsdata.
UpdateOptions	Inneholder alternativene som er aktivert for oppdateringen fra Git.
WorkspaceConflictResolution	De grunnleggende konfliktløsningsdataene.

ConflictResolutionPolicy

Opplisting

Policy for konfliktløsning. Flere policyer for konfliktløsning kan legges til over tid.

Verdi	Beskrivelse
PreferRemote	Foretrekker eksternt Git-sideinnhold.
PreferWorkspace	Foretrekker arbeidsområdesideinnhold.

ConflictResolutionType

Opplisting

Konfliktløsningstype. Flere konfliktløsningstyper kan legges til over tid.

Verdi	Beskrivelse
Workspace	Konfliktløsning som representerer arbeidsområdenivået.

ErrorParameter

Objekt

En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.

Name	Type	Beskrivelse
message	string	En lesbar beskrivelse av parameterens betydning.
name	string	Parameteridentifikatoren.
value	string	Parameterverdien.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Name	Type	Beskrivelse
resourceId	string	Ressurs-ID-en som er involvert i feilen.
resourceType	string	Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Name	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
isRetriable	boolean	Når sann, kan forespørselen prøves på nytt. `Retry-After` Bruk svarhodet til å fastslå forsinkelsen, hvis tilgjengelig.
message	string	En menneskelig lesbar representasjon av feilen.
moreDetails	ErrorResponseDetails[]	Liste over flere feildetaljer.
parameters	ErrorParameter[]	Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.
requestId	string (uuid)	ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Name	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.
parameters	ErrorParameter[]	Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.

ItemOptionsByLogicalIdEntry

Objekt

En oppføring for alternativer per element som retter seg mot elementet etter logisk ID. Hvert målrettede element kan vises maksimalt én gang.

Name	Type	Beskrivelse
logicalId	string (uuid)	Den logiske ID-en for målelementet.
options	object	Alternativene for det målrettede elementet. Egenskapsnavn er alternativnavn som er gyldige for elementtypen. verdier er alternativverdiene. Hvis du vil se alternativene som støttes `Update-Definition` av en bestemt elementtype, kan du se API-dokumentasjonen for den elementtypen.

UpdateFromGitRequest

Objekt

Inneholder oppdateringen fra Git-forespørselsdata.

Name	Type	Beskrivelse
conflictResolution	WorkspaceConflictResolution	Konfliktløsning som skal brukes i oppdateringen fra Git-operasjonen. Hvis elementer er i konflikt og en konfliktløsning ikke er angitt, starter ikke oppdateringsoperasjonen.
options	UpdateOptions	Alternativer som skal brukes i oppdateringen fra Git-operasjonen
remoteCommitHash	string	Ekstern fullstendig SHA-utføringsnummer.
workspaceHead	string	Fullstendig SHA-hash som arbeidsområdet er synkronisert til. Denne verdien kan bare være null etter initialisering av tilkobling. I andre tilfeller vil systemet validere at den angitte verdien er justert med hodet som er kjent for systemet.

UpdateOptions

Objekt

Inneholder alternativene som er aktivert for oppdateringen fra Git.

Name	Type	Beskrivelse
allowOverrideItems	boolean	Brukersamtykke til å overstyre innkommende elementer under oppdateringen fra Git-prosessen. Når innkommende elementer finnes og tillatelsesoverstyringselementene ikke er angitt eller er angitt som usann, starter ikke oppdateringsoperasjonen. Standardverdien er usann.
itemOptionsByLogicalId	ItemOptionsByLogicalIdEntry[]	Oppdateringsalternativer per element. Hver oppføring retter seg mot elementet etter logisk ID og bruker alternativene for elementet.

WorkspaceConflictResolution

Objekt

De grunnleggende konfliktløsningsdataene.

Name	Type	Beskrivelse
conflictResolutionPolicy	ConflictResolutionPolicy	Policy for konfliktløsning. Flere policyer for konfliktløsning kan legges til over tid.
conflictResolutionType	ConflictResolutionType	Konfliktløsningstype. Flere konfliktløsningstyper kan legges til over tid.