Κοινή χρήση μέσω

Git - Commit To Git

Υπηρεσία:
Core
Έκδοση API:
v1

Δεσμεύεται τις αλλαγές που πραγματοποιήθηκαν στον χώρο εργασίας στον συνδεδεμένο απομακρυσμένο κλάδο.
Αυτό το API υποστηρίζει λειτουργίες μεγάλης διάρκειας (LRO).

Για να χρησιμοποιήσετε αυτό το API, πρέπει να ρυθμίσετε τις παραμέτρους των διαπιστευτηρίων Git του καλούντε χρησιμοποιώντας το API Ενημέρωση των διαπιστευτηρίων μου Git . Μπορείτε να χρησιμοποιήσετε το API Λήψη των διαπιστευτηρίων μου Git για να ελέγξετε τη ρύθμιση παραμέτρων διαπιστευτηρίων Git.

Μπορείτε να επιλέξετε να καταχωρήσετε όλες τις αλλαγές ή μόνο συγκεκριμένα τροποποιημένα στοιχεία. Για να συγχρονίσετε τον χώρο εργασίας για πρώτη φορά, χρησιμοποιήστε αυτό το API μετά τα API σύνδεσης και προετοιμασίας σύνδεσης .

Δικαιώματα

Ο καλών πρέπει να έχει συνεισφέροντα ή υψηλότερο ρόλο χώρου εργασίας.

Απαιτούμενες εμβέλειες με ανάθεση

Workspace.GitCommit.All.

Υποστηριζόμενες ταυτότητες Microsoft Entra

Αυτό το API υποστηρίζει τις ταυτότητες Microsoft που παρατίθενται σε αυτή την ενότητα.

Ταυτότητα Υποστηρίζω
Χρήστης Όχι
Υπηρεσίας και διαχειριζόμενες ταυτότητες Υποστηρίζεται μόνο όταν όλα τα στοιχεία που εμπλέκονται στη λειτουργία υποστηρίζουν οντότητες υπηρεσίας

Διεπαφή

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

Παράμετροι URI

Όνομα Μέσα Απαιτούμενο Δακτυλογραφώ Περιγραφή
workspaceId
 path True

string (uuid)

Το αναγνωριστικό χώρου εργασίας.

Σώμα αιτήματος

Όνομα Απαιτούμενο Δακτυλογραφώ Περιγραφή
mode True

CommitMode

Η λειτουργία για τη λειτουργία δέσμευσης.
comment

string

maxLength: 300

Σχόλιο χωρίς κλήση για αυτήν την δέσμευση. Το μέγιστο μήκος είναι 300 χαρακτήρες. Εάν δεν παρέχεται κανένα σχόλιο από τον καλούντα, χρησιμοποιήστε το προεπιλεγμένο σχόλιο υπηρεσίας παροχής Git.
items

ItemIdentifier[]

Συγκεκριμένα στοιχεία για δέσμευση. Αυτό αφορά μόνο τη λειτουργία επιλεκτικής δέσμευσης. Τα στοιχεία μπορούν να ανακτηθούν από το API κατάστασης Git .
workspaceHead

string

Κατακερματίζεται το Πλήρες SHA στο οποίο συγχρονίζεται ο χώρος εργασίας. Ο κατακερματισμένος κωδικός μπορεί να ανακτηθεί από το API κατάστασης Git .

Απαντήσεις

Όνομα Δακτυλογραφώ Περιγραφή
200 OK

Η αίτηση ολοκληρώθηκε με επιτυχία.
202 Accepted

Αίτηση αποδοχής, δέσμευση στο Git σε εξέλιξη.

Κεφαλίδες

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

ErrorResponse

Έγινε υπέρβαση του ορίου επιτοκίου υπηρεσίας. Ο διακομιστής επιστρέφει μια Retry-After κεφαλίδα που υποδεικνύει, σε δευτερόλεπτα, πόσο πρέπει να περιμένει ο υπολογιστής-πελάτης πριν από την αποστολή πρόσθετων αιτήσεων.

Κεφαλίδες

Retry-After: integer
Other Status Codes

ErrorResponse

Συνήθεις κωδικοί σφαλμάτων:

  • WorkspaceNotConnectedToGit - Ο χώρος εργασίας δεν είναι συνδεδεμένος στο git.

  • WorkspaceHasNoCapacityAssigned - Δεν υπάρχει σύνολο εκχωρημένων πόρων που έχει συνδεθεί στον χώρο εργασίας.

  • WorkspaceHeadMismatch - Η κεφαλή στην αίτηση δεν συμφωνεί με την κεφαλή του συστήματος.

  • WorkspacePreviousOperationInProgress - Η προηγούμενη λειτουργία βρίσκεται ακόμα σε εξέλιξη.

  • InsufficientPrivileges - Ο καλών δεν διαθέτει επαρκή δικαιώματα χώρου εργασίας.

  • PrincipalTypeNotSupported - Δεν υποστηρίζεται ο τύπος ταυτότητας καλούντα.

Παραδείγματα

Commit all to Git example
Commit selective items to Git example

Commit all to Git example

Αίτημα δείγματος

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

Δείγμα απάντησης

Κωδικός κατάστασης:
200
Κωδικός κατάστασης:
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

Αίτημα δείγματος

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

Δείγμα απάντησης

Κωδικός κατάστασης:
200
Κωδικός κατάστασης:
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

Ορισμοί

Όνομα Περιγραφή
CommitMode

Λειτουργίες για τη λειτουργία δέσμευσης. Ενδέχεται να προστεθούν επιπλέον λειτουργίες με την πάροδο του χρόνου.
CommitToGitRequest

Περιέχει την αίτηση δέσμευσης.
ErrorRelatedResource

Το αντικείμενο λεπτομερειών πόρου που σχετίζεται με το σφάλμα.
ErrorResponse

Η απόκριση σφάλματος.
ErrorResponseDetails

Οι λεπτομέρειες της απόκρισης σφάλματος.
ItemIdentifier

Περιέχει το αναγνωριστικό στοιχείου. Πρέπει να οριστεί τουλάχιστον μία από τις ιδιότητες.

CommitMode

Απαρίθμηση

Λειτουργίες για τη λειτουργία δέσμευσης. Ενδέχεται να προστεθούν επιπλέον λειτουργίες με την πάροδο του χρόνου.

Τιμή Περιγραφή
All

Δέσμευση όλων των μη δεσμευμένων αλλαγών. Ο καλών δεν απαιτείται να παρέχει τη λίστα των στοιχείων προς δέσμευση.
Selective

Δέσμευση μιας καθορισμένης λίστας στοιχείων με μη δεσμευμένες αλλαγές.

CommitToGitRequest

Αντικείμενο

Περιέχει την αίτηση δέσμευσης.

Όνομα Δακτυλογραφώ Περιγραφή
comment

string

maxLength: 300

Σχόλιο χωρίς κλήση για αυτήν την δέσμευση. Το μέγιστο μήκος είναι 300 χαρακτήρες. Εάν δεν παρέχεται κανένα σχόλιο από τον καλούντα, χρησιμοποιήστε το προεπιλεγμένο σχόλιο υπηρεσίας παροχής Git.
items

ItemIdentifier[]

Συγκεκριμένα στοιχεία για δέσμευση. Αυτό αφορά μόνο τη λειτουργία επιλεκτικής δέσμευσης. Τα στοιχεία μπορούν να ανακτηθούν από το API κατάστασης Git .
mode

CommitMode

Η λειτουργία για τη λειτουργία δέσμευσης.
workspaceHead

string

Κατακερματίζεται το Πλήρες SHA στο οποίο συγχρονίζεται ο χώρος εργασίας. Ο κατακερματισμένος κωδικός μπορεί να ανακτηθεί από το API κατάστασης Git .

ErrorRelatedResource

Αντικείμενο

Το αντικείμενο λεπτομερειών πόρου που σχετίζεται με το σφάλμα.

Όνομα Δακτυλογραφώ Περιγραφή
resourceId

string

Το αναγνωριστικό πόρου που εμπλέκεται στο σφάλμα.
resourceType

string

Ο τύπος του πόρου που εμπλέκεται στο σφάλμα.

ErrorResponse

Αντικείμενο

Η απόκριση σφάλματος.

Όνομα Δακτυλογραφώ Περιγραφή
errorCode

string

Ένα συγκεκριμένο αναγνωριστικό που παρέχει πληροφορίες σχετικά με μια συνθήκη σφάλματος, επιτρέποντας τυποποιημένη επικοινωνία μεταξύ της υπηρεσίας μας και των χρηστών της.
message

string

Μια αναγνώσιμη αναπαράσταση του σφάλματος.
moreDetails

ErrorResponseDetails[]

Λίστα πρόσθετων λεπτομερειών σφάλματος.
relatedResource

ErrorRelatedResource

Οι λεπτομέρειες του πόρου που σχετίζονται με το σφάλμα.
requestId

string (uuid)

Το αναγνωριστικό της αίτησης που σχετίζεται με το σφάλμα.

ErrorResponseDetails

Αντικείμενο

Οι λεπτομέρειες της απόκρισης σφάλματος.

Όνομα Δακτυλογραφώ Περιγραφή
errorCode

string

Ένα συγκεκριμένο αναγνωριστικό που παρέχει πληροφορίες σχετικά με μια συνθήκη σφάλματος, επιτρέποντας τυποποιημένη επικοινωνία μεταξύ της υπηρεσίας μας και των χρηστών της.
message

string

Μια αναγνώσιμη αναπαράσταση του σφάλματος.
relatedResource

ErrorRelatedResource

Οι λεπτομέρειες του πόρου που σχετίζονται με το σφάλμα.

ItemIdentifier

Αντικείμενο

Περιέχει το αναγνωριστικό στοιχείου. Πρέπει να οριστεί τουλάχιστον μία από τις ιδιότητες.

Όνομα Δακτυλογραφώ Περιγραφή
logicalId

string (uuid)

Το λογικό αναγνωριστικό του στοιχείου. Όταν το λογικό αναγνωριστικό δεν είναι διαθέσιμο επειδή το στοιχείο δεν έχει προστεθεί ακόμα στον χώρο εργασίας, μπορείτε να χρησιμοποιήσετε το αναγνωριστικό αντικειμένου.
objectId

string (uuid)

Το αναγνωριστικό αντικειμένου του στοιχείου. Όταν το αναγνωριστικό αντικειμένου δεν είναι διαθέσιμο επειδή το στοιχείο διαγράφηκε από τον χώρο εργασίας, μπορείτε να χρησιμοποιήσετε το λογικό αναγνωριστικό.