Git - Commit To Git

Služba:: Core

Verze rozhraní API:: v1

Potvrdí změny provedené v pracovním prostoru do připojené vzdálené větve.
Toto rozhraní API podporuje dlouhotrvajících operací (LRO).

Pokud chcete toto rozhraní API použít, musí být přihlašovací údaje Git volajícího nakonfigurované pomocí rozhraní UPDATE MY Git CREDENTIALS API. Ke kontrole konfigurace přihlašovacích údajů Gitu můžete použít rozhraní API Získat moje přihlašovací údaje Gitu .

Můžete se rozhodnout potvrdit všechny změny nebo jenom určité změněné položky. Pokud chcete pracovní prostor synchronizovat poprvé, použijte toto rozhraní API po připojení a inicializaci rozhraní API připojení.

Dovolení

Volající musí mít roli přispěvatele nebo vyšší roli pracovního prostoru.

Požadované delegovaná rozsahy

Workspace.GitCommit.All.

Podporované identity Microsoft Entra

Toto rozhraní API podporuje identity Microsoft uvedené v této části.

Identita	Podpora
Uživatel	Ano
Hlavní služba a Spravované identity	Podporováno pouze v případech, kdy všechny položky zahrnuté v operaci podporují instanční objekty.

Rozhraní

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
workspaceId	path	True	string (uuid)	ID pracovního prostoru.

Text požadavku

Name	Vyžadováno	Typ	Description
mode	True	CommitMode	Režim operace potvrzení.
comment		string maxLength: 300	Komentář bez volajícího pro toto potvrzení Maximální délka je 300 znaků. Pokud volající neposkytuje žádný komentář, použijte výchozí komentář poskytovatele Gitu.
items		ItemIdentifier[]	Konkrétní položky, které se mají potvrdit To je relevantní jenom pro režim selektivního potvrzení. Položky je možné načíst z rozhraní GIT Status API.
workspaceHead		string	Úplná hodnota hash SHA, se kterou se pracovní prostor synchronizuje. Hodnotu hash je možné načíst z rozhraní GIT Status API.

Odpovědi

Name	Typ	Description
200 OK		Žádost byla úspěšně dokončena.
202 Accepted		Žádost byla přijata a potvrzena do Gitu. Hlavičky Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Běžné kódy chyb: WorkspaceNotConnectedToGit – Pracovní prostor není připojený k Gitu. WorkspaceHasNoCapacityAssigned – Žádná kapacita není přiřazena k pracovnímu prostoru. WorkspaceHeadMismatch – Hlavička v požadavku neodpovídá hlavičce v systému. WorkspacePreviousOperationInProgress – Probíhá předchozí operace. InsufficientPrivileges – Volající nemá dostatečná oprávnění pracovního prostoru. PrincipalTypeNotSupported – Typ identity volajícího není podporován.

Name

Typ

Description

200 OK

Žádost byla úspěšně dokončena.

202 Accepted

Žádost byla přijata a potvrzena do Gitu.

Hlavičky

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

Other Status Codes

ErrorResponse

Běžné kódy chyb:

WorkspaceNotConnectedToGit – Pracovní prostor není připojený k Gitu.
WorkspaceHasNoCapacityAssigned – Žádná kapacita není přiřazena k pracovnímu prostoru.
WorkspaceHeadMismatch – Hlavička v požadavku neodpovídá hlavičce v systému.
WorkspacePreviousOperationInProgress – Probíhá předchozí operace.
InsufficientPrivileges – Volající nemá dostatečná oprávnění pracovního prostoru.
PrincipalTypeNotSupported – Typ identity volajícího není podporován.

Příklady

Commit all to Git example

Commit selective items to Git example

Commit all to Git example

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 200

Stavový kó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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 200

Stavový kó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

Definice

Name	Description
CommitMode	Režimy operace potvrzení V průběhu času je možné přidat další režimy.
CommitToGitRequest	Obsahuje žádost o potvrzení.
ErrorRelatedResource	Chyba související s objektem podrobností o prostředku.
ErrorResponse	Odpověď na chybu.
ErrorResponseDetails	Podrobnosti o odpovědi na chybu.
ItemIdentifier	Obsahuje identifikátor položky. Musí být definována alespoň jedna z vlastností.

CommitMode

Výčet

Režimy operace potvrzení V průběhu času je možné přidat další režimy.

Hodnota	Description
All	Potvrďte všechny nepotvrzené změny. Volající není nutný k zadání seznamu položek k potvrzení.
Selective	Potvrďte zadaný seznam položek, který obsahuje nepotvrzené změny.

CommitToGitRequest

Objekt

Obsahuje žádost o potvrzení.

Name	Typ	Description
comment	string maxLength: 300	Komentář bez volajícího pro toto potvrzení Maximální délka je 300 znaků. Pokud volající neposkytuje žádný komentář, použijte výchozí komentář poskytovatele Gitu.
items	ItemIdentifier[]	Konkrétní položky, které se mají potvrdit To je relevantní jenom pro režim selektivního potvrzení. Položky je možné načíst z rozhraní GIT Status API.
mode	CommitMode	Režim operace potvrzení.
workspaceHead	string	Úplná hodnota hash SHA, se kterou se pracovní prostor synchronizuje. Hodnotu hash je možné načíst z rozhraní GIT Status API.

ErrorRelatedResource

Objekt

Chyba související s objektem podrobností o prostředku.

Name	Typ	Description
resourceId	string	ID prostředku, které je součástí chyby.
resourceType	string	Typ prostředku, který je součástí chyby.

ErrorResponse

Objekt

Odpověď na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message	string	Lidské čitelné vyjádření chyby.
moreDetails	ErrorResponseDetails[]	Seznam dalších podrobností o chybě
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou
requestId	string	ID požadavku přidruženého k chybě.

ErrorResponseDetails

Objekt

Podrobnosti o odpovědi na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message	string	Lidské čitelné vyjádření chyby.
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou

ItemIdentifier

Objekt

Obsahuje identifikátor položky. Musí být definována alespoň jedna z vlastností.

Name	Typ	Description
logicalId	string (uuid)	Logické ID položky. Pokud logické ID není k dispozici, protože položka ještě není přidána do pracovního prostoru, můžete použít ID objektu.
objectId	string (uuid)	ID objektu položky. Pokud ID objektu není k dispozici, protože položka byla odstraněna z pracovního prostoru, můžete použít logické ID.

Sdílet prostřednictvím

Git - Commit To Git

Dovolení

Požadované delegovaná rozsahy

Podporované identity Microsoft Entra

Rozhraní

Parametry identifikátoru URI

Text požadavku

Odpovědi

Příklady

Commit all to Git example

Ukázkový požadavek

Ukázková odpověď

Commit selective items to Git example

Ukázkový požadavek

Ukázková odpověď

Definice

CommitMode

CommitToGitRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemIdentifier