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, bestemte elementer eller bestemte filer i elementer ved hjelp av FileLevelSelective-modusen. 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

Name I Obligatorisk Type Beskrivelse
workspaceId
 path True

string (uuid)

Arbeidsområde-ID-en.

Brødtekst for forespørsel

Name 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. Gjensidig utelukkende med itemsWithFileSelection. Elementene kan hentes fra Git-status-API-en .
itemsWithFileSelection

ItemIdentifierWithFileSelection[]

Elementer med valg per fil for FileLevelSelective-utføringsmodus. Gjensidig utelukkende med elementer. Hver oppføring angir et element og eventuelt en liste over filbaner som skal utføres. Hvis valgte Filer er null eller tom for et element, utføres alle filer for elementet.
workspaceHead

string

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

Svar

Name 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
429 Too Many Requests

ErrorResponse

Grensen for tjenestesats ble overskredet. Serveren returnerer en Retry-After topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler.

Overskrifter

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 file-level selective 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 file-level selective to Git example

Eksempelforespørsel

POST https://api.fabric.microsoft.com/v1/workspaces/1565e6a3-c020-4c0c-dda7-92bafe99eec5/git/commitToGit

{
  "mode": "FileLevelSelective",
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "comment": "Commit only the metadata change from MyNotebook",
  "itemsWithFileSelection": [
    {
      "objectId": "cfafbeb1-8037-4d0c-896e-28c4f2e65573",
      "selectedFiles": [
        "metadata.json"
      ]
    },
    {
      "objectId": "d5a2b3c4-1234-5678-abcd-ef0123456789",
      "selectedFiles": []
    }
  ]
}

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

Name Beskrivelse
CommitMode

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

Inneholder utføringsforespørselen.
ErrorParameter

En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.
ErrorRelatedResource

Objektet for feilrelaterte ressursdetaljer.
ErrorResponse

Feilsvaret.
ErrorResponseDetails

Feilsvardetaljene.
ItemIdentifier

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

Inneholder elementidentifikatoren med valgfritt valg på filnivå for utføringsoperasjoner.

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 liste over elementer som har uforpliktende endringer. Bruk egenskapen items til å angi elementer.
FileLevelSelective

Utfør angitte filer i angitte elementer. itemsWithFileSelection Bruk egenskapen til å angi elementer og filer.

CommitToGitRequest

Objekt

Inneholder utføringsforespørselen.

Name 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. Gjensidig utelukkende med itemsWithFileSelection. Elementene kan hentes fra Git-status-API-en .
itemsWithFileSelection

ItemIdentifierWithFileSelection[]

Elementer med valg per fil for FileLevelSelective-utføringsmodus. Gjensidig utelukkende med elementer. Hver oppføring angir et element og eventuelt en liste over filbaner som skal utføres. Hvis valgte Filer er null eller tom for et element, utføres alle filer for elementet.
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 .

ErrorParameter

Objekt

En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.

Name Type Beskrivelse
message

string

En lesbar beskrivelse av parameterens betydning.
name

string

Parameteridentifikatoren.
value

string

Parameterverdien.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Name Type Beskrivelse
resourceId

string

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

string

Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Name Type Beskrivelse
errorCode

string

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

boolean

Når sann, kan forespørselen prøves på nytt. Retry-After Bruk svarhodet til å fastslå forsinkelsen, hvis tilgjengelig.
message

string

En menneskelig lesbar representasjon av feilen.
moreDetails

ErrorResponseDetails[]

Liste over flere feildetaljer.
parameters

ErrorParameter[]

Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.
requestId

string (uuid)

ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Name 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.
parameters

ErrorParameter[]

Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.

ItemIdentifier

Objekt

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

Name 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.

ItemIdentifierWithFileSelection

Objekt

Inneholder elementidentifikatoren med valgfritt valg på filnivå for utføringsoperasjoner.

Name 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.
selectedFiles

string[]

Filbaner som skal utføres, i forhold til elementroten. Baner bruker bare skråstreker, ingen innledende skråstrek, fullstendige filbaner (ingen mapper eller jokertegn), ingen tomme segmenter eller bare mellomrom, og segmenter kan ikke slutte med en prikk eller etterfølgende mellomrom. Hvis null eller tom, utføres alle filer for dette elementet.