Git - Connect

Služba:: Core

Verzia rozhrania API:: v1

Pripojte konkrétny pracovný priestor k odkladaciemu priestoru a vetve služby Git.
Táto operácia sa nesynchronizuje medzi pracovným priestorom a pripojenou vetvou. Na dokončenie synchronizácie použite operáciu Inicializovať pripojenie a postupujte podľa operácie Potvrdiť v systéme Git alebo Aktualizovať zo systému Git .

Ak chcete začať pracovať so službou GitHub, pozrite si tému: Začíname s integráciou systému Git.

Ak chcete získať ID pripojenia, pozrite si tému Automatizácia integrácie systému Git.

Povolenia

Volajúci musí mať rolu správcu pre pracovný priestor.

V prípade nakonfigurovaných poverení Git pripojenia musí mať volajúci povolenie na pripojenie.

Povinné delegované rozsahy

Workspace.ReadWrite.All

Obmedzenia

Keď používate zdroj automatických poverení, toto rozhranie API je zablokované pre poskytovateľa služby GitHub a pre objekt služby.

Podporované identity v aplikácii Microsoft Entra

Toto rozhranie API podporuje identity Microsoft uvedené v tejto časti.

Identita	Podpora
Používateľ	Áno
Objekt služby a spravované identity	Podporované iba v prípadoch, keď je myGitCredentials.source NakonfigurovanéPripojenie.

Rozhranie

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

Parametre URI

Name	V	Povinné	Typ	Description
workspaceId	path	True	string (uuid)	ID pracovného priestoru.

Text požiadavky

Name	Povinné	Typ	Description
gitProviderDetails	True	GitProviderDetails: AzureDevOpsDetails GitHubDetails	Podrobnosti o poskytovateľovi služby Git.
myGitCredentials		GitCredentials: ConfiguredConnectionGitCredentials AutomaticGitCredentials	Prihlasovacie údaje Git špecifické pre používateľa na overenie pre GitProvider. Tieto poverenia sa nezdieľajú s inými prispievateľmi pracovného priestoru. V prípade služby GitHub sa vyžaduje táto vlastnosť. Pre azureDevOps je táto vlastnosť voliteľná. Ak nie je nastavená, predvolená hodnota je AutomaticGitCredentials.

Odpovede

Name Typ Description

200 OK

Name	Typ	Description
200 OK		Požiadavka sa úspešne dokončila.
429 Too Many Requests	ErrorResponse	Prekročil sa limit rýchlosti služby. Server vráti hlavičku `Retry-After` v sekundách, ako dlho musí klient počkať, kým odošle ďalšie požiadavky. Hlavičky Retry-After: integer
Other Status Codes	ErrorResponse	Bežné kódy chýb: UnknownError – vyskytla sa chyba. WorkspaceAlreadyConnectedToGit – pracovný priestor je už pripojený k systému git. WorkspaceHasNoCapacityAssigned – žiadna kapacita priradená k pracovnému priestoru. InsufficientPrivileges – volajúci má nedostatočné povolenia pracovného priestoru. PrincipalTypeNotSupported – Typ identity volajúceho nie je podporovaný.

Požiadavka sa úspešne dokončila.

429 Too Many Requests

ErrorResponse

Prekročil sa limit rýchlosti služby. Server vráti hlavičku Retry-After v sekundách, ako dlho musí klient počkať, kým odošle ďalšie požiadavky.

Hlavičky

Retry-After: integer

Other Status Codes

ErrorResponse

Bežné kódy chýb:

UnknownError – vyskytla sa chyba.
WorkspaceAlreadyConnectedToGit – pracovný priestor je už pripojený k systému git.
WorkspaceHasNoCapacityAssigned – žiadna kapacita priradená k pracovnému priestoru.
InsufficientPrivileges – volajúci má nedostatočné povolenia pracovného priestoru.
PrincipalTypeNotSupported – Typ identity volajúceho nie je podporovaný.

Príklady

Connect a workspace to Azure DevOps example

Connect a workspace to Azure DevOps using configured connection example

Connect a workspace to GitHub example

Connect a workspace to GitHub example - GitHub Enterprise With Data Residency (ghe.com)

Connect a workspace to Azure DevOps example

Vzorová požiadavka

HTTP

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

Vzorová odpoveď

Kód stavu:: 200

Connect a workspace to Azure DevOps using configured connection example

Vzorová požiadavka

HTTP

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/Test Subdirectory"
  },
  "myGitCredentials": {
    "source": "ConfiguredConnection",
    "connectionId": "3f2504e0-4f89-11d3-9a0c-0305e82c3301"
  }
}

Vzorová odpoveď

Kód stavu:: 200

Connect a workspace to GitHub example

Vzorová požiadavka

HTTP

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

Vzorová odpoveď

Kód stavu:: 200

Connect a workspace to GitHub example - GitHub Enterprise With Data Residency (ghe.com)

Vzorová požiadavka

HTTP

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

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

Vzorová odpoveď

Kód stavu:: 200

Definície

Name	Description
AutomaticGitCredentials	Automatické poverenia Git.
AzureDevOpsDetails	Podrobnosti o poskytovateľovi Azure DevOps.
ConfiguredConnectionGitCredentials	Nakonfigurované prihlasovacie údaje Git pre pripojenie.
ErrorRelatedResource	Objekt s podrobnosťami o zdroji súvisiacej s chybou.
ErrorResponse	Odpoveď na chybu.
ErrorResponseDetails	Podrobnosti o chybovej odpovedi.
GitConnectRequest	Obsahuje údaje požiadavky Git Connect.
GitCredentialsSource	Zdroj poverení systému Git. Ďalšie zdroje poverení systému Git je možné pridať v priebehu času.
GitHubDetails	Podrobnosti o poskytovateľovi GitHubu.
GitProviderType	Typ poskytovateľa systému Git. V priebehu času je možné pridať ďalšie typy poskytovateľov.

AutomaticGitCredentials

Object

Automatické poverenia Git.

Name	Typ	Description
source	string: Automatic	Zdroj poverení systému Git.

AzureDevOpsDetails

Object

Podrobnosti o poskytovateľovi Azure DevOps.

Name	Typ	Description
branchName	string maxLength: 250	Názov vetvy. Maximálna dĺžka je 250 znakov.
directoryName	string maxLength: 256	Relatívna cesta k adresáru. Maximálna dĺžka je 256 znakov.
gitProviderType	string: AzureDevOps	Typ poskytovateľa systému Git. V priebehu času je možné pridať ďalšie typy poskytovateľov.
organizationName	string maxLength: 100	Názov organizácie. Maximálna dĺžka je 100 znakov.
projectName	string maxLength: 100	Názov projektu. Maximálna dĺžka je 100 znakov.
repositoryName	string maxLength: 128	Názov odkladacieho priestoru. Maximálna dĺžka je 128 znakov.

ConfiguredConnectionGitCredentials

Object

Nakonfigurované prihlasovacie údaje Git pre pripojenie.

Name	Typ	Description
connectionId	string (uuid)	ID objektu pripojenia.
source	string: ConfiguredConnection	Zdroj poverení systému Git.

ErrorRelatedResource

Object

Objekt s podrobnosťami o zdroji súvisiacej s chybou.

Name	Typ	Description
resourceId	string	ID prostriedku, ktoré je súčasťou chyby.
resourceType	string	Typ prostriedku, ktorý je zapojený do chyby.

ErrorResponse

Object

Odpoveď na chybu.

Name	Typ	Description
errorCode	string	Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
message	string	Zobrazenie chyby čitateľné ľuďmi.
moreDetails	ErrorResponseDetails[]	Zoznam ďalších podrobností o chybe.
relatedResource	ErrorRelatedResource	Podrobnosti o zdrojoch súvisiacich s chybou.
requestId	string (uuid)	ID požiadavky súvisiacej s chybou.

ErrorResponseDetails

Object

Podrobnosti o chybovej odpovedi.

Name	Typ	Description
errorCode	string	Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
message	string	Zobrazenie chyby čitateľné ľuďmi.
relatedResource	ErrorRelatedResource	Podrobnosti o zdrojoch súvisiacich s chybou.

GitConnectRequest

Object

Obsahuje údaje požiadavky Git Connect.

Name	Typ	Description
gitProviderDetails	GitProviderDetails: AzureDevOpsDetails GitHubDetails	Podrobnosti o poskytovateľovi služby Git.
myGitCredentials	GitCredentials: AutomaticGitCredentials ConfiguredConnectionGitCredentials	Prihlasovacie údaje Git špecifické pre používateľa na overenie pre GitProvider. Tieto poverenia sa nezdieľajú s inými prispievateľmi pracovného priestoru. V prípade služby GitHub sa vyžaduje táto vlastnosť. Pre azureDevOps je táto vlastnosť voliteľná. Ak nie je nastavená, predvolená hodnota je AutomaticGitCredentials.

GitCredentialsSource

Enumerácia

Zdroj poverení systému Git. Ďalšie zdroje poverení systému Git je možné pridať v priebehu času.

Hodnota	Description
ConfiguredConnection	Poverenia Git sa získavajú prostredníctvom nakonfigurovaného pripojenia.
Automatic	Poverenia Gitu systém automaticky získa s použitím predvolených poverení, ak sú k dispozícii.
None	Prihlasovacie údaje Git nie sú nakonfigurované.

GitHubDetails

Object

Podrobnosti o poskytovateľovi GitHubu.

Name	Typ	Description
branchName	string maxLength: 250	Názov vetvy. Maximálna dĺžka je 250 znakov.
customDomainName	string maxLength: 100	Nota Podpora pre službu GitHub Enterprise s lokalitou data residency (ghe.com) je momentálne vo verzii Preview. (ďalšie informácie). Názov podnikovej domény githubu, ak nie je github.com. Podporované je len GitHub Enterprise s doménami pobytu údajov (ghe.com). Maximálna dĺžka je 100 znakov.
directoryName	string maxLength: 256	Relatívna cesta k adresáru. Maximálna dĺžka je 256 znakov.
gitProviderType	string: GitHub	Typ poskytovateľa systému Git. V priebehu času je možné pridať ďalšie typy poskytovateľov.
ownerName	string maxLength: 100	Meno vlastníka. Maximálna dĺžka je 100 znakov.
repositoryName	string maxLength: 128	Názov odkladacieho priestoru. Maximálna dĺžka je 128 znakov.

GitProviderType

Enumerácia

Typ poskytovateľa systému Git. V priebehu času je možné pridať ďalšie typy poskytovateľov.

Hodnota	Description
AzureDevOps	Poskytovateľ Azure DevOps
GitHub	Poskytovateľ GitHubu

Zdieľať cez

Git - Connect

Povolenia

Povinné delegované rozsahy

Obmedzenia

Podporované identity v aplikácii Microsoft Entra

Rozhranie

Parametre URI

Text požiadavky

Odpovede

Príklady

Connect a workspace to Azure DevOps example

Vzorová požiadavka

Vzorová odpoveď

Connect a workspace to Azure DevOps using configured connection example

Vzorová požiadavka

Vzorová odpoveď

Connect a workspace to GitHub example

Vzorová požiadavka

Vzorová odpoveď

Connect a workspace to GitHub example - GitHub Enterprise With Data Residency (ghe.com)

Vzorová požiadavka

Vzorová odpoveď

Definície

AutomaticGitCredentials

AzureDevOpsDetails

ConfiguredConnectionGitCredentials

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GitConnectRequest

GitCredentialsSource

GitHubDetails

GitProviderType