Git - Commit To Git

Referencia

Szolgáltatás:: Core

API-verzió:: v1

Véglegesíti a munkaterületen végrehajtott módosításokat a csatlakoztatott távoli ágra.
Ez az API támogatja hosszú ideig futó műveleteket (LRO).

Az API használatához a hívó Git-hitelesítő adatait az Update My Git Credentials API használatával kell konfigurálni. A Git hitelesítő adatainak lekérése API-val ellenőrizheti a Git hitelesítő adatainak konfigurációját.

Dönthet úgy, hogy véglegesíti az összes módosítást, vagy csak bizonyos módosított elemeket. A munkaterület első szinkronizálásához használja ezt az API-t a Csatlakozás és a Kapcsolat API-k inicializálása után.

Engedélyek

A hívónak közreműködői vagy magasabb munkaterületi szerepkörrel kell rendelkeznie.

Kötelező delegált hatókörök

Workspace.GitCommit.All.

Microsoft Entra által támogatott identitások

Ez az API támogatja az ebben a szakaszban felsorolt Microsoft identitásokat.

Személyazonosság	Támogatás
Felhasználó	Igen
szolgáltatásfelelős és felügyelt identitások	Csak akkor támogatott, ha a Git-szolgáltató a GitHub, és a műveletben részt vevő összes elem támogatja a szolgáltatásnevek használatát

Interfész

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
workspaceId	path	True	string (uuid)	A munkaterület azonosítója.

Kérelem törzse

Name	Kötelező	Típus	Description
mode	True	CommitMode	A véglegesítési művelet módja.
comment		string maxLength: 300	Hívó nélküli megjegyzés ehhez a véglegesítéshez. A maximális hossz 300 karakter. Ha a hívó nem fűz megjegyzést, használja az alapértelmezett Git-szolgáltatói megjegyzést.
items		ItemIdentifier[]	Véglegesíteni kívánt elemek. Ez csak szelektív véglegesítési mód esetén releváns. Az elemek lekérhetők a Git Status API-ból.
workspaceHead		string	Teljes SHA-kivonat, amellyel a munkaterület szinkronizálva van. A kivonat lekérhető a Git Status API-ból.

Válaszok

Name	Típus	Description
200 OK		A kérés sikeresen befejeződött.
202 Accepted		A kérelem elfogadva, véglegesítés folyamatban a Git felé. Fejlécek Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Gyakori hibakódok: WorkspaceNotConnectedToGit – A munkaterület nincs csatlakoztatva a githez. WorkspaceHasNoCapacityAssigned – Nincs kapacitás a munkaterületre. WorkspaceHeadMismatch – A kérelemben szereplő fej nem egyezik a rendszer fejével. WorkspacePreviousOperationInProgress – Az előző művelet még folyamatban van. InsufficientPrivileges – A hívó nem rendelkezik megfelelő munkaterületi engedélyekkel. PrincipalTypeNotSupported – A hívó identitástípus nem támogatott.

Name

Típus

Description

200 OK

A kérés sikeresen befejeződött.

202 Accepted

A kérelem elfogadva, véglegesítés folyamatban a Git felé.

Fejlécek

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Gyakori hibakódok:

WorkspaceNotConnectedToGit – A munkaterület nincs csatlakoztatva a githez.
WorkspaceHasNoCapacityAssigned – Nincs kapacitás a munkaterületre.
WorkspaceHeadMismatch – A kérelemben szereplő fej nem egyezik a rendszer fejével.
WorkspacePreviousOperationInProgress – Az előző művelet még folyamatban van.
InsufficientPrivileges – A hívó nem rendelkezik megfelelő munkaterületi engedélyekkel.
PrincipalTypeNotSupported – A hívó identitástípus nem támogatott.

Példák

Commit all to Git example

Commit selective items to Git example

Commit all to Git example

Mintakérelem

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

Mintaválasz

Állapotkód:: 200

Állapotkód:: 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

Mintakérelem

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

Mintaválasz

Állapotkód:: 200

Állapotkód:: 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

Definíciók

Name	Description
CommitMode	A véglegesítési művelet módjai. Idővel további módok is hozzáadhatók.
CommitToGitRequest	A véglegesítési kérést tartalmazza.
ErrorRelatedResource	A hibával kapcsolatos erőforrás-részletek objektum.
ErrorResponse	A hibaválasz.
ErrorResponseDetails	A hibaválasz részletei.
ItemIdentifier	Az elemazonosítót tartalmazza. Legalább egy tulajdonságot meg kell határozni.

CommitMode

Enumerálás

A véglegesítési művelet módjai. Idővel további módok is hozzáadhatók.

Érték	Description
All	Véglegesítse az összes nem véglegesített módosítást. A hívónak nem kell megadnia a véglegesíteni kívánt elemek listáját.
Selective	Véglegesít egy megadott elemlistát, amely nem véglegesített módosításokat tartalmaz.

CommitToGitRequest

Objektum

A véglegesítési kérést tartalmazza.

Name	Típus	Description
comment	string maxLength: 300	Hívó nélküli megjegyzés ehhez a véglegesítéshez. A maximális hossz 300 karakter. Ha a hívó nem fűz megjegyzést, használja az alapértelmezett Git-szolgáltatói megjegyzést.
items	ItemIdentifier[]	Véglegesíteni kívánt elemek. Ez csak szelektív véglegesítési mód esetén releváns. Az elemek lekérhetők a Git Status API-ból.
mode	CommitMode	A véglegesítési művelet módja.
workspaceHead	string	Teljes SHA-kivonat, amellyel a munkaterület szinkronizálva van. A kivonat lekérhető a Git Status API-ból.

ErrorRelatedResource

Objektum

A hibával kapcsolatos erőforrás-részletek objektum.

Name	Típus	Description
resourceId	string	A hibában érintett erőforrás-azonosító.
resourceType	string	A hibában érintett erőforrás típusa.

ErrorResponse

Objektum

A hibaválasz.

Name	Típus	Description
errorCode	string	Egy adott azonosító, amely információt nyújt egy hibafeltételről, amely lehetővé teszi a szolgáltatás és a felhasználók közötti szabványosított kommunikációt.
message	string	A hiba emberi olvasható ábrázolása.
moreDetails	ErrorResponseDetails[]	További hibaadatok listája.
relatedResource	ErrorRelatedResource	A hibával kapcsolatos erőforrásadatok.
requestId	string	A hibához társított kérés azonosítója.

ErrorResponseDetails

Objektum

A hibaválasz részletei.

Name	Típus	Description
errorCode	string	Egy adott azonosító, amely információt nyújt egy hibafeltételről, amely lehetővé teszi a szolgáltatás és a felhasználók közötti szabványosított kommunikációt.
message	string	A hiba emberi olvasható ábrázolása.
relatedResource	ErrorRelatedResource	A hibával kapcsolatos erőforrásadatok.

ItemIdentifier

Objektum

Az elemazonosítót tartalmazza. Legalább egy tulajdonságot meg kell határozni.

Name	Típus	Description
logicalId	string (uuid)	Az elem logikai azonosítója. Ha a logikai azonosító nem érhető el, mert az elem még nincs hozzáadva a munkaterülethez, használhatja az objektumazonosítót.
objectId	string (uuid)	Az elem objektumazonosítója. Ha az objektumazonosító nem érhető el, mert az elemet törölték a munkaterületről, használhatja a logikai azonosítót.

Megosztás a következőn keresztül:

Git - Commit To Git

Engedélyek

Kötelező delegált hatókörök

Microsoft Entra által támogatott identitások

Interfész

URI-paraméterek

Kérelem törzse

Válaszok

Példák

Commit all to Git example

Mintakérelem

Mintaválasz

Commit selective items to Git example

Mintakérelem

Mintaválasz

Definíciók

CommitMode

CommitToGitRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemIdentifier