Git - Get Connection

Dienst:

Core

API-Version:

v1

Gibt Git-Verbindungsdetails für den angegebenen Arbeitsbereich zurück.

Erlaubnisse

Der Aufrufer muss einen Mitwirkenden oder eine höhere Arbeitsbereichsrolle haben.

Erforderliche delegierte Bereiche

Workspace.Read.All oder Workspace.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identität	Unterstützung
Benutzer	Ja
Dienstprinzipal und verwaltete Identitäten	Ja

Schnittstelle

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
workspaceId	path	True	string (uuid)	Die Arbeitsbereichs-ID.

Antworten

Name	Typ	Beschreibung
200 OK	GitConnection	Die Anforderung wurde erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Häufige Fehlercodes: UnknownError – Ein Fehler ist aufgetreten. InsufficientPrivileges – Der Aufrufer verfügt nicht über ausreichende Arbeitsbereichsberechtigungen.

Beispiele

Get Git connection details example

Workspace not connected to git example

Get Git connection details example

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

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

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

200

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

Definitionen

Name	Beschreibung
AzureDevOpsDetails	Details des Azure DevOps-Anbieters.
ErrorRelatedResource	Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
GitConnection	Enthält die Git-Verbindungsdetails.
GitConnectionState	Git-Verbindungsstatus. Zusätzliche Verbindungsstatustypen können im Laufe der Zeit hinzugefügt werden.
GitHubDetails	Details des GitHub-Anbieters.
GitProviderType	Ein Git-Anbietertyp. Zusätzliche Anbietertypen können im Laufe der Zeit hinzugefügt werden.
GitSyncDetails	Enthält die Synchronisierungsdetails.

AzureDevOpsDetails

Objekt

Details des Azure DevOps-Anbieters.

Name	Typ	Beschreibung
branchName	string maxLength: 250	Der Verzweigungsname. Die maximale Länge beträgt 250 Zeichen.
directoryName	string maxLength: 256	Der relative Pfad zum Verzeichnis. Die maximale Länge beträgt 256 Zeichen.
gitProviderType	string: AzureDevOps	Ein Git-Anbietertyp. Zusätzliche Anbietertypen können im Laufe der Zeit hinzugefügt werden.
organizationName	string maxLength: 100	Der Name der Organisation. Die maximale Länge beträgt 100 Zeichen.
projectName	string maxLength: 100	Der Projektname. Die maximale Länge beträgt 100 Zeichen.
repositoryName	string maxLength: 128	Der Repositoryname. Die maximale Länge beträgt 128 Zeichen.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name	Typ	Beschreibung
resourceId	string	Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType	string	Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine lesbare Darstellung des Fehlers.
moreDetails	ErrorResponseDetails[]	Liste der zusätzlichen Fehlerdetails.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.
requestId	string	ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine lesbare Darstellung des Fehlers.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.

GitConnection

Objekt

Enthält die Git-Verbindungsdetails.

Name	Typ	Beschreibung
gitConnectionState	GitConnectionState	Git-Verbindungsstatus. Zusätzliche Verbindungsstatustypen können im Laufe der Zeit hinzugefügt werden.
gitProviderDetails	GitProviderDetails: AzureDevOpsDetails GitHubDetails	Details des Git-Anbieters.
gitSyncDetails	GitSyncDetails	Enthält die Synchronisierungsdetails.

GitConnectionState

Enumeration

Git-Verbindungsstatus. Zusätzliche Verbindungsstatustypen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
NotConnected	Nicht verbundener Zustand.
Connected	Verbundener Zustand.
ConnectedAndInitialized	Verbundener und initialisierter Zustand.

GitHubDetails

Objekt

Details des GitHub-Anbieters.

Name	Typ	Beschreibung
branchName	string maxLength: 250	Der Verzweigungsname. Die maximale Länge beträgt 250 Zeichen.
directoryName	string maxLength: 256	Der relative Pfad zum Verzeichnis. Die maximale Länge beträgt 256 Zeichen.
gitProviderType	string: GitHub	Ein Git-Anbietertyp. Zusätzliche Anbietertypen können im Laufe der Zeit hinzugefügt werden.
ownerName	string maxLength: 100	Der Besitzername. Die maximale Länge beträgt 100 Zeichen.
repositoryName	string maxLength: 128	Der Repositoryname. Die maximale Länge beträgt 128 Zeichen.

GitProviderType

Enumeration

Ein Git-Anbietertyp. Zusätzliche Anbietertypen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
AzureDevOps	Azure DevOps-Anbieter
GitHub	GitHub-Anbieter

GitSyncDetails

Objekt

Enthält die Synchronisierungsdetails.

Name	Typ	Beschreibung
head	string	Der vollständige sichere Hashalgorithmus 1 (SHA-1) der synchronisierten Commit-ID.
lastSyncTime	string (date-time)	Das Datum und die Uhrzeit des letzten Synchronisierungsstatus.