Zdieľať cez


Git - Commit To Git

Vykoná zmeny vykonané v pracovnom priestore na pripojenej vzdialenej vetve.
Toto rozhranie API podporuje dlhotrvajúce operácie (LRO).

Na používanie tohto rozhrania API musia byť poverenia Git volajúceho nakonfigurované pomocou rozhrania API Aktualizovať moje poverenia Git . Na kontrolu konfigurácie poverení Git môžete použiť rozhranie API Načítať moje poverenia Git .

Môžete sa rozhodnúť potvrdiť všetky zmeny alebo len konkrétne zmenené položky. Ak chcete synchronizovať pracovný priestor po prvýkrát, použite toto rozhranie API po rozhraní API pripojenia Pripojiť a inicializovať .

Povolenia

Volajúci musí mať rolu prispievateľa alebo vyššieho pracovného priestoru.

Povinné delegované rozsahy

Workspace.GitCommit.All.

Podporované identity v aplikácii Microsoft Entra

Toto rozhranie API podporuje identity Microsoft uvedené v tejto časti.

Identita Podpora
Používateľ Áno
Objekt služby a spravované identity Podporované len v prípade, že všetky položky, ktoré sú súčasťou operácie, podporujú objekty služby

Rozhranie

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

Parametre URI

Name V Povinné Typ Description
workspaceId
path True

string (uuid)

ID pracovného priestoru.

Text požiadavky

Name Povinné Typ Description
mode True

CommitMode

Režim operácie potvrdenia.

comment

string

maxLength: 300

Komentár bez volajúceho pre toto potvrdenie. Maximálna dĺžka je 300 znakov. Ak volajúci neposkytne žiadny komentár, použite predvolený komentár poskytovateľa systému Git.

items

ItemIdentifier[]

Konkrétne položky, ktoré sa majú potvrdiť. Toto je relevantné iba pre režim selektívneho hlásenia. Položky možno načítať z rozhrania Git Status API.

workspaceHead

string

Celkový hash SHA, s ktorým je pracovný priestor synchronizovaný. Hash je možné načítať z rozhrania Git Status API.

Odpovede

Name Typ Description
200 OK

Požiadavka sa úspešne dokončila.

202 Accepted

Žiadosť prijatá, potvrdenie prebiehajúceho postupu v Git.

Hlavičky

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
429 Too Many Requests

ErrorResponse

Prekročil sa limit rýchlosti služby. Server vráti hlavičku Retry-After v sekundách, ako dlho musí klient počkať, kým odošle ďalšie požiadavky.

Hlavičky

Retry-After: integer

Other Status Codes

ErrorResponse

Bežné kódy chýb:

  • WorkspaceNotConnectedToGit – pracovný priestor nie je pripojený k službe git.

  • WorkspaceHasNoCapacityAssigned – Žiadna kapacita nebola priradená do pracovného priestoru.

  • WorkspaceHeadMismatch – vedúci v žiadosti sa nezhoduje s hlavou v systéme.

  • WorkspacePreviousOperationInProgress – predchádzajúca operácia stále prebieha.

  • InsufficientPrivileges – volajúci nemá dostatočné povolenia pracovného priestoru.

  • PrincipalTypeNotSupported – Typ identity volajúceho nie je podporovaný.

Príklady

Commit all to Git example
Commit selective items to Git example

Commit all to Git example

Vzorová požiadavka

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

Vzorová odpoveď

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

Vzorová požiadavka

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

Vzorová odpoveď

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

Definície

Name Description
CommitMode

Režimy pre operáciu potvrdenia. V priebehu času je možné pridať ďalšie režimy.

CommitToGitRequest

Obsahuje žiadosť o potvrdenie.

ErrorRelatedResource

Objekt s podrobnosťami o zdroji súvisiacej s chybou.

ErrorResponse

Odpoveď na chybu.

ErrorResponseDetails

Podrobnosti o chybovej odpovedi.

ItemIdentifier

Obsahuje identifikátor položky. Musí byť definovaná aspoň jedna z vlastností.

CommitMode

Režimy pre operáciu potvrdenia. V priebehu času je možné pridať ďalšie režimy.

Hodnota Description
All

Potvrdiť všetky nekomprimované zmeny. Volajúci nie je povinný poskytovať zoznam položiek na potvrdenie.

Selective

Potvrdenie zoznamu zadaných položiek, ktorý obsahuje nekomumutované zmeny.

CommitToGitRequest

Obsahuje žiadosť o potvrdenie.

Name Typ Description
comment

string

maxLength: 300

Komentár bez volajúceho pre toto potvrdenie. Maximálna dĺžka je 300 znakov. Ak volajúci neposkytne žiadny komentár, použite predvolený komentár poskytovateľa systému Git.

items

ItemIdentifier[]

Konkrétne položky, ktoré sa majú potvrdiť. Toto je relevantné iba pre režim selektívneho hlásenia. Položky možno načítať z rozhrania Git Status API.

mode

CommitMode

Režim operácie potvrdenia.

workspaceHead

string

Celkový hash SHA, s ktorým je pracovný priestor synchronizovaný. Hash je možné načítať z rozhrania Git Status API.

ErrorRelatedResource

Objekt s podrobnosťami o zdroji súvisiacej s chybou.

Name Typ Description
resourceId

string

ID prostriedku, ktoré je súčasťou chyby.

resourceType

string

Typ prostriedku, ktorý je zapojený do chyby.

ErrorResponse

Odpoveď na chybu.

Name Typ Description
errorCode

string

Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.

message

string

Zobrazenie chyby čitateľné ľuďmi.

moreDetails

ErrorResponseDetails[]

Zoznam ďalších podrobností o chybe.

relatedResource

ErrorRelatedResource

Podrobnosti o zdrojoch súvisiacich s chybou.

requestId

string (uuid)

ID požiadavky súvisiacej s chybou.

ErrorResponseDetails

Podrobnosti o chybovej odpovedi.

Name Typ Description
errorCode

string

Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.

message

string

Zobrazenie chyby čitateľné ľuďmi.

relatedResource

ErrorRelatedResource

Podrobnosti o zdrojoch súvisiacich s chybou.

ItemIdentifier

Obsahuje identifikátor položky. Musí byť definovaná aspoň jedna z vlastností.

Name Typ Description
logicalId

string (uuid)

Logické ID položky. Keď logické ID nie je k dispozícii, pretože položka ešte nie je pridaná do pracovného priestoru, môžete použiť ID objektu.

objectId

string (uuid)

ID objektu položky. Keď ID objektu nie je k dispozícii, pretože položka bola odstránená z pracovného priestoru, môžete použiť logické ID.