Git - Update From Git

Service:: Core

API-versie:: v1

Hiermee werkt u de werkruimte bij met doorvoeringen die naar de verbonden vertakking zijn gepusht.
Deze API ondersteunt langlopende bewerkingen (LRO).

Als u deze API wilt gebruiken, moeten de Git-referenties van de aanroeper worden geconfigureerd met de API Mijn Git-referenties bijwerken . U kunt de API Mijn Git-referenties ophalen gebruiken om de configuratie van git-referenties te controleren.

De update is alleen van invloed op items in de werkruimte die zijn gewijzigd in deze doorvoeringen. Als deze wordt aangeroepen na de verbindings-API's en verbindings-API's initialiseert, wordt de volledige werkruimte bijgewerkt.

Machtigingen

De aanroeper moet een inzender hebben of een hogere werkruimterol.

Vereiste gedelegeerde bereiken

Workspace.GitUpdate.All

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft -identiteiten vermeld in deze sectie.

Identiteit	Ondersteuning
Gebruiker	Ja
serviceprincipal en beheerde identiteiten	Alleen ondersteund wanneer alle items die betrokken zijn bij de bewerking, service-principals ondersteunen

gebruikersinterface

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

URI-parameters

Naam	In	Vereist	Type	Description
workspaceId	path	True	string (uuid)	De werkruimte-id.

Aanvraagbody

Naam	Vereist	Type	Description
remoteCommitHash	True	string	Externe volledige SHA-doorvoerhash.
conflictResolution		WorkspaceConflictResolution	Conflictoplossing die moet worden gebruikt in de update van de Git-bewerking. Als items conflicteren en er geen conflictoplossing is opgegeven, wordt de updatebewerking niet gestart.
options		UpdateOptions	Opties die moeten worden gebruikt in de update van git-bewerking
workspaceHead		string	Volledige SHA-hash waarmee de werkruimte wordt gesynchroniseerd. Deze waarde kan alleen null zijn nadat de verbinding is geïnitialiseerd. In andere gevallen valideert het systeem dat de opgegeven waarde is uitgelijnd met het hoofd dat bekend is bij het systeem.

Antwoorden

Naam	Type	Description
200 OK		De aanvraag is voltooid.
202 Accepted		Aanvraag geaccepteerd, update van Git wordt uitgevoerd. Kopteksten Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	De servicesnelheidslimiet is overschreden. De server retourneert een `Retry-After` header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden. Kopteksten Retry-After: integer
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: WorkspaceNotConnectedToGit - Werkruimte is niet verbonden met Git. WorkspaceHasNoCapacityAssigned : er is geen capaciteit toegewezen aan de werkruimte. WorkspaceHeadMismatch- Hoofd in de aanvraag komt niet overeen met het hoofd in het systeem. WorkspacePreviousOperationInProgress: de vorige bewerking wordt nog uitgevoerd. MissingDependency: er ontbreekt een afhankelijkheid in de updatebewerking. PotentialDuplicateDisplayNameAndType - Bijwerkbewerking maakt een dubbele weergavenaam en -type. DependencyDeletionFailed - Bijwerkbewerking verwijdert harde afhankelijkheid. InsufficientPrivileges : de aanroeper beschikt niet over voldoende werkruimtemachtigingen. PrincipalTypeNotSupported - Identiteitstype beller wordt niet ondersteund.

Voorbeelden

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

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:: 200

Statuscode:: 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

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:: 200

Statuscode:: 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

Definities

Naam	Description
ConflictResolutionPolicy	Conflictoplossingsbeleid. Er kunnen na verloop van tijd aanvullende beleidsregels voor conflictoplossing worden toegevoegd.
ConflictResolutionType	Conflictoplossingstype. Er kunnen na verloop van tijd extra conflictoplossingstypen worden toegevoegd.
ErrorParameter	Een gestructureerde parameter die extra machineleesbare context biedt over een fout.
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	Het foutbericht.
ErrorResponseDetails	De details van het foutbericht.
ItemOptionsByLogicalIdEntry	Een item met opties per item dat is gericht op het item op logische id. Elk doelitem kan maximaal één keer worden weergegeven.
UpdateFromGitRequest	Bevat de update van Git-aanvraaggegevens.
UpdateOptions	Bevat de opties die zijn ingeschakeld voor de update vanuit Git.
WorkspaceConflictResolution	De basisgegevens voor conflictoplossing.

ConflictResolutionPolicy

Opsomming

Conflictoplossingsbeleid. Er kunnen na verloop van tijd aanvullende beleidsregels voor conflictoplossing worden toegevoegd.

Waarde	Description
PreferRemote	Geef de voorkeur aan externe Inhoud aan de Git-zijde.
PreferWorkspace	Geef de voorkeur aan inhoud aan de werkruimtezijde.

ConflictResolutionType

Opsomming

Conflictoplossingstype. Er kunnen na verloop van tijd extra conflictoplossingstypen worden toegevoegd.

Waarde	Description
Workspace	Conflictoplossing die het werkruimteniveau vertegenwoordigt.

ErrorParameter

Object

Een gestructureerde parameter die extra machineleesbare context biedt over een fout.

Naam	Type	Description
message	string	Een door mensen leesbare beschrijving van de betekenis van de parameter.
name	string	De parameter-id.
value	string	De waarde van de parameter.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Naam	Type	Description
resourceId	string	De resource-id die betrokken is bij de fout.
resourceType	string	Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Naam	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
isRetriable	boolean	Wanneer waar, kan de aanvraag opnieuw worden geprobeerd. Gebruik de `Retry-After` antwoordheader om de vertraging te bepalen, indien beschikbaar.
message	string	Een leesbare weergave van de fout.
moreDetails	ErrorResponseDetails[]	Lijst met aanvullende foutdetails.
parameters	ErrorParameter[]	Gestructureerde parameters die extra machineleesbare context bieden over de fout.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.
requestId	string (uuid)	Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Naam	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
parameters	ErrorParameter[]	Gestructureerde parameters die extra machineleesbare context bieden over de fout.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.

ItemOptionsByLogicalIdEntry

Object

Een item met opties per item dat is gericht op het item op logische id. Elk doelitem kan maximaal één keer worden weergegeven.

Naam	Type	Description
logicalId	string (uuid)	De logische id van het doelitem.
options	object	De opties voor het doelitem. Eigenschapsnamen zijn optienamen die geldig zijn voor het itemtype; waarden zijn de optiewaarden. Zie de API-documentatie van `Update-Definition` dat itemtype voor de opties die worden ondersteund door een specifiek itemtype.

UpdateFromGitRequest

Object

Bevat de update van Git-aanvraaggegevens.

Naam	Type	Description
conflictResolution	WorkspaceConflictResolution	Conflictoplossing die moet worden gebruikt in de update van de Git-bewerking. Als items conflicteren en er geen conflictoplossing is opgegeven, wordt de updatebewerking niet gestart.
options	UpdateOptions	Opties die moeten worden gebruikt in de update van git-bewerking
remoteCommitHash	string	Externe volledige SHA-doorvoerhash.
workspaceHead	string	Volledige SHA-hash waarmee de werkruimte wordt gesynchroniseerd. Deze waarde kan alleen null zijn nadat de verbinding is geïnitialiseerd. In andere gevallen valideert het systeem dat de opgegeven waarde is uitgelijnd met het hoofd dat bekend is bij het systeem.

UpdateOptions

Object

Bevat de opties die zijn ingeschakeld voor de update vanuit Git.

Naam	Type	Description
allowOverrideItems	boolean	Gebruiker stemt in om binnenkomende items tijdens de update van het Git-proces te overschrijven. Wanneer binnenkomende items aanwezig zijn en de items voor het overschrijven van toestaan niet zijn opgegeven of als onwaar zijn opgegeven, wordt de updatebewerking niet gestart. De standaardwaarde is onwaar.
itemOptionsByLogicalId	ItemOptionsByLogicalIdEntry[]	Bijwerkopties per item. Elke vermelding is gericht op het item op logische id en past de opties toe op dat item.

WorkspaceConflictResolution

Object

De basisgegevens voor conflictoplossing.

Naam	Type	Description
conflictResolutionPolicy	ConflictResolutionPolicy	Conflictoplossingsbeleid. Er kunnen na verloop van tijd aanvullende beleidsregels voor conflictoplossing worden toegevoegd.
conflictResolutionType	ConflictResolutionType	Conflictoplossingstype. Er kunnen na verloop van tijd extra conflictoplossingstypen worden toegevoegd.