Git - Commit To Git

Servizio:: Core

Versione API:: v1

Esegue il commit delle modifiche apportate nell'area di lavoro al ramo remoto connesso.
Questa API supporta operazioni con esecuzione prolungata (LRO).

Per usare questa API, è necessario configurare le credenziali Git del chiamante usando l'API Aggiorna credenziali Git personali. È possibile usare l'API Get My Git Credentials (Ottieni credenziali Git personali ) per controllare la configurazione delle credenziali Git.

È possibile scegliere di eseguire il commit di tutte le modifiche o solo di elementi modificati specifici. Per sincronizzare l'area di lavoro per la prima volta, usare questa API dopo le API Di connessione connetti e inizializza .

Autorizzazioni

Il chiamante deve avere un ruolo di collaboratore o superiore dell'area di lavoro.

Ambiti delegati obbligatori

Workspace.GitCommit.All.

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identità	Assistenza
Utente	Sì
Entità servizio e Identità gestite	Supportato solo quando tutti gli elementi coinvolti nell'operazione supportano le entità servizio

Interfaccia

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
workspaceId	path	True	string (uuid)	ID dell'area di lavoro.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
mode	True	CommitMode	Modalità per l'operazione di commit.
comment		string maxLength: 300	Commento senza chiamante per questo commit. La lunghezza massima è di 300 caratteri. Se non viene fornito alcun commento dal chiamante, usare il commento predefinito del provider Git.
items		ItemIdentifier[]	Elementi specifici da eseguire per il commit. Questo è rilevante solo per la modalità commit selettivo. Gli elementi possono essere recuperati dall'API Stato Git .
workspaceHead		string	Hash SHA completo in cui è sincronizzata l'area di lavoro. L'hash può essere recuperato dall'API Stato Git .

Risposte

Nome	Tipo	Descrizione
200 OK		Richiesta completata correttamente.
202 Accepted		Richiesta accettata, commit in Git in corso. Intestazioni Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Codici di errore comuni: WorkspaceNotConnectedToGit: l'area di lavoro non è connessa a Git. WorkspaceHasNoCapacityAssigned: nessuna capacità inserita nell'area di lavoro. WorkspaceHeadMismatch: head nella richiesta non corrisponde all'intestazione nel sistema. WorkspacePreviousOperationInProgress- L'operazione precedente è ancora in corso. InsufficientPrivileges: il chiamante non dispone di autorizzazioni sufficienti per l'area di lavoro. PrincipalTypeNotSupported: il tipo di identità del chiamante non è supportato.

Nome

Tipo

Descrizione

200 OK

Richiesta completata correttamente.

202 Accepted

Richiesta accettata, commit in Git in corso.

Intestazioni

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

Other Status Codes

ErrorResponse

Codici di errore comuni:

WorkspaceNotConnectedToGit: l'area di lavoro non è connessa a Git.
WorkspaceHasNoCapacityAssigned: nessuna capacità inserita nell'area di lavoro.
WorkspaceHeadMismatch: head nella richiesta non corrisponde all'intestazione nel sistema.
WorkspacePreviousOperationInProgress- L'operazione precedente è ancora in corso.
InsufficientPrivileges: il chiamante non dispone di autorizzazioni sufficienti per l'area di lavoro.
PrincipalTypeNotSupported: il tipo di identità del chiamante non è supportato.

Esempio

Commit all to Git example

Commit selective items to Git example

Commit all to Git example

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 200

Codice di stato:: 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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 200

Codice di stato:: 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

Definizioni

Nome	Descrizione
CommitMode	Modalità per l'operazione di commit. È possibile aggiungere altre modalità nel tempo.
CommitToGitRequest	Contiene la richiesta di commit.
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
ItemIdentifier	Contiene l'identificatore dell'elemento. È necessario definire almeno una delle proprietà.

CommitMode

Enumerazione

Modalità per l'operazione di commit. È possibile aggiungere altre modalità nel tempo.

Valore	Descrizione
All	Eseguire il commit di tutte le modifiche di cui non è stato eseguito il commit. Il chiamante non è necessario per fornire l'elenco di elementi di cui eseguire il commit.
Selective	Eseguire il commit di un elenco di elementi specificato con modifiche di cui non è stato eseguito il commit.

CommitToGitRequest

Object

Contiene la richiesta di commit.

Nome	Tipo	Descrizione
comment	string maxLength: 300	Commento senza chiamante per questo commit. La lunghezza massima è di 300 caratteri. Se non viene fornito alcun commento dal chiamante, usare il commento predefinito del provider Git.
items	ItemIdentifier[]	Elementi specifici da eseguire per il commit. Questo è rilevante solo per la modalità commit selettivo. Gli elementi possono essere recuperati dall'API Stato Git .
mode	CommitMode	Modalità per l'operazione di commit.
workspaceHead	string	Hash SHA completo in cui è sincronizzata l'area di lavoro. L'hash può essere recuperato dall'API Stato Git .

ErrorRelatedResource

Object

Oggetto dettagli risorsa correlato all'errore.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa coinvolto nell'errore.
resourceType	string	Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Object

Risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.
requestId	string	ID della richiesta associata all'errore.

ErrorResponseDetails

Object

Dettagli della risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.

ItemIdentifier

Object

Contiene l'identificatore dell'elemento. È necessario definire almeno una delle proprietà.

Nome	Tipo	Descrizione
logicalId	string (uuid)	ID logico dell'elemento. Quando l'ID logico non è disponibile perché l'elemento non è ancora stato aggiunto all'area di lavoro, è possibile usare l'ID oggetto.
objectId	string (uuid)	ID oggetto dell'elemento. Quando l'ID oggetto non è disponibile perché l'elemento è stato eliminato dall'area di lavoro, è possibile usare l'ID logico.

Condividi tramite

Git - Commit To Git

Autorizzazioni

Ambiti delegati obbligatori

Identità supportate da Microsoft Entra

Interfaccia

Parametri dell'URI

Corpo della richiesta

Risposte

Esempio

Commit all to Git example

Esempio di richiesta

Risposta di esempio

Commit selective items to Git example

Esempio di richiesta

Risposta di esempio

Definizioni

CommitMode

CommitToGitRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemIdentifier