Dela via

Git - Update From Git

Tjänst:
Core
API-version:
v1

Uppdaterar arbetsytan med incheckningar som skickas till den anslutna grenen.
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.

Uppdateringen påverkar endast objekt på arbetsytan som har ändrats i dessa incheckningar. Om det anropas efter API:erna Anslut och Initiera anslutning kommer den att utföra en fullständig uppdatering av hela arbetsytan.

Behörigheter

Anroparen måste ha en deltagare eller högre arbetsyteroll.

Obligatoriska delegerade omfång

Workspace.GitUpdate.All

Identiteter som stöds av Microsoft Entra

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

Identitet Stöd
Användare Ja
Tjänsthuvudnamn och hanterade identiteter Stöds endast när alla objekt som ingår i åtgärden stöder tjänstens huvudnamn

Gränssnitt

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

URI-parametrar

Name I Obligatorisk Typ Description
workspaceId
 path True

string (uuid)

Arbetsmiljöns ID.

Begärandetext

Name Obligatorisk Typ Description
remoteCommitHash True

string

Fullständig SHA-incheckningshash för fjärranslutning.
conflictResolution

WorkspaceConflictResolution

Konfliktlösning som ska användas i uppdateringen från Git-åtgärden. Om objekt är i konflikt och en konfliktlösning inte har angetts startas inte uppdateringsåtgärden.
options

UpdateOptions

Alternativ som ska användas i uppdateringen från Git-åtgärden
workspaceHead

string

Fullständig SHA-hash som arbetsytan synkroniseras till. Det här värdet kan bara vara null efter att anslutningen har initierats. I andra fall verifierar systemet att det angivna värdet är justerat med det huvud som systemet känner till.

Svar

Name Typ Description
200 OK

Begäran har slutförts.
202 Accepted

Begäran accepterad, uppdatering från Git pågår.

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 arbetsytan.

  • WorkspaceHeadMismatch – Huvudet i begäran matchar inte huvudet i systemet.

  • WorkspacePreviousOperationInProgress – Föregående åtgärd pågår fortfarande.

  • MissingDependency – Ett beroende saknas i uppdateringsåtgärden.

  • PotentialDuplicateDisplayNameAndType – Uppdateringsåtgärden skapar ett duplicerat visningsnamn och en typ.

  • DependencyDeletionFailed – Uppdateringsåtgärden tar bort hårt beroende.

  • InsufficientPrivileges – anroparen har inte tillräcklig behörighet för arbetsytan.

  • PrincipalTypeNotSupported – Nummerpresentationstypen stöds inte.

Exempel

Update a workspace using data from a Git example

Exempelbegäran

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
  }
}

Exempelsvar

Statuskod:
200
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
ConflictResolutionPolicy

Konfliktlösningsprincip. Ytterligare konfliktlösningsprinciper kan läggas till över tid.
ConflictResolutionType

Konfliktlösningstyp. Ytterligare konfliktlösningstyper kan läggas till över tid.
ErrorRelatedResource

Det felrelaterade resursinformationsobjektet.
ErrorResponse

Felsvaret.
ErrorResponseDetails

Information om felsvar.
UpdateFromGitRequest

Innehåller uppdateringen från Git-begärandedata.
UpdateOptions

Innehåller de alternativ som är aktiverade för uppdateringen från Git.
WorkspaceConflictResolution

Grundläggande konfliktlösningsdata.

ConflictResolutionPolicy

Uppräkning

Konfliktlösningsprincip. Ytterligare konfliktlösningsprinciper kan läggas till över tid.

Värde Description
PreferRemote

Föredrar fjärranslutet Innehåll på Git-sidan.
PreferWorkspace

Föredrar innehåll på arbetsytans sida.

ConflictResolutionType

Uppräkning

Konfliktlösningstyp. Ytterligare konfliktlösningstyper kan läggas till över tid.

Värde Description
Workspace

Konfliktlösning som representerar arbetsytenivån.

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.

UpdateFromGitRequest

Objekt

Innehåller uppdateringen från Git-begärandedata.

Name Typ Description
conflictResolution

WorkspaceConflictResolution

Konfliktlösning som ska användas i uppdateringen från Git-åtgärden. Om objekt är i konflikt och en konfliktlösning inte har angetts startas inte uppdateringsåtgärden.
options

UpdateOptions

Alternativ som ska användas i uppdateringen från Git-åtgärden
remoteCommitHash

string

Fullständig SHA-incheckningshash för fjärranslutning.
workspaceHead

string

Fullständig SHA-hash som arbetsytan synkroniseras till. Det här värdet kan bara vara null efter att anslutningen har initierats. I andra fall verifierar systemet att det angivna värdet är justerat med det huvud som systemet känner till.

UpdateOptions

Objekt

Innehåller de alternativ som är aktiverade för uppdateringen från Git.

Name Typ Description
allowOverrideItems

boolean

Användaren godkänner att inkommande objekt åsidosätts under uppdateringen från Git-processen. När inkommande objekt finns och tillåt åsidosättningsobjekt inte har angetts eller anges som false startar inte uppdateringsåtgärden. Standardvärdet är falskt.

WorkspaceConflictResolution

Objekt

Grundläggande konfliktlösningsdata.

Name Typ Description
conflictResolutionPolicy

ConflictResolutionPolicy

Konfliktlösningsprincip. Ytterligare konfliktlösningsprinciper kan läggas till över tid.
conflictResolutionType

ConflictResolutionType

Konfliktlösningstyp. Ytterligare konfliktlösningstyper kan läggas till över tid.