Del via

Git - Commit To Git

Tjeneste:
Core
API-versjon:
v1

Utfører endringene som er gjort i arbeidsområdet, til den tilkoblede eksterne grenen.
Denne API-en støtter langvarige operasjoner (LRO).

Hvis du vil bruke denne API-en, må oppringerens Git-legitimasjon konfigureres ved hjelp av API-en for Oppdater Min Git-legitimasjon . Du kan bruke API-en Hent Min Git-legitimasjon til å kontrollere konfigurasjonen av Git-legitimasjon.

Du kan velge å utføre alle endringer eller bare bestemte endrede elementer. Hvis du vil synkronisere arbeidsområdet for første gang, bruker du denne API-en etter tilkoblings- og initialiserings-API-ene for tilkobling.

Tillatelser

Innringeren må ha en bidragsyter eller høyere arbeidsområderolle.

Nødvendige delegerte omfang

Workspace.GitCommit.All.

Microsoft Entra-støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identitet Støtte
Bruker Ja
tjenestekontohaver og administrerte identiteter Støttes bare når alle elementene som er involvert i tjenestekontohaverne for operasjonsstøtte

Grensesnitt

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

URI-parametere

Navn I Obligatorisk Type Beskrivelse
workspaceId
 path True

string (uuid)

Arbeidsområde-ID-en.

Brødtekst for forespørsel

Navn Obligatorisk Type Beskrivelse
mode True

CommitMode

Modusen for utføringsoperasjonen.
comment

string

maxLength: 300

Anroperfri kommentar for denne utførelsen. Maksimal lengde er 300 tegn. Hvis det ikke gis noen kommentar fra anroperen, kan du bruke standard git-leverandørkommentar.
items

ItemIdentifier[]

Bestemte elementer som skal utføres. Dette er bare relevant for selektiv utføringsmodus. Elementene kan hentes fra Git-status-API-en .
workspaceHead

string

Fullstendig SHA-hash som arbeidsområdet er synkronisert til. Hash-koden kan hentes fra Git-status-API-en .

Svar

Navn Type Beskrivelse
200 OK

Forespørselen er fullført.
202 Accepted

Forespørsel godtatt, forplikte til Git pågår.

Overskrifter

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Vanlige feilkoder:

  • WorkspaceNotConnectedToGit – arbeidsområdet er ikke koblet til git.

  • WorkspaceHasNoCapacityAssigned – ingen kapasitet tilordnet til arbeidsområdet.

  • WorkspaceHeadMismatch – Hodet i forespørselen samsvarer ikke med hodet i systemet.

  • WorkspacePreviousOperationInProgress – Forrige operasjon pågår fortsatt.

  • InsufficientPrivileges – Innringeren har ikke tilstrekkelige arbeidsområdetillatelser.

  • PrincipalTypeNotSupported – identitetstypen Anroper støttes ikke.

Eksempler

Commit all to Git example
Commit selective items to Git example

Commit all to Git example

Eksempelforespørsel

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

Eksempelsvar

Statuskode:
200
Statuskode:
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

Eksempelforespørsel

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

Eksempelsvar

Statuskode:
200
Statuskode:
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

Definisjoner

Navn Beskrivelse
CommitMode

Moduser for utføringsoperasjonen. Flere moduser kan legges til over tid.
CommitToGitRequest

Inneholder utføringsforespørselen.
ErrorRelatedResource

Objektet for feilrelaterte ressursdetaljer.
ErrorResponse

Feilsvaret.
ErrorResponseDetails

Feilsvardetaljene.
ItemIdentifier

Inneholder elementidentifikatoren. Minst én av egenskapene må defineres.

CommitMode

Opplisting

Moduser for utføringsoperasjonen. Flere moduser kan legges til over tid.

Verdi Beskrivelse
All

Utfør alle uforpliktende endringer. Anroperen er ikke nødvendig for å angi listen over elementer som skal utføres.
Selective

Utfør en angitt elementliste som har uforpliktende endringer.

CommitToGitRequest

Object

Inneholder utføringsforespørselen.

Navn Type Beskrivelse
comment

string

maxLength: 300

Anroperfri kommentar for denne utførelsen. Maksimal lengde er 300 tegn. Hvis det ikke gis noen kommentar fra anroperen, kan du bruke standard git-leverandørkommentar.
items

ItemIdentifier[]

Bestemte elementer som skal utføres. Dette er bare relevant for selektiv utføringsmodus. Elementene kan hentes fra Git-status-API-en .
mode

CommitMode

Modusen for utføringsoperasjonen.
workspaceHead

string

Fullstendig SHA-hash som arbeidsområdet er synkronisert til. Hash-koden kan hentes fra Git-status-API-en .

ErrorRelatedResource

Object

Objektet for feilrelaterte ressursdetaljer.

Navn Type Beskrivelse
resourceId

string

Ressurs-ID-en som er involvert i feilen.
resourceType

string

Typen ressurs som er involvert i feilen.

ErrorResponse

Object

Feilsvaret.

Navn Type Beskrivelse
errorCode

string

En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message

string

En menneskelig lesbar representasjon av feilen.
moreDetails

ErrorResponseDetails[]

Liste over flere feildetaljer.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.
requestId

string

ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Object

Feilsvardetaljene.

Navn Type Beskrivelse
errorCode

string

En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message

string

En menneskelig lesbar representasjon av feilen.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.

ItemIdentifier

Object

Inneholder elementidentifikatoren. Minst én av egenskapene må defineres.

Navn Type Beskrivelse
logicalId

string (uuid)

Den logiske ID-en for elementet. Når den logiske IDen ikke er tilgjengelig fordi elementet ennå ikke er lagt til i arbeidsområdet, kan du bruke objekt-ID-en.
objectId

string (uuid)

Objekt-ID-en for elementet. Når objekt-ID-en ikke er tilgjengelig fordi elementet ble slettet fra arbeidsområdet, kan du bruke den logiske ID-en.