Git - Commit To Git

Palvelu:: Core

Ohjelmointirajapinnan versio:: v1

Määrittää työtilassa tehdyt muutokset yhdistettyyn etä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.

Voit lähettää kaikki muutokset, tietyt kohteet tai tietyt tiedostot kohteissa käyttämällä FileLevelSelective-tilaa. Jos haluat synkronoida työtilan ensimmäistä kertaa, käytä tätä ohjelmointirajapintaa Yhdistä ja alusta yhteys -ohjelmointirajapintojen jälkeen.

Käyttöoikeudet

Kutsujalla on oltava osallistujan tai suurempi työtilarooli.

Vaaditut delegoidut vaikutusalueet

Workspace.GitCommit.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/commitToGit

URI-parametrit

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

Pyynnön leipäteksti

Nimi	Pakollinen	Tyyppi	Kuvaus
mode	True	CommitMode	Vahvistustoiminnon tila.
comment		string maxLength: 300	Soittajan ilmainen kommentti tälle vahvistetulle toiminnolle. Enimmäispituus on 300 merkkiä. Jos soittaja ei anna mitään kommenttia, käytä Git-palveluntarjoajan oletuskommenttia.
items		ItemIdentifier[]	Tietyt vahvistuskohteet. Tämä on olennaista vain Valikoiva vahvistus -tilassa. KohteidenWithFileSelection toisensa poissulkeminen. Kohteet voidaan hakea Git Status -ohjelmointirajapinnasta.
itemsWithFileSelection		ItemIdentifierWithFileSelection[]	Kohteet, joissa on tiedostokohtainen valinta FileLevelSelective-vahvistustilaan. Kohteiden toisensa poissulkeminen. Jokainen merkintä määrittää kohteen ja valinnaisesti vahvistustiedostopolkujen luettelon. Jos valittuNa olevatTiedostot ovat tyhjäarvoisia tai tyhjiä kohteelle, kaikki kyseisen kohteen tiedostot otetaan käyttöön.
workspaceHead		string	Koko SHA-hajautustoiminto, johon työtila on synkronoitu. Hajautusimen voi hakea Git-tilan ohjelmointirajapinnasta.

Vastaukset

Nimi	Tyyppi	Kuvaus
200 OK		Pyynnön valmistuttua.
202 Accepted		Pyyntö hyväksytty, lähetä Gitille 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ötilaan ei lisätä kapasiteettia. WorkspaceHeadMismatch: pyynnön johtaja ei vastaa järjestelmän päätä. WorkspacePreviousOperationInProgress – Edellinen toiminto on vielä kesken. InsufficientPrivileges – Soittajalla ei ole riittäviä työtilan käyttöoikeuksia. PrincipalTypeNotSupported – Soittajan käyttäjätietotyyppiä ei tueta.

Esimerkit

Commit all to Git example

Commit file-level selective to Git example

Commit selective items to Git example

Commit all to Git example

Mallipyyntö

HTTP

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

{
  "mode": "All",
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "comment": "I'm committing all my changes."
}

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

Commit file-level selective to Git example

Mallipyyntö

HTTP

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

{
  "mode": "FileLevelSelective",
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "comment": "Commit only the metadata change from MyNotebook",
  "itemsWithFileSelection": [
    {
      "objectId": "cfafbeb1-8037-4d0c-896e-28c4f2e65573",
      "selectedFiles": [
        "metadata.json"
      ]
    },
    {
      "objectId": "d5a2b3c4-1234-5678-abcd-ef0123456789",
      "selectedFiles": []
    }
  ]
}

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

Commit selective items to Git example

Mallipyyntö

HTTP

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

{
  "mode": "Selective",
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "comment": "I'm committing specific changes.",
  "items": [
    {
      "logicalId": "111e8d7b-4a95-4c02-8ccd-6faef5ba1bd1",
      "objectId": "1153f3b4-dbb8-33c1-a84f-6ae4d776362d"
    },
    {
      "objectId": "7753f3b4-dbb8-44c1-a94f-6ae4d776369e"
    }
  ]
}

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
CommitMode	Vahvistustoiminnon tilat. Lisää tiloja voidaan lisätä ajan kuluessa.
CommitToGitRequest	Sisältää vahvistuspyynnön.
ErrorParameter	Jäsennetty parametri, joka antaa koneluettavaa lisäkontekstia virheestä.
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
ItemIdentifier	Sisältää kohteen tunnuksen. Vähintään yksi ominaisuuksista on määritettävä.
ItemIdentifierWithFileSelection	Sisältää kohteen tunnuksen ja valinnaisen tiedostotason valinnan vahvistustoimintoja varten.

CommitMode

Luettelointi

Vahvistustoiminnon tilat. Lisää tiloja voidaan lisätä ajan kuluessa.

Arvo	Kuvaus
All	Vahvista kaikki sitomattomat muutokset. Soittajan ei tarvitse antaa vahvistuskohdeluetteloa.
Selective	Vahvista määritetty luettelo kohteista, joiden muutokset eivät ole sitoneet. Määritä kohteet -ominaisuuden `items` avulla.
FileLevelSelective	Vahvista määritetyt tiedostot määritettyjen kohteiden sisällä. -ominaisuuden `itemsWithFileSelection` avulla voit määrittää kohteet ja tiedostot.

CommitToGitRequest

Kohde

Sisältää vahvistuspyynnön.

Nimi	Tyyppi	Kuvaus
comment	string maxLength: 300	Soittajan ilmainen kommentti tälle vahvistetulle toiminnolle. Enimmäispituus on 300 merkkiä. Jos soittaja ei anna mitään kommenttia, käytä Git-palveluntarjoajan oletuskommenttia.
items	ItemIdentifier[]	Tietyt vahvistuskohteet. Tämä on olennaista vain Valikoiva vahvistus -tilassa. KohteidenWithFileSelection toisensa poissulkeminen. Kohteet voidaan hakea Git Status -ohjelmointirajapinnasta.
itemsWithFileSelection	ItemIdentifierWithFileSelection[]	Kohteet, joissa on tiedostokohtainen valinta FileLevelSelective-vahvistustilaan. Kohteiden toisensa poissulkeminen. Jokainen merkintä määrittää kohteen ja valinnaisesti vahvistustiedostopolkujen luettelon. Jos valittuNa olevatTiedostot ovat tyhjäarvoisia tai tyhjiä kohteelle, kaikki kyseisen kohteen tiedostot otetaan käyttöön.
mode	CommitMode	Vahvistustoiminnon tila.
workspaceHead	string	Koko SHA-hajautustoiminto, johon työtila on synkronoitu. Hajautusimen voi hakea Git-tilan ohjelmointirajapinnasta.

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.

ItemIdentifier

Kohde

Sisältää kohteen tunnuksen. Vähintään yksi ominaisuuksista on määritettävä.

Nimi	Tyyppi	Kuvaus
logicalId	string (uuid)	Kohteen looginen tunnus. Jos looginen tunnus ei ole käytettävissä, koska kohdetta ei ole vielä lisätty työtilaan, voit käyttää objektitunnusta.
objectId	string (uuid)	Kohteen objektitunnus. Jos objektitunnus ei ole käytettävissä, koska kohde on poistettu työtilasta, voit käyttää loogista tunnusta.

ItemIdentifierWithFileSelection

Kohde

Sisältää kohteen tunnuksen ja valinnaisen tiedostotason valinnan vahvistustoimintoja varten.

Nimi	Tyyppi	Kuvaus
logicalId	string (uuid)	Kohteen looginen tunnus. Jos looginen tunnus ei ole käytettävissä, koska kohdetta ei ole vielä lisätty työtilaan, voit käyttää objektitunnusta.
objectId	string (uuid)	Kohteen objektitunnus. Jos objektitunnus ei ole käytettävissä, koska kohde on poistettu työtilasta, voit käyttää loogista tunnusta.
selectedFiles	string[]	Vahvistustiedostopolut suhteessa kohteen pääkansioon. Poluissa käytetään vain vinoviivaa, ei alussa vinoviivaa, vain täydet tiedostopolut (ei hakemistoja tai yleismerkkejä), ei tyhjiä tai vain välilyönti -segmenttejä, eikä segmentit voi päättyä piste- tai lopussa oleviin välilyönteihin. Jos se on tyhjäarvoinen tai tyhjä, kaikki tämän kohteen tiedostot on varattu.