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

Git - Initialize Connection

  • Αναφορά
Υπηρεσία:
Core
Έκδοση API:
v1

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

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

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

Δικαιώματα

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

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

Workspace.ReadWrite.All

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

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

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

Διεπαφή

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

Παράμετροι URI

Όνομα Σε Απαιτείται Τύπος Περιγραφή
workspaceId
 path True

string (uuid)

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

Κυρίως τμήμα αίτησης

Όνομα Τύπος Περιγραφή
initializationStrategy

InitializationStrategy

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

Αποκρίσεις

Όνομα Τύπος Περιγραφή
200 OK

InitializeGitConnectionResponse

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

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

Κεφαλίδες

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

ErrorResponse

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

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

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

  • MissingInitializationPolicy - Λείπει η πολιτική προετοιμασίας.

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

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

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

Initialize the connection of a workspace connected to a Git example

Δείγμα αίτησης

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

Δείγμα απόκρισης

Κωδικός κατάστασης:
200 
{
  "requiredAction": "UpdateFromGit",
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705"
}
Κωδικός κατάστασης:
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

Ορισμοί

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

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

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

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

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

Περιέχει τα δεδομένα προετοιμασίας αίτησης σύνδεσης Git.
InitializeGitConnectionResponse

Περιέχει τα δεδομένα προετοιμασίας απόκρισης σύνδεσης Git.
RequiredAction

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

ErrorRelatedResource

Object

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

Όνομα Τύπος Περιγραφή
resourceId

string

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

string

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

ErrorResponse

Object

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

Όνομα Τύπος Περιγραφή
errorCode

string

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

string

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

ErrorResponseDetails[]

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

ErrorRelatedResource

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

string

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

ErrorResponseDetails

Object

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

Όνομα Τύπος Περιγραφή
errorCode

string

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

string

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

ErrorRelatedResource

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

InitializationStrategy

Απαρίθμηση

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

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

Δεν έχει οριστεί στρατηγική.
PreferRemote

Προτιμάτε απομακρυσμένο περιεχόμενο από την πλευρά του Git.
PreferWorkspace

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

InitializeGitConnectionRequest

Object

Περιέχει τα δεδομένα προετοιμασίας αίτησης σύνδεσης Git.

Όνομα Τύπος Περιγραφή
initializationStrategy

InitializationStrategy

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

InitializeGitConnectionResponse

Object

Περιέχει τα δεδομένα προετοιμασίας απόκρισης σύνδεσης Git.

Όνομα Τύπος Περιγραφή
remoteCommitHash

string

Κατακερματισμός πλήρους δέσμευσης SHA.
requiredAction

RequiredAction

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

string

Κατακερματίζεται το Πλήρες SHA στο οποίο συγχρονίζεται ο χώρος εργασίας.

RequiredAction

Απαρίθμηση

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

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

Απαιτείται δέσμευση στο Git.
None

Δεν απαιτείται καμία ενέργεια.
UpdateFromGit

Απαιτείται ενημέρωση από το Git.