Git - Get Connection

Služba:

Core

Verze rozhraní API:

v1

Vrátí podrobnosti o připojení Gitu pro zadaný pracovní prostor.

Dovolení

Volající musí mít roli přispěvatele nebo vyšší roli pracovního prostoru.

Požadované delegovaná rozsahy

Workspace.Read.All nebo Workspace.ReadWrite.All

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	Ano

Rozhraní

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/connection

Parametry identifikátoru URI

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

Odpovědi

Name	Typ	Description
200 OK	GitConnection	Žádost byla úspěšně dokončena.
Other Status Codes	ErrorResponse	Běžné kódy chyb: Neznámá chyba – došlo k chybě. InsufficientPrivileges – Volající nemá dostatečná oprávnění pracovního prostoru.

Příklady

Get Git connection details example

Workspace not connected to git example

Get Git connection details example

Ukázkový požadavek

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/1455b6a2-c120-4c1c-dda7-92bafe99bec3/git/connection

Ukázková odpověď

Stavový kód:

200

{
  "gitProviderDetails": {
    "organizationName": "Test Organization",
    "projectName": "Test Project",
    "gitProviderType": "AzureDevOps",
    "repositoryName": "Test Repo",
    "branchName": "Test Branch",
    "directoryName": ""
  },
  "gitSyncDetails": {
    "head": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
    "lastSyncTime": "2021-11-20T09:26:43.153"
  },
  "gitConnectionState": "ConnectedAndInitialized"
}

Workspace not connected to git example

Ukázkový požadavek

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/1455b6a2-c120-4c1c-dda7-92bafe99bec3/git/connection

Ukázková odpověď

Stavový kód:

200

{
  "gitProviderDetails": null,
  "gitSyncDetails": null,
  "gitConnectionState": "NotConnected"
}

Definice

Name	Description
AzureDevOpsDetails	Podrobnosti o poskytovateli Azure DevOps
ErrorRelatedResource	Chyba související s objektem podrobností o prostředku.
ErrorResponse	Odpověď na chybu.
ErrorResponseDetails	Podrobnosti o odpovědi na chybu.
GitConnection	Obsahuje podrobnosti o připojení Gitu.
GitConnectionState	Stav připojení Git. V průběhu času se můžou přidat další typy stavu připojení.
GitHubDetails	Podrobnosti o poskytovateli GitHubu
GitProviderType	Typ zprostředkovatele Git. V průběhu času je možné přidat další typy zprostředkovatelů.
GitSyncDetails	Obsahuje podrobnosti synchronizace.

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ů.

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

GitConnection

Objekt

Obsahuje podrobnosti o připojení Gitu.

Name	Typ	Description
gitConnectionState	GitConnectionState	Stav připojení Git. V průběhu času se můžou přidat další typy stavu připojení.
gitProviderDetails	GitProviderDetails: AzureDevOpsDetails GitHubDetails	Podrobnosti o poskytovateli Gitu
gitSyncDetails	GitSyncDetails	Obsahuje podrobnosti synchronizace.

GitConnectionState

Výčet

Stav připojení Git. V průběhu času se můžou přidat další typy stavu připojení.

Hodnota	Description
NotConnected	Stav není připojený.
Connected	Připojený stav.
ConnectedAndInitialized	Připojený a inicializovaný stav.

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

GitSyncDetails

Objekt

Obsahuje podrobnosti synchronizace.

Name	Typ	Description
head	string	Úplný algoritmus hash zabezpečení 1 (SHA-1) synchronizovaného potvrzení ID.
lastSyncTime	string (date-time)	Datum a čas poslední synchronizace.