Megosztás a következőn keresztül:

Git - Connect

  • Referencia
Szolgáltatás:
Core
API-verzió:
v1

Adott munkaterület csatlakoztatása egy Git-adattárhoz és -ághoz.
Ez a művelet nem szinkronizálódik a munkaterület és a csatlakoztatott ág között. A szinkronizálás befejezéséhez használja a Kapcsolat inicializálása műveletet, és kövesse a Véglegesítés a Gitben vagy a Git-frissítés művelettel.

A GitHub használatának első lépéseit a Következő témakörben tekintheti meg: Ismerkedés a Git-integrációval.

A kapcsolatazonosító lekéréséhez lásd: Git-integráció automatizálása.

Engedélyek

A hívónak rendszergazdai szerepkört kell rendelkeznie a munkaterülethez.

A konfigurált kapcsolati Git-hitelesítő adatokhoz a hívónak engedéllyel kell rendelkeznie a kapcsolathoz.

Kötelező delegált hatókörök

Workspace.ReadWrite.All

Microsoft Entra által támogatott identitások

Ez az API támogatja az ebben a szakaszban felsorolt Microsoft identitásokat.

Személyazonosság Támogatás
Felhasználó Igen
szolgáltatásfelelős és felügyelt identitások Csak akkor támogatott, ha a Git-szolgáltató a GitHub

Interfész

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

URI-paraméterek

Name In Kötelező Típus Description
workspaceId
 path True

string (uuid)

A munkaterület azonosítója.

Kérelem törzse

Name Kötelező Típus Description
gitProviderDetails True GitProviderDetails:

A Git-szolgáltató adatai.
myGitCredentials GitCredentials:

Felhasználóspecifikus Git-hitelesítő adatok a GitProvider felé történő hitelesítéshez. Ezeket a hitelesítő adatokat a rendszer nem osztja meg más munkaterület-közreműködőkkel. Az AzureDevOps esetében az alapértelmezett érték az AutomaticGitCredentials. A GitHub esetében ez a tulajdonság szükséges.

Válaszok

Name Típus Description
200 OK

A kérés sikeresen befejeződött.
Other Status Codes

ErrorResponse

Gyakori hibakódok:

  • UnknownError – Hiba történt.

  • WorkspaceAlreadyConnectedToGit – A munkaterület már csatlakoztatva van a githez.

  • WorkspaceHasNoCapacityAssigned – Nincs hozzárendelt kapacitás a munkaterülethez.

  • InsufficientPrivileges – A hívó nem rendelkezik megfelelő munkaterületi engedélyekkel.

  • PrincipalTypeNotSupported – A hívó identitástípus nem támogatott.

Példák

Connect a workspace to Azure DevOps example
Connect a workspace to GitHub example

Connect a workspace to Azure DevOps example

Mintakérelem

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

{
  "gitProviderDetails": {
    "organizationName": "Test Organization",
    "projectName": "Test Project",
    "gitProviderType": "AzureDevOps",
    "repositoryName": "Test Repo",
    "branchName": "Test Branch",
    "directoryName": "Test Directory"
  }
}

Mintaválasz

Állapotkód:
200

Connect a workspace to GitHub example

Mintakérelem

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

{
  "gitProviderDetails": {
    "ownerName": "Test Owner",
    "gitProviderType": "GitHub",
    "repositoryName": "Test Repo",
    "branchName": "Test Branch",
    "directoryName": "Test Directory/Test Subdirectory"
  },
  "myGitCredentials": {
    "source": "ConfiguredConnection",
    "connectionId": "3f2504e0-4f89-11d3-9a0c-0305e82c3301"
  }
}

Mintaválasz

Állapotkód:
200

Definíciók

Name Description
AutomaticGitCredentials

Automatikus Git-hitelesítő adatok.
AzureDevOpsDetails

Az Azure DevOps-szolgáltató adatai.
ConfiguredConnectionGitCredentials

Konfigurált kapcsolati Git-hitelesítő adatok.
ErrorRelatedResource

A hibával kapcsolatos erőforrás-részletek objektum.
ErrorResponse

A hibaválasz.
ErrorResponseDetails

A hibaválasz részletei.
GitConnectRequest

A Git Connect-kérelem adatait tartalmazza.
GitCredentialsSource

A Git hitelesítő adatainak forrása. Idővel további Git-hitelesítőadat-források is hozzáadhatók.
GitHubDetails

A GitHub szolgáltatói adatai.
GitProviderType

Egy Git-szolgáltató típusa. Idővel további szolgáltatótípusok is hozzáadhatók.

AutomaticGitCredentials

Objektum

Automatikus Git-hitelesítő adatok.

Name Típus Description
source string:

Automatic

A Git hitelesítő adatainak forrása.

AzureDevOpsDetails

Objektum

Az Azure DevOps-szolgáltató adatai.

Name Típus Description
branchName

string

maxLength: 250

Az ág neve. A maximális hossz 250 karakter.
directoryName

string

maxLength: 256

A könyvtár relatív elérési útja. A maximális hossz 256 karakter.
gitProviderType string:

AzureDevOps

Egy Git-szolgáltató típusa. Idővel további szolgáltatótípusok is hozzáadhatók.
organizationName

string

maxLength: 100

A szervezet neve. A maximális hossz 100 karakter.
projectName

string

maxLength: 100

A projekt neve. A maximális hossz 100 karakter.
repositoryName

string

maxLength: 128

Az adattár neve. A maximális hossz 128 karakter.

ConfiguredConnectionGitCredentials

Objektum

Konfigurált kapcsolati Git-hitelesítő adatok.

Name Típus Description
connectionId

string (uuid)

A kapcsolat objektumazonosítója.
source string:

ConfiguredConnection

A Git hitelesítő adatainak forrása.

ErrorRelatedResource

Objektum

A hibával kapcsolatos erőforrás-részletek objektum.

Name Típus Description
resourceId

string

A hibában érintett erőforrás-azonosító.
resourceType

string

A hibában érintett erőforrás típusa.

ErrorResponse

Objektum

A hibaválasz.

Name Típus Description
errorCode

string

Egy adott azonosító, amely információt nyújt egy hibafeltételről, amely lehetővé teszi a szolgáltatás és a felhasználók közötti szabványosított kommunikációt.
message

string

A hiba emberi olvasható ábrázolása.
moreDetails

ErrorResponseDetails[]

További hibaadatok listája.
relatedResource

ErrorRelatedResource

A hibával kapcsolatos erőforrásadatok.
requestId

string

A hibához társított kérés azonosítója.

ErrorResponseDetails

Objektum

A hibaválasz részletei.

Name Típus Description
errorCode

string

Egy adott azonosító, amely információt nyújt egy hibafeltételről, amely lehetővé teszi a szolgáltatás és a felhasználók közötti szabványosított kommunikációt.
message

string

A hiba emberi olvasható ábrázolása.
relatedResource

ErrorRelatedResource

A hibával kapcsolatos erőforrásadatok.

GitConnectRequest

Objektum

A Git Connect-kérelem adatait tartalmazza.

Name Típus Description
gitProviderDetails GitProviderDetails:

A Git-szolgáltató adatai.
myGitCredentials GitCredentials:

Felhasználóspecifikus Git-hitelesítő adatok a GitProvider felé történő hitelesítéshez. Ezeket a hitelesítő adatokat a rendszer nem osztja meg más munkaterület-közreműködőkkel. Az AzureDevOps esetében az alapértelmezett érték az AutomaticGitCredentials. A GitHub esetében ez a tulajdonság szükséges.

GitCredentialsSource

Enumerálás

A Git hitelesítő adatainak forrása. Idővel további Git-hitelesítőadat-források is hozzáadhatók.

Érték Description
Automatic

A Git-hitelesítő adatokat a rendszer automatikusan lekérte, ha van ilyen, alapértelmezett hitelesítő adatokkal.
ConfiguredConnection

A Git hitelesítő adatai egy konfigurált kapcsolaton keresztül szerezhetők be.
None

A Git hitelesítő adatai nincsenek konfigurálva.

GitHubDetails

Objektum

A GitHub szolgáltatói adatai.

Name Típus Description
branchName

string

maxLength: 250

Az ág neve. A maximális hossz 250 karakter.
directoryName

string

maxLength: 256

A könyvtár relatív elérési útja. A maximális hossz 256 karakter.
gitProviderType string:

GitHub

Egy Git-szolgáltató típusa. Idővel további szolgáltatótípusok is hozzáadhatók.
ownerName

string

maxLength: 100

A tulajdonos neve. A maximális hossz 100 karakter.
repositoryName

string

maxLength: 128

Az adattár neve. A maximális hossz 128 karakter.

GitProviderType

Enumerálás

Egy Git-szolgáltató típusa. Idővel további szolgáltatótípusok is hozzáadhatók.

Érték Description
AzureDevOps

Azure DevOps-szolgáltató
GitHub

GitHub-szolgáltató