Del via

Git - Commit To Git

Tjeneste:
Core
API-version:
v1

Bekræfter de ændringer, der er foretaget i arbejdsområdet, til den forbundne eksterne forgrening.
Denne API understøtter LRO-handlinger (Long Running Operations).

Hvis du vil bruge denne API, skal den kaldendes Git-legitimationsoplysninger konfigureres ved hjælp af API'en Opdater Mine Git-legitimationsoplysninger . Du kan bruge API'en Hent Mine Git-legitimationsoplysninger til at kontrollere konfigurationen af Git-legitimationsoplysningerne.

Du kan vælge at bekræfte alle ændringer eller kun bestemte ændrede elementer. Hvis du vil synkronisere arbejdsområdet første gang, skal du bruge denne API efter API'erne Opret forbindelse og Initialiser forbindelse .

Tilladelser

Den, der ringer op, skal have en bidragyder eller en højere rolle i arbejdsområdet.

Påkrævede delegerede områder

Workspace.GitCommit.All.

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identitet Støtte
Bruger Ja
tjenesteprincipal og administrerede identiteter Understøttes kun, når alle de elementer , der er involveret i handlingen, understøtter tjenesteprincipaler

Grænseflade

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

URI-parametre

Name I Påkrævet Type Beskrivelse
workspaceId
 path True

string (uuid)

Arbejdsområde-id'et.

Brødtekst for anmodning

Name Påkrævet Type Beskrivelse
mode True

CommitMode

Tilstanden for bekræftelseshandlingen.
comment

string

maxLength: 300

Opkaldsfri kommentar til denne bekræftelse. Maksimumlængden er 300 tegn. Hvis der ikke er angivet nogen kommentar fra den, der ringer op, skal du bruge gitudbyderens standardkommentar.
items

ItemIdentifier[]

Specifikke elementer, der skal bekræftes. Dette er kun relevant for tilstanden Selektiv bekræftelse. Elementerne kan hentes fra Git Status-API'en.
workspaceHead

string

Fuld SHA-hash, som arbejdsområdet synkroniseres til. Hashværdien kan hentes fra Git Status-API'en.

Svar

Name Type Beskrivelse
200 OK

Anmodningen blev fuldført.
202 Accepted

Anmodning accepteret, bekræft git i gang.

Headere

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

ErrorResponse

Almindelige fejlkoder:

  • WorkspaceNotConnectedToGit – Arbejdsområdet har ikke forbindelse til git.

  • WorkspaceHasNoCapacityAssigned – Ingen kapacitet, der er føjet til arbejdsområdet.

  • WorkspaceHeadMismatch – Hovedet i anmodningen svarer ikke til hovedet i systemet.

  • WorkspacePreviousOperationInProgress – Forrige handling er stadig i gang.

  • InsufficientPrivileges – Den kaldende bruger har ikke tilstrækkelige tilladelser til arbejdsområdet.

  • PrincipalTypeNotSupported – Opkaldsidentitetstypen understøttes ikke.

Eksempler

Commit all to Git example
Commit selective items to Git example

Commit all to Git example

Eksempelanmodning

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

Eksempelanmodning

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

Definitioner

Name Beskrivelse
CommitMode

Tilstande for bekræftelseshandlingen. Der kan tilføjes flere tilstande over tid.
CommitToGitRequest

Indeholder bekræftelsesanmodningen.
ErrorRelatedResource

Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse

Fejlsvaret.
ErrorResponseDetails

Oplysninger om fejlsvar.
ItemIdentifier

Indeholder element-id'et. Mindst én af egenskaberne skal være defineret.

CommitMode

Optælling

Tilstande for bekræftelseshandlingen. Der kan tilføjes flere tilstande over tid.

Værdi Beskrivelse
All

Bekræft alle ændringer, der ikke er gemt. Den, der ringer op, er ikke påkrævet for at angive listen over elementer, der skal bekræftes.
Selective

Bekræft en angivet elementliste, der indeholder ændringer, der ikke er gemt.

CommitToGitRequest

Object

Indeholder bekræftelsesanmodningen.

Name Type Beskrivelse
comment

string

maxLength: 300

Opkaldsfri kommentar til denne bekræftelse. Maksimumlængden er 300 tegn. Hvis der ikke er angivet nogen kommentar fra den, der ringer op, skal du bruge gitudbyderens standardkommentar.
items

ItemIdentifier[]

Specifikke elementer, der skal bekræftes. Dette er kun relevant for tilstanden Selektiv bekræftelse. Elementerne kan hentes fra Git Status-API'en.
mode

CommitMode

Tilstanden for bekræftelseshandlingen.
workspaceHead

string

Fuld SHA-hash, som arbejdsområdet synkroniseres til. Hashværdien kan hentes fra Git Status-API'en.

ErrorRelatedResource

Object

Objektet med fejlrelaterede ressourceoplysninger.

Name Type Beskrivelse
resourceId

string

Det ressource-id, der er involveret i fejlen.
resourceType

string

Typen af ressource, der er involveret i fejlen.

ErrorResponse

Object

Fejlsvaret.

Name Type Beskrivelse
errorCode

string

Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message

string

En menneskelig læsbar gengivelse af fejlen.
moreDetails

ErrorResponseDetails[]

Liste over yderligere oplysninger om fejl.
relatedResource

ErrorRelatedResource

De fejlrelaterede ressourceoplysninger.
requestId

string

Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Object

Oplysninger om fejlsvar.

Name Type Beskrivelse
errorCode

string

Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message

string

En menneskelig læsbar gengivelse af fejlen.
relatedResource

ErrorRelatedResource

De fejlrelaterede ressourceoplysninger.

ItemIdentifier

Object

Indeholder element-id'et. Mindst én af egenskaberne skal være defineret.

Name Type Beskrivelse
logicalId

string (uuid)

Det logiske id for elementet. Når det logiske id ikke er tilgængeligt, fordi elementet endnu ikke er føjet til arbejdsområdet, kan du bruge objekt-id'et.
objectId

string (uuid)

Elementets objekt-id. Når objekt-id'et ikke er tilgængeligt, fordi elementet er slettet fra arbejdsområdet, kan du bruge det logiske id.