Git - Update From Git

Tjeneste:: Core

API-version:: v1

Opdaterer arbejdsområdet med bekræftelser, der er pushet til den forbundne forgrening.

Notat

Understøttelse af installationsplan i denne API er en del af en betaversion og leveres kun til evaluerings- og udviklingsformål. Det kan ændre sig baseret på feedback og anbefales ikke til produktionsbrug. Alle andre funktioner i denne API er generelt tilgængelige. Hvis du vil bruge understøttelse af installationsplan, skal kaldere angive true som værdien for forespørgselsparameteren beta.

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.

Opdateringen påvirker kun elementer i arbejdsområdet, der blev ændret i disse bekræftelser. Hvis den kaldes efter Api'erne Opret forbindelse og Initialiser forbindelse , udfører den en komplet opdatering af hele arbejdsområdet.

Tilladelser

Den, der ringer op, skal have en bidragyder eller en højere rolle i arbejdsområdet.

Påkrævede delegerede områder

Workspace.GitUpdate.All

Microsoft Entra-understøttede identiteter

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

Identitet	Støtte
Bruger	Ja
tjenesteprincipal og administrerede identiteter	Understøttes kun, når alle de elementer , der er involveret i handlingen, understøtter tjenesteprincipaler

Grænseflade

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

Med valgfrie parametre:

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

URI-parametre

Navn	I	Påkrævet	Type	Beskrivelse
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.
beta	query		boolean	Angiv til at `true` aktivere betafunktionalitet, herunder understøttelse af installationsplan. Når den udelades eller angives til `false`, er det kun offentlig tilgængelig funktionalitet, der er tilgængelig, og input fra udrulningsplanen accepteres ikke.

Brødtekst for anmodning

Navn	Påkrævet	Type	Beskrivelse
remoteCommitHash	True	string	Fuldstændig SHA-bekræftelses-hash for fjernforbindelse.
conflictResolution		WorkspaceConflictResolution	Konfliktløsning, der skal bruges i opdateringen fra Git-handlingen. Hvis elementer er i konflikt, og der ikke er angivet en konfliktløsning, starter opdateringshandlingen ikke.
options		UpdateOptions	Indstillinger, der skal bruges i opdateringen fra Git-handlingen
workspaceHead		string	Fuld SHA-hash, som arbejdsområdet synkroniseres til. Denne værdi må kun være null efter Initialiser forbindelse. I andre tilfælde validerer systemet, at den angivne værdi er justeret i forhold til det hoved, systemet kender.

Svar

Navn	Type	Beskrivelse
200 OK		Anmodningen blev fuldført.
202 Accepted		Anmodning accepteret, opdatering fra Git i gang. Headere Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Grænsen for tjenestetakst blev overskredet. Serveren returnerer en `Retry-After` header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger. Headere 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. WorkspaceHeadMismatch – Hovedet i anmodningen svarer ikke til hovedet i systemet. WorkspacePreviousOperationInProgress – Forrige handling er stadig i gang. MissingDependency – Der mangler en afhængighed i opdateringshandlingen. PotentialDuplicateDisplayNameAndType – Opdateringshandlingen opretter et duplikeret vist navn og en dublet af typen. DependencyDeletionFailed – Opdateringshandlingen sletter hård afhængighed. InsufficientPrivileges – Den kaldende bruger har ikke tilstrækkelige tilladelser til arbejdsområdet. PrincipalTypeNotSupported – Opkaldsidentitetstypen understøttes ikke.

Eksempler

Update a workspace from Git with options example

Update a workspace using data from a Git example

Update a workspace using data from a Git with a deployment plan example

Update a workspace from Git with options example

Eksempelanmodning

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

Eksempelanmodning

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

Update a workspace using data from a Git with a deployment plan example

Eksempelanmodning

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,
    "deploymentPlan": {
      "referenceType": "ByLogicalId",
      "logicalId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  }
}

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

Definitioner

Navn	Beskrivelse
ConflictResolutionPolicy	Konfliktløsningspolitik. Der kan tilføjes yderligere politikker for konfliktløsning over tid.
ConflictResolutionType	Konfliktløsningstype. Der kan tilføjes flere konfliktløsningstyper over tid.
DeploymentPlanReferenceByItemId	En udrulningsplanreference efter element-id.
DeploymentPlanReferenceByLogicalId	En udrulningsplanreference efter logisk id.
DeploymentPlanReferenceType	Referencetypen for udrulningsplanen. Der kan tilføjes flere `DeploymentPlanReferenceType` typer over tid.
ErrorParameter	En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
ItemOptionsByLogicalIdEntry	En indstillingspost pr. element, der er målrettet elementet efter logisk id. Hvert målrettet element kan vises højst én gang.
UpdateFromGitRequest	Indeholder opdateringen fra Git-anmodningsdata.
UpdateOptions	Indeholder de indstillinger, der er aktiveret for opdateringen fra Git.
WorkspaceConflictResolution	De grundlæggende konfliktløsningsdata.

ConflictResolutionPolicy

Optælling

Konfliktløsningspolitik. Der kan tilføjes yderligere politikker for konfliktløsning over tid.

Værdi	Beskrivelse
PreferRemote	Foretrækker fjernindhold på Git-siden.
PreferWorkspace	Foretrækker indhold på arbejdsområdesiden.

ConflictResolutionType

Optælling

Konfliktløsningstype. Der kan tilføjes flere konfliktløsningstyper over tid.

Værdi	Beskrivelse
Workspace	Konfliktløsning, der repræsenterer arbejdsområdeniveauet.

DeploymentPlanReferenceByItemId

Objekt

En udrulningsplanreference efter element-id.

Navn	Type	Beskrivelse
itemId	string (uuid)	Element-id'et for elementet i udrulningsplanen.
referenceType	string: ByItemId	Referencetypen for udrulningsplanen.

DeploymentPlanReferenceByLogicalId

Objekt

En udrulningsplanreference efter logisk id.

Navn	Type	Beskrivelse
logicalId	string (uuid)	Det logiske id for elementet i udrulningsplanen.
referenceType	string: ByLogicalId	Referencetypen for udrulningsplanen.

DeploymentPlanReferenceType

Optælling

Referencetypen for udrulningsplanen. Der kan tilføjes flere DeploymentPlanReferenceType typer over tid.

Værdi	Beskrivelse
ByItemId	Der refereres til udrulningsplanen af element-id'et.
ByLogicalId	Der refereres til udrulningsplanen af dets logiske id.

ErrorParameter

Objekt

En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.

Navn	Type	Beskrivelse
message	string	En læsevenlig beskrivelse af parameterens betydning.
name	string	Parameter-id'et.
value	string	Parameterens værdi.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Navn	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Navn	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
isRetriable	boolean	Når sand, kan anmodningen prøves igen. Brug svarheaderen `Retry-After` til at bestemme forsinkelsen, hvis den er tilgængelig.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
parameters	ErrorParameter[]	Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Navn	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.
parameters	ErrorParameter[]	Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

ItemOptionsByLogicalIdEntry

Objekt

En indstillingspost pr. element, der er målrettet elementet efter logisk id. Hvert målrettet element kan vises højst én gang.

Navn	Type	Beskrivelse
logicalId	string (uuid)	Det logiske id for destinationselementet.
options	object	Indstillingerne for det målrettede element. Egenskabsnavne er navne på indstillinger, der er gyldige for elementtypen. værdier er indstillingsværdierne. Du kan se de indstillinger, der understøttes af en bestemt elementtype, i denne elementtypes `Update-Definition` API-dokumentation.

UpdateFromGitRequest

Objekt

Indeholder opdateringen fra Git-anmodningsdata.

Navn	Type	Beskrivelse
conflictResolution	WorkspaceConflictResolution	Konfliktløsning, der skal bruges i opdateringen fra Git-handlingen. Hvis elementer er i konflikt, og der ikke er angivet en konfliktløsning, starter opdateringshandlingen ikke.
options	UpdateOptions	Indstillinger, der skal bruges i opdateringen fra Git-handlingen
remoteCommitHash	string	Fuldstændig SHA-bekræftelses-hash for fjernforbindelse.
workspaceHead	string	Fuld SHA-hash, som arbejdsområdet synkroniseres til. Denne værdi må kun være null efter Initialiser forbindelse. I andre tilfælde validerer systemet, at den angivne værdi er justeret i forhold til det hoved, systemet kender.

UpdateOptions

Objekt

Indeholder de indstillinger, der er aktiveret for opdateringen fra Git.

Navn	Type	Beskrivelse
allowOverrideItems	boolean	Brugerens samtykke til at tilsidesætte indgående elementer under opdateringen fra Git-processen. Når indgående elementer er til stede, og tillad tilsidesættelse af elementer ikke er angivet eller angivet som falsk, starter opdateringshandlingen ikke. Standardværdien er false.
deploymentPlan	DeploymentPlanReference: DeploymentPlanReferenceByItemId DeploymentPlanReferenceByLogicalId	En reference til et element i en udrulningsplan for at orkestrere udrulningen. Når det er angivet, styrer planen rækkefølgen af udrulningen af elementer og udfører handlinger før/efter udrulningen. Når handlingen er fraværende eller null, fungerer den som i dag. I øjeblikket understøttes `ByLogicalId` kun referencetypen. Understøttelse af installationsplan er i øjeblikket i betaversion. Denne egenskab kan kun bruges, når forespørgselsparameteren `beta` er angivet til `true` og kan ændres baseret på feedback.
itemOptionsByLogicalId	ItemOptionsByLogicalIdEntry[]	Indstillinger for opdatering pr. element. Hver post er målrettet elementet efter logisk id og anvender dets indstillinger på det pågældende element.

WorkspaceConflictResolution

Objekt

De grundlæggende konfliktløsningsdata.

Navn	Type	Beskrivelse
conflictResolutionPolicy	ConflictResolutionPolicy	Konfliktløsningspolitik. Der kan tilføjes yderligere politikker for konfliktløsning over tid.
conflictResolutionType	ConflictResolutionType	Konfliktløsningstype. Der kan tilføjes flere konfliktløsningstyper over tid.