Git - Connect

Služba:: Core

Verze rozhraní API:: v1

Připojte konkrétní pracovní prostor k úložišti a větvi Git.
Tato operace se nesynchronizuje mezi pracovním prostorem a připojenou větví. K dokončení synchronizace použijte operaci Inicializace připojení a postupujte podle operace Potvrdit do Gitu nebo Aktualizovat z Gitu .

Pokud chcete začít s GitHubem, přečtěte si téma: Začínáme s integrací Gitu.

Id připojení získáte v tématu Automatizace integrace Gitu.

Dovolení

Volající musí mít pro pracovní prostor roli správce .

Pro nakonfigurované přihlašovací údaje Gitu pro připojení musí volající mít oprávnění pro připojení.

Požadované delegovaná rozsahy

Workspace.ReadWrite.All

Omezení

Při použití automatického zdroje přihlašovacích údajů se toto rozhraní API zablokuje pro poskytovatele GitHubu a pro instanční objekt.

Podporované identity Microsoft Entra

Toto rozhraní API podporuje identity Microsoft uvedené v této části.

Identita	Podpora
Uživatel	Ano
Hlavní služba a Spravované identity	Podporováno pouze v případě, že myGitCredentials.source je ConfiguredConnection

Rozhraní

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
workspaceId	path	True	string (uuid)	ID pracovního prostoru.

Text požadavku

Name	Vyžadováno	Typ	Description
gitProviderDetails	True	GitProviderDetails: AzureDevOpsDetails GitHubDetails	Podrobnosti o poskytovateli Gitu
myGitCredentials		GitCredentials: ConfiguredConnectionGitCredentials AutomaticGitCredentials	Přihlašovací údaje Gitu specifické pro uživatele pro ověřování pro GitProvider. Tyto přihlašovací údaje nejsou sdíleny s dalšími přispěvateli pracovních prostorů. Pro GitHub je tato vlastnost povinná. Pro AzureDevOps je tato vlastnost volitelná. Pokud není nastavená, výchozí hodnota je AutomaticGitCredentials.

Odpovědi

Name	Typ	Description
200 OK		Žádost byla úspěšně dokončena.
Other Status Codes	ErrorResponse	Běžné kódy chyb: Neznámá chyba – došlo k chybě. WorkspaceAlreadyConnectedToGit – Pracovní prostor je již připojený k Gitu. WorkspaceHasNoCapacityAssigned – k pracovnímu prostoru není přiřazena žádná kapacita. InsufficientPrivileges – Volající nemá dostatečná oprávnění pracovního prostoru. PrincipalTypeNotSupported – Typ identity volajícího není podporován.

Name

Typ

Description

200 OK

Žádost byla úspěšně dokončena.

Other Status Codes

ErrorResponse

Běžné kódy chyb:

Neznámá chyba – došlo k chybě.
WorkspaceAlreadyConnectedToGit – Pracovní prostor je již připojený k Gitu.
WorkspaceHasNoCapacityAssigned – k pracovnímu prostoru není přiřazena žádná kapacita.
InsufficientPrivileges – Volající nemá dostatečná oprávnění pracovního prostoru.
PrincipalTypeNotSupported – Typ identity volajícího není podporován.

Pří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 Azure DevOps example

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 200

Connect a workspace to Azure DevOps using configured connection example

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 200

Connect a workspace to GitHub example

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 200

Definice

Name	Description
AutomaticGitCredentials	Automatické přihlašovací údaje Gitu
AzureDevOpsDetails	Podrobnosti o poskytovateli Azure DevOps
ConfiguredConnectionGitCredentials	Nakonfigurované přihlašovací údaje Gitu pro připojení
ErrorRelatedResource	Chyba související s objektem podrobností o prostředku.
ErrorResponse	Odpověď na chybu.
ErrorResponseDetails	Podrobnosti o odpovědi na chybu.
GitConnectRequest	Obsahuje data žádosti o připojení Gitu.
GitCredentialsSource	Zdroj přihlašovacích údajů Gitu. Další zdroje přihlašovacích údajů Gitu se můžou přidat v průběhu času.
GitHubDetails	Podrobnosti o poskytovateli GitHubu
GitProviderType	Typ zprostředkovatele Git. V průběhu času je možné přidat další typy zprostředkovatelů.

AutomaticGitCredentials

Objekt

Automatické přihlašovací údaje Gitu

Name	Typ	Description
source	string: Automatic	Zdroj přihlašovacích údajů Gitu.

AzureDevOpsDetails

Objekt

Podrobnosti o poskytovateli Azure DevOps

Name	Typ	Description
branchName	string maxLength: 250	Název větve. Maximální délka je 250 znaků.
directoryName	string maxLength: 256	Relativní cesta k adresáři. Maximální délka je 256 znaků.
gitProviderType	string: AzureDevOps	Typ zprostředkovatele Git. V průběhu času je možné přidat další typy zprostředkovatelů.
organizationName	string maxLength: 100	Název organizace. Maximální délka je 100 znaků.
projectName	string maxLength: 100	Název projektu. Maximální délka je 100 znaků.
repositoryName	string maxLength: 128	Název úložiště. Maximální délka je 128 znaků.

ConfiguredConnectionGitCredentials

Objekt

Nakonfigurované přihlašovací údaje Gitu pro připojení

Name	Typ	Description
connectionId	string (uuid)	ID objektu připojení.
source	string: ConfiguredConnection	Zdroj přihlašovacích údajů Gitu.

ErrorRelatedResource

Objekt

Chyba související s objektem podrobností o prostředku.

Name	Typ	Description
resourceId	string	ID prostředku, které je součástí chyby.
resourceType	string	Typ prostředku, který je součástí chyby.

ErrorResponse

Objekt

Odpověď na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message	string	Lidské čitelné vyjádření chyby.
moreDetails	ErrorResponseDetails[]	Seznam dalších podrobností o chybě
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou
requestId	string	ID požadavku přidruženého k chybě.

ErrorResponseDetails

Objekt

Podrobnosti o odpovědi na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message	string	Lidské čitelné vyjádření chyby.
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou

GitConnectRequest

Objekt

Obsahuje data žádosti o připojení Gitu.

Name	Typ	Description
gitProviderDetails	GitProviderDetails: AzureDevOpsDetails GitHubDetails	Podrobnosti o poskytovateli Gitu
myGitCredentials	GitCredentials: AutomaticGitCredentials ConfiguredConnectionGitCredentials	Přihlašovací údaje Gitu specifické pro uživatele pro ověřování pro GitProvider. Tyto přihlašovací údaje nejsou sdíleny s dalšími přispěvateli pracovních prostorů. Pro GitHub je tato vlastnost povinná. Pro AzureDevOps je tato vlastnost volitelná. Pokud není nastavená, výchozí hodnota je AutomaticGitCredentials.

GitCredentialsSource

Výčet

Zdroj přihlašovacích údajů Gitu. Další zdroje přihlašovacích údajů Gitu se můžou přidat v průběhu času.

Hodnota	Description
ConfiguredConnection	Přihlašovací údaje Gitu se získávají prostřednictvím nakonfigurovaného připojení.
Automatic	Přihlašovací údaje Gitu automaticky získá systém s použitím výchozích přihlašovacích údajů, pokud jsou k dispozici.
None	Přihlašovací údaje Gitu nejsou nakonfigurované.

GitHubDetails

Objekt

Podrobnosti o poskytovateli GitHubu

Name	Typ	Description
branchName	string maxLength: 250	Název větve. Maximální délka je 250 znaků.
directoryName	string maxLength: 256	Relativní cesta k adresáři. Maximální délka je 256 znaků.
gitProviderType	string: GitHub	Typ zprostředkovatele Git. V průběhu času je možné přidat další typy zprostředkovatelů.
ownerName	string maxLength: 100	Jméno vlastníka. Maximální délka je 100 znaků.
repositoryName	string maxLength: 128	Název úložiště. Maximální délka je 128 znaků.

GitProviderType

Výčet

Typ zprostředkovatele Git. V průběhu času je možné přidat další typy zprostředkovatelů.

Hodnota	Description
AzureDevOps	Poskytovatel Azure DevOps
GitHub	Poskytovatel GitHubu

Sdílet prostřednictvím

Git - Connect

Dovolení

Požadované delegovaná rozsahy

Omezení

Podporované identity Microsoft Entra

Rozhraní

Parametry identifikátoru URI

Text požadavku

Odpovědi

Příklady

Connect a workspace to Azure DevOps example

Ukázkový požadavek

Ukázková odpověď

Connect a workspace to Azure DevOps using configured connection example

Ukázkový požadavek

Ukázková odpověď

Connect a workspace to GitHub example

Ukázkový požadavek

Ukázková odpověď

Definice

AutomaticGitCredentials

AzureDevOpsDetails

ConfiguredConnectionGitCredentials

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GitConnectRequest

GitCredentialsSource

GitHubDetails

GitProviderType