Git - Get Connection

Usługa:

Core

Wersja interfejsu API:

v1

Zwraca szczegóły połączenia git dla określonego obszaru roboczego.

Uprawnienia

Obiekt wywołujący musi mieć rolę współautora lub nowszego obszaru roboczego.

Wymagane zakresy delegowane

Workspace.Read.All lub Workspace.ReadWrite.All

Tożsamości obsługiwane przez Microsoft Entra

Ten interfejs API obsługuje tożsamości firmy Microsoft wymienione w tej sekcji.

Tożsamość	Wsparcie
Użytkownik	Tak
Główne usługi i Tożsamości zarządzane	Tak

Interfejs

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
workspaceId	path	True	string (uuid)	Identyfikator obszaru roboczego.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	GitConnection	Żądanie zostało ukończone pomyślnie.
Other Status Codes	ErrorResponse	Typowe kody błędów: UnknownError — wystąpił błąd. InsufficientPrivileges — obiekt wywołujący nie ma wystarczających uprawnień obszaru roboczego.

Przykłady

Get Git connection details example

Workspace not connected to git example

Get Git connection details example

Przykładowe zapytanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

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

Przykładowe zapytanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

200

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

Definicje

Nazwa	Opis
AzureDevOpsDetails	Szczegóły dostawcy usługi Azure DevOps.
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
GitConnection	Zawiera szczegóły połączenia Git.
GitConnectionState	Stan połączenia usługi Git. W miarę upływu czasu można dodać dodatkowe typy stanów połączenia.
GitHubDetails	Szczegóły dostawcy usługi GitHub.
GitProviderType	Typ dostawcy Git. Dodatkowe typy dostawców mogą być dodawane w czasie.
GitSyncDetails	Zawiera szczegóły synchronizacji.

AzureDevOpsDetails

Sprzeciwiać się

Szczegóły dostawcy usługi Azure DevOps.

Nazwa	Typ	Opis
branchName	string maxLength: 250	Nazwa gałęzi. Maksymalna długość to 250 znaków.
directoryName	string maxLength: 256	Ścieżka względna do katalogu. Maksymalna długość to 256 znaków.
gitProviderType	string: AzureDevOps	Typ dostawcy Git. Dodatkowe typy dostawców mogą być dodawane w czasie.
organizationName	string maxLength: 100	Nazwa organizacji. Maksymalna długość to 100 znaków.
projectName	string maxLength: 100	Nazwa projektu. Maksymalna długość to 100 znaków.
repositoryName	string maxLength: 128	Nazwa repozytorium. Maksymalna długość to 128 znaków.

ErrorRelatedResource

Sprzeciwiać się

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa	Typ	Opis
resourceId	string	Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType	string	Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Sprzeciwiać się

Odpowiedź na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Sprzeciwiać się

Szczegóły odpowiedzi na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.

GitConnection

Sprzeciwiać się

Zawiera szczegóły połączenia Git.

Nazwa	Typ	Opis
gitConnectionState	GitConnectionState	Stan połączenia usługi Git. W miarę upływu czasu można dodać dodatkowe typy stanów połączenia.
gitProviderDetails	GitProviderDetails: AzureDevOpsDetails GitHubDetails	Szczegóły dostawcy Git.
gitSyncDetails	GitSyncDetails	Zawiera szczegóły synchronizacji.

GitConnectionState

Wyliczenie

Stan połączenia usługi Git. W miarę upływu czasu można dodać dodatkowe typy stanów połączenia.

Wartość	Opis
NotConnected	Stan nie jest połączony.
Connected	Stan połączenia.
ConnectedAndInitialized	Stan połączony i zainicjowany.

GitHubDetails

Sprzeciwiać się

Szczegóły dostawcy usługi GitHub.

Nazwa	Typ	Opis
branchName	string maxLength: 250	Nazwa gałęzi. Maksymalna długość to 250 znaków.
customDomainName	string maxLength: 100	Uwaga / Notatka Obsługa usługi GitHub Enterprise z miejscem przechowywania danych (ghe.com) jest obecnie dostępna w wersji zapoznawczej. (dowiedz się więcej). Nazwa domeny github przedsiębiorstwa, jeśli nie jest github.com. Obsługiwane są tylko usługi GitHub Enterprise z domenami rezydencji danych (ghe.com). Maksymalna długość to 100 znaków.
directoryName	string maxLength: 256	Ścieżka względna do katalogu. Maksymalna długość to 256 znaków.
gitProviderType	string: GitHub	Typ dostawcy Git. Dodatkowe typy dostawców mogą być dodawane w czasie.
ownerName	string maxLength: 100	Nazwa właściciela. Maksymalna długość to 100 znaków.
repositoryName	string maxLength: 128	Nazwa repozytorium. Maksymalna długość to 128 znaków.

GitProviderType

Wyliczenie

Typ dostawcy Git. Dodatkowe typy dostawców mogą być dodawane w czasie.

Wartość	Opis
AzureDevOps	Dostawca usługi Azure DevOps
GitHub	Dostawca usługi GitHub

GitSyncDetails

Sprzeciwiać się

Zawiera szczegóły synchronizacji.

Nazwa	Typ	Opis
head	string	Pełny bezpieczny algorytm wyznaczania wartości skrótu 1 (SHA-1) zsynchronizowanego identyfikatora zatwierdzenia.
lastSyncTime	string (date-time)	Data i godzina ostatniej synchronizacji.