Git - Update From Git

Palvelu:: Core

Ohjelmointirajapinnan versio:: v1

Päivittää työtilan vahvistuksilla, jotka on siirretty yhdistettyyn haaraan.
Tämä ohjelmointirajapinta tukee pitkäkestoisia toimintoja.

Jotta voit käyttää tätä ohjelmointirajapintaa, soittajan Git-tunnistetiedot on määritettävä Käyttämällä Päivitä Omat Git-tunnistetiedot -ohjelmointirajapintaa. Voit tarkistaa Git-tunnistetietojen määritykset Hanki Omat Git-tunnistetiedot -ohjelmointirajapinnan avulla.

Päivitys vaikuttaa vain työtilan kohteisiin, joita on muutettu näissä vahvistuksissa. Jos se kutsutaan Yhdistä - ja Alusta yhteys - ohjelmointirajapintojen jälkeen, se suorittaa koko työtilan täyden päivityksen.

Käyttöoikeudet

Kutsujalla on oltava osallistujan tai suurempi työtilarooli.

Vaaditut delegoidut vaikutusalueet

Workspace.GitUpdate.All

Microsoft Entran tukemat käyttäjätiedot

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft -käyttäjätietoja.

Identiteetti	Tuki
Käyttäjä	Kyllä
palvelun päänimen ja Hallittujen käyttäjätietojen	Tuetaan vain, kun kaikki toimintoon liittyvät kohteet tukevat palvelun päänimiä

Rajapinta

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

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Kuvaus
workspaceId	path	True	string (uuid)	Työtilan tunnus.

Pyynnön leipäteksti

Nimi	Pakollinen	Tyyppi	Kuvaus
remoteCommitHash	True	string	Täysi SHA-etähallintatoiminnon hajautus
conflictResolution		WorkspaceConflictResolution	Ristiriidan ratkaisu, jota käytetään Git-toiminnon päivityksessä. Jos kohteet ovat ristiriidassa eikä ristiriitojen ratkaisua ole määritetty, päivitystoimintoa ei aloiteta.
options		UpdateOptions	Git-toiminnon päivityksessä käytettävät asetukset
workspaceHead		string	Koko SHA-hajautustoiminto, johon työtila on synkronoitu. Tämä arvo voi olla tyhjäarvo vasta Alusta yhteys -alustamisen jälkeen. Muissa tapauksissa järjestelmä vahvistaa, että annettu arvo on tasattu järjestelmän tuntemalle johtajalle.

Vastaukset

Nimi	Tyyppi	Kuvaus
200 OK		Pyynnön valmistuttua.
202 Accepted		Pyyntö hyväksytty, päivitys gitiltä on meneillään. Otsikot Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka `Retry-After` ilmaisee sekunteina, kuinka kauan asiakkaan on odotettava, ennen kuin lisäpyynnöt lähetetään. Otsikot Retry-After: integer
Other Status Codes	ErrorResponse	Yleiset virhekoodit: WorkspaceNotConnectedToGit – Työtila ei ole yhteydessä Gitiin. WorkspaceHasNoCapacityAssigned – Työtilalle ei ole määritetty kapasiteettia. WorkspaceHeadMismatch: pyynnön johtaja ei vastaa järjestelmän päätä. WorkspacePreviousOperationInProgress – Edellinen toiminto on vielä kesken. MissingDependency – Riippuvuus puuttuu päivitystoiminnosta. PotentialDuplicateDisplayNameAndType – Päivitystoiminto luo näyttönimen ja tyypin kaksoiskappaleen. DependencyDeletionFailed – Päivitystoiminto poistaa kovan riippuvuuden. InsufficientPrivileges – Soittajalla ei ole riittäviä työtilan käyttöoikeuksia. PrincipalTypeNotSupported – Soittajan käyttäjätietotyyppiä ei tueta.

Esimerkit

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

Mallipyyntö

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

Mallivastaus

Tilakoodi:: 200

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

Mallipyyntö

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

Mallivastaus

Tilakoodi:: 200

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

Määritelmät

Nimi	Kuvaus
ConflictResolutionPolicy	Ristiriitaisten ratkaisukäytäntö. Lisää ristiriitojen ratkaisukäytäntöjä voidaan lisätä ajan mittaan.
ConflictResolutionType	Ristiriidan ratkaisutyyppi. Muita ristiriitojen ratkaisutyyppejä voidaan lisätä ajan mittaan.
ErrorParameter	Jäsennetty parametri, joka antaa koneluettavaa lisäkontekstia virheestä.
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
ItemOptionsByLogicalIdEntry	Kohdekohtainen asetusmerkintä, joka kohdistaa kohteensa loogisen tunnuksen mukaan. Jokainen kohdistettu kohde voi olla näkyvissä enintään kerran.
UpdateFromGitRequest	Sisältää Git-pyyntötietojen päivityksen.
UpdateOptions	Sisältää asetukset, jotka ovat käytössä Git-päivityksessä.
WorkspaceConflictResolution	Peruskonfliktin ratkaisutiedot.

ConflictResolutionPolicy

Luettelointi

Ristiriitaisten ratkaisukäytäntö. Lisää ristiriitojen ratkaisukäytäntöjä voidaan lisätä ajan mittaan.

Arvo	Kuvaus
PreferRemote	Suosi etänä ollutTaGit-puolen sisältöä.
PreferWorkspace	Käytä mieluummin työtilan sivusisältöä.

ConflictResolutionType

Luettelointi

Ristiriidan ratkaisutyyppi. Muita ristiriitojen ratkaisutyyppejä voidaan lisätä ajan mittaan.

Arvo	Kuvaus
Workspace	Työtilatasoa edustava ristiriitainen ratkaisu.

ErrorParameter

Kohde

Jäsennetty parametri, joka antaa koneluettavaa lisäkontekstia virheestä.

Nimi	Tyyppi	Kuvaus
message	string	Ihmisen luettavissa oleva kuvaus parametrin merkityksestä.
name	string	Parametritunniste.
value	string	Parametriarvo.

ErrorRelatedResource

Kohde

Virheeseen liittyvä resurssitieto-objekti.

Nimi	Tyyppi	Kuvaus
resourceId	string	Virheestä liittyvä resurssitunnus.
resourceType	string	Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Kohde

Virhevastaus.

Nimi	Tyyppi	Kuvaus
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
isRetriable	boolean	Kun arvo on tosi, pyyntöä voidaan yrittää uudelleen. Määritä viive vastausotsikon `Retry-After` avulla, jos se on käytettävissä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
moreDetails	ErrorResponseDetails[]	Luettelo virheiden lisätiedoista.
parameters	ErrorParameter[]	Jäsennettyjä parametreja, jotka antavat koneluettavaa lisäkontekstia virheestä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.
requestId	string (uuid)	Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Kohde

Virheen vastauksen tiedot.

Nimi	Tyyppi	Kuvaus
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
parameters	ErrorParameter[]	Jäsennettyjä parametreja, jotka antavat koneluettavaa lisäkontekstia virheestä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.

ItemOptionsByLogicalIdEntry

Kohde

Kohdekohtainen asetusmerkintä, joka kohdistaa kohteensa loogisen tunnuksen mukaan. Jokainen kohdistettu kohde voi olla näkyvissä enintään kerran.

Nimi	Tyyppi	Kuvaus
logicalId	string (uuid)	Kohdekohteen looginen tunnus.
options	object	Kohdennetun kohteen asetukset. Ominaisuuksien nimet ovat kohteen tyypille kelvollisia asetusnimiä. arvot ovat asetusarvoja. Jos haluat nähdä tietyn kohdetyypin tukemat asetukset, tutustu kyseisen kohdetyypin `Update-Definition` ohjelmointirajapinnan dokumentaatioon.

UpdateFromGitRequest

Kohde

Sisältää Git-pyyntötietojen päivityksen.

Nimi	Tyyppi	Kuvaus
conflictResolution	WorkspaceConflictResolution	Ristiriidan ratkaisu, jota käytetään Git-toiminnon päivityksessä. Jos kohteet ovat ristiriidassa eikä ristiriitojen ratkaisua ole määritetty, päivitystoimintoa ei aloiteta.
options	UpdateOptions	Git-toiminnon päivityksessä käytettävät asetukset
remoteCommitHash	string	Täysi SHA-etähallintatoiminnon hajautus
workspaceHead	string	Koko SHA-hajautustoiminto, johon työtila on synkronoitu. Tämä arvo voi olla tyhjäarvo vasta Alusta yhteys -alustamisen jälkeen. Muissa tapauksissa järjestelmä vahvistaa, että annettu arvo on tasattu järjestelmän tuntemalle johtajalle.

UpdateOptions

Kohde

Sisältää asetukset, jotka ovat käytössä Git-päivityksessä.

Nimi	Tyyppi	Kuvaus
allowOverrideItems	boolean	Käyttäjä suostuu ohittamaan saapuvat kohteet Git-prosessin päivityksen aikana. Kun saapuvia kohteita on olemassa ja salli ohituskohteita ei määritetä tai ne annetaan epätosi-muodossa, päivitystoimintoa ei aloiteta. Oletusarvo on false.
itemOptionsByLogicalId	ItemOptionsByLogicalIdEntry[]	Kohdekohtaiset päivitysasetukset. Jokainen merkintä kohdistaa kohteensa loogisen tunnuksen avulla ja käyttää vaihtoehtojaan kyseiseen kohteeseen.

WorkspaceConflictResolution

Kohde

Peruskonfliktin ratkaisutiedot.

Nimi	Tyyppi	Kuvaus
conflictResolutionPolicy	ConflictResolutionPolicy	Ristiriitaisten ratkaisukäytäntö. Lisää ristiriitojen ratkaisukäytäntöjä voidaan lisätä ajan mittaan.
conflictResolutionType	ConflictResolutionType	Ristiriidan ratkaisutyyppi. Muita ristiriitojen ratkaisutyyppejä voidaan lisätä ajan mittaan.