Git - Get Connection Settings

Dienst:: Core

API-Version:: v1

Ruft die Verbindungseinstellungen für einen mit Git verbundenen Arbeitsbereich ab.

Note

Diese API ist Teil einer Preview-Version und wird nur für Evaluierungs- und Entwicklungszwecke bereitgestellt. Sie kann sich basierend auf Feedback ändern und wird nicht für den Produktionseinsatz empfohlen. Erfahren Sie mehr.

Gibt die Verbindungseinstellungen für einen mit Git verbundenen Arbeitsbereich zurück.

Permissions

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

Erforderliche delegierte Zugriffsbereiche

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.

Identity	Support
User	Yes
Service Principal und Verwaltete Identitäten	Yes

Interface

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

URI-Parameter

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

Antworten

Name Typ Beschreibung

200 OK

Name	Typ	Beschreibung
200 OK	GitConnectionSettings	Der Auftrag wurde erfolgreich abgeschlossen.
429 Too Many Requests	ErrorResponse	Der Dienstratenlimit wurde überschritten. Der Server gibt einen `Retry-After` Header zurück, der in Sekunden angibt, wie lange der Client warten muss, bevor zusätzliche Anforderungen gesendet werden. Header Retry-After: integer
Other Status Codes	ErrorResponse	Häufige Fehlercodes: UnknownError – Ein Fehler ist aufgetreten. InsufficientPrivileges – Der Aufrufer verfügt nicht über ausreichende Arbeitsbereichsberechtigungen. WorkspaceNotConnectedToGit – Arbeitsbereich ist nicht mit Git verbunden.

GitConnectionSettings

Der Auftrag wurde erfolgreich abgeschlossen.

429 Too Many Requests

ErrorResponse

Der Dienstratenlimit wurde überschritten. Der Server gibt einen Retry-After Header zurück, der in Sekunden angibt, wie lange der Client warten muss, bevor zusätzliche Anforderungen gesendet werden.

Header

Retry-After: integer

Other Status Codes

ErrorResponse

Häufige Fehlercodes:

UnknownError – Ein Fehler ist aufgetreten.
InsufficientPrivileges – Der Aufrufer verfügt nicht über ausreichende Arbeitsbereichsberechtigungen.
WorkspaceNotConnectedToGit – Arbeitsbereich ist nicht mit Git verbunden.

Beispiele

Get connection settings example

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "additionalRolesAuthorizedToChangeBranch": "None"
}

Definitionen

Name	Beschreibung
ErrorParameter	Ein strukturierter Parameter, der zusätzlichen computerlesbaren Kontext zu einem Fehler bereitstellt.
ErrorRelatedResource	Das Objekt der fehlerbezogenen Ressourcendetails.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
GitAdditionalBranchChangingRoles	Die zusätzlichen Arbeitsbereichsrollen über den Administrator hinaus, die die verbundene Git-Verzweigung ändern dürfen. Zusätzliche Werte können im Laufe der Zeit hinzugefügt werden.
GitConnectionSettings	Enthält die Git-Verbindungseinstellungen.

ErrorParameter

Objekt

Ein strukturierter Parameter, der zusätzlichen computerlesbaren Kontext zu einem Fehler bereitstellt.

Name	Typ	Beschreibung
message	string	Eine lesbare Beschreibung der Bedeutung des Parameters.
name	string	Die Parameterkennung.
value	string	Der übergebene Wert

ErrorRelatedResource

Objekt

Das Objekt der fehlerbezogenen Ressourcendetails.

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.
isRetriable	boolean	Wenn true, kann die Anforderung wiederholt werden. Verwenden Sie den `Retry-After` Antwortheader, um die Verzögerung zu ermitteln, falls verfügbar.
message	string	Eine menschenlesbare Darstellung des Fehlers.
moreDetails	ErrorResponseDetails[]	Liste der zusätzlichen Fehlerdetails.
parameters	ErrorParameter[]	Strukturierte Parameter, die zusätzlichen maschinenlesbaren Kontext zu dem Fehler bereitstellen.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.
requestId	string (uuid)	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 menschenlesbare Darstellung des Fehlers.
parameters	ErrorParameter[]	Strukturierte Parameter, die zusätzlichen maschinenlesbaren Kontext zu dem Fehler bereitstellen.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.

GitAdditionalBranchChangingRoles

Enumeration

Die zusätzlichen Arbeitsbereichsrollen über den Administrator hinaus, die die verbundene Git-Verzweigung ändern dürfen. Zusätzliche Werte können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
None	Keine zusätzlichen Rollen, die über den Administrator hinausgehen, können Verzweigungen ändern. Dies ist die Standardoption.
MemberAndContributor	Mitglieder und Mitwirkende können neben Administratoren auch Filialen ändern.

GitConnectionSettings

Objekt

Enthält die Git-Verbindungseinstellungen.

Name	Typ	Beschreibung
additionalRolesAuthorizedToChangeBranch	GitAdditionalBranchChangingRoles	Die zusätzlichen Arbeitsbereichsrollen über den Administrator hinaus, die die verbundene Git-Verzweigung ändern dürfen.