Git - Commit To Git

Tjänst:
Core
API-version:
v1

Genomför de ändringar som gjorts på arbetsytan i den anslutna fjärrgrenen.
Det här API:et stöder tidskrävande åtgärder (LRO).

Om du vill använda det här API:et måste anroparens Git-autentiseringsuppgifter konfigureras med api:et Uppdatera mina Git-autentiseringsuppgifter . Du kan använda API:et Hämta mina Git-autentiseringsuppgifter för att kontrollera konfigurationen av Git-autentiseringsuppgifter.

Du kan välja att checka in alla ändringar, specifika objekt eller specifika filer i objekt med hjälp av FileLevelSelective-läget. Om du vill synkronisera arbetsytan för första gången använder du det här API:et efter API:erna Anslut och Initiera anslutning .

Behörigheter

Anroparen måste ha en deltagare eller högre arbetsyteroll.

Obligatoriska delegerade omfång

Workspace.GitCommit.All.

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet Stöd
Användare Ja
Tjänsthuvudnamn och hanterade identiteter Stöds endast när alla objekt som ingår i åtgärden stöder tjänstens huvudnamn

Gränssnitt

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

URI-parametrar

Name I Obligatorisk Typ Description
workspaceId
 path True

string (uuid)

Arbetsmiljöns ID.

Begärandetext

Name Obligatorisk Typ Description
mode True

CommitMode

Läget för incheckningsåtgärden.
comment

string

maxLength: 300

Samtalsfri kommentar för den här incheckningen. Maximal längd är 300 tecken. Om ingen kommentar tillhandahålls av anroparen använder du git-providerns standardkommentar.
items

ItemIdentifier[]

Specifika objekt att checka in. Detta är endast relevant för läget Selektiv incheckning. Ömsesidigt uteslutande med itemsWithFileSelection. Objekten kan hämtas från Git-status-API :et.
itemsWithFileSelection

ItemIdentifierWithFileSelection[]

Objekt med val per fil för ArkivVäljbart incheckningsläge. Ömsesidigt uteslutande med objekt. Varje post anger ett objekt och eventuellt en lista över filsökvägar att checka in. Om selectedFiles är null eller tomt för ett objekt checkas alla filer för objektet in.
workspaceHead

string

Fullständig SHA-hash som arbetsytan synkroniseras till. Hashen kan hämtas från Git-status-API :et.

Svar

Name Typ Description
200 OK

Begäran har slutförts.
202 Accepted

Begäran accepterad, incheckning till Git pågår.

Sidhuvuden

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
429 Too Many Requests

ErrorResponse

Gränsen för tjänstfrekvens överskreds. Servern returnerar ett Retry-After huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas.

Sidhuvuden

Retry-After: integer
Other Status Codes

ErrorResponse

Vanliga felkoder:

  • ArbetsytaNotConnectedToGit – Arbetsytan är inte ansluten till git.

  • ArbetsytaHasNoCapacityAssigned – Ingen kapacitet har angetts för arbetsytan.

  • WorkspaceHeadMismatch – Huvudet i begäran matchar inte huvudet i systemet.

  • WorkspacePreviousOperationInProgress – Föregående åtgärd pågår fortfarande.

  • InsufficientPrivileges – anroparen har inte tillräcklig behörighet för arbetsytan.

  • PrincipalTypeNotSupported – Nummerpresentationstypen stöds inte.

Exempel

Commit all to Git example
Commit file-level selective to Git example
Commit selective items to Git example

Commit all to Git example

Exempelbegäran

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

Exempelsvar

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

Exempelbegäran

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

Exempelsvar

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

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
CommitMode

Lägen för incheckningsåtgärden. Ytterligare lägen kan läggas till över tid.
CommitToGitRequest

Innehåller incheckningsbegäran.
ErrorParameter

En strukturerad parameter som ger ytterligare datorläsbar kontext om ett fel.
ErrorRelatedResource

Det felrelaterade resursinformationsobjektet.
ErrorResponse

Felsvaret.
ErrorResponseDetails

Information om felsvar.
ItemIdentifier

Innehåller objektidentifieraren. Minst en av egenskaperna måste definieras.
ItemIdentifierWithFileSelection

Innehåller objektidentifieraren med val av valfri filnivå för incheckningsåtgärder.

CommitMode

Uppräkning

Lägen för incheckningsåtgärden. Ytterligare lägen kan läggas till över tid.

Värde Description
All

Checka in alla icke-bakåtkompatibla ändringar. Anroparen behöver inte ange listan över objekt som ska checkas in.
Selective

Checka in en angiven lista över objekt som har icke-bakåtkompatibla ändringar. Använd egenskapen items för att ange objekt.
FileLevelSelective

Checka in angivna filer inom angivna objekt. Använd egenskapen itemsWithFileSelection för att ange objekt och filer.

CommitToGitRequest

Objekt

Innehåller incheckningsbegäran.

Name Typ Description
comment

string

maxLength: 300

Samtalsfri kommentar för den här incheckningen. Maximal längd är 300 tecken. Om ingen kommentar tillhandahålls av anroparen använder du git-providerns standardkommentar.
items

ItemIdentifier[]

Specifika objekt att checka in. Detta är endast relevant för läget Selektiv incheckning. Ömsesidigt uteslutande med itemsWithFileSelection. Objekten kan hämtas från Git-status-API :et.
itemsWithFileSelection

ItemIdentifierWithFileSelection[]

Objekt med val per fil för ArkivVäljbart incheckningsläge. Ömsesidigt uteslutande med objekt. Varje post anger ett objekt och eventuellt en lista över filsökvägar att checka in. Om selectedFiles är null eller tomt för ett objekt checkas alla filer för objektet in.
mode

CommitMode

Läget för incheckningsåtgärden.
workspaceHead

string

Fullständig SHA-hash som arbetsytan synkroniseras till. Hashen kan hämtas från Git-status-API :et.

ErrorParameter

Objekt

En strukturerad parameter som ger ytterligare datorläsbar kontext om ett fel.

Name Typ Description
message

string

En beskrivning av parameterns betydelse som kan läsas av människor.
name

string

Parameteridentifieraren.
value

string

Parametervärdet.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name Typ Description
resourceId

string

Det resurs-ID som ingår i felet.
resourceType

string

Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name Typ Description
errorCode

string

En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
isRetriable

boolean

När det är sant kan begäran göras på nytt. Använd svarshuvudet Retry-After för att fastställa fördröjningen, om den är tillgänglig.
message

string

En mänsklig läsbar representation av felet.
moreDetails

ErrorResponseDetails[]

Lista över ytterligare felinformation.
parameters

ErrorParameter[]

Strukturerade parametrar som ger ytterligare datorläsbar kontext om felet.
relatedResource

ErrorRelatedResource

Felrelaterad resursinformation.
requestId

string (uuid)

ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name Typ Description
errorCode

string

En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message

string

En mänsklig läsbar representation av felet.
parameters

ErrorParameter[]

Strukturerade parametrar som ger ytterligare datorläsbar kontext om felet.
relatedResource

ErrorRelatedResource

Felrelaterad resursinformation.

ItemIdentifier

Objekt

Innehåller objektidentifieraren. Minst en av egenskaperna måste definieras.

Name Typ Description
logicalId

string (uuid)

Objektets logiska ID. När det logiska ID:t inte är tillgängligt eftersom objektet ännu inte har lagts till på arbetsytan kan du använda objekt-ID:t.
objectId

string (uuid)

Objektets objekt-ID. När objekt-ID:t inte är tillgängligt eftersom objektet har tagits bort från arbetsytan kan du använda det logiska ID:t.

ItemIdentifierWithFileSelection

Objekt

Innehåller objektidentifieraren med val av valfri filnivå för incheckningsåtgärder.

Name Typ Description
logicalId

string (uuid)

Objektets logiska ID. När det logiska ID:t inte är tillgängligt eftersom objektet ännu inte har lagts till på arbetsytan kan du använda objekt-ID:t.
objectId

string (uuid)

Objektets objekt-ID. När objekt-ID:t inte är tillgängligt eftersom objektet har tagits bort från arbetsytan kan du använda det logiska ID:t.
selectedFiles

string[]

Filsökvägar att checka in i förhållande till objektroten. Sökvägar använder endast snedstreck framåt, inget inledande snedstreck, endast fullständiga filsökvägar (inga kataloger eller jokertecken), inga tomma segment eller blankstegssegment och segment kan inte sluta med en punkt eller avslutande blanksteg. Om värdet är null eller tomt checkas alla filer för det här objektet in.