Freigeben über

Git - Update My Git Credentials

Dienst:
Core
API-Version:
v1

Aktualisiert die Konfigurationsdetails der Git-Anmeldeinformationen des Benutzers.
Jeder Benutzer im Arbeitsbereich verfügt über eigene konfigurierte Git-Anmeldeinformationen. Sie können die API " Meine Git-Anmeldeinformationen abrufen " verwenden, um die Konfiguration der Git-Anmeldeinformationen abzurufen.

Informationen zum Abrufen der Verbindungs-ID finden Sie unter Automatisieren der Git-Integration.

Erlaubnisse

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

Für konfigurierte Verbindungs-Git-Anmeldeinformationen muss der Aufrufer über die Berechtigung für die Verbindung verfügen.

Erforderliche delegierte Bereiche

Arbeitsbereich.ReadWrite.All

Einschränkungen

Wenn Sie die Quelle für automatische Anmeldeinformationen verwenden, wird diese API für GitHub-Anbieter und für Den Dienstprinzipal blockiert.

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 Wird nur unterstützt, wenn die Quelle "ConfiguredConnection" oder "None" ist

Schnittstelle

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/myGitCredentials

URI-Parameter

Name In Erforderlich Typ Beschreibung
workspaceId
 path True

string (uuid)

Die Arbeitsbereichs-ID.

Anforderungstext

Beim Anforderungstext kann es sich um eines der folgenden Elemente handeln:

Name Beschreibung
UpdateGitCredentialsToAutomaticRequest

Enthält die Anforderungsdaten, um die Git-Anmeldeinformationen automatisch zu aktualisieren.
UpdateGitCredentialsToConfiguredConnectionRequest

Enthält die Anforderungsdaten, um die Git-Anmeldeinformationen auf die konfigurierte Verbindung zu aktualisieren.
UpdateGitCredentialsToNoneRequest

Enthält die Anforderungsdaten zum Aktualisieren der Git-Anmeldeinformationen auf keine.

UpdateGitCredentialsToAutomaticRequest

Enthält die Anforderungsdaten, um die Git-Anmeldeinformationen automatisch zu aktualisieren.

Name Erforderlich Typ Beschreibung
source True string:

Automatic

Die Git-Anmeldeinformationsquelle.

UpdateGitCredentialsToConfiguredConnectionRequest

Enthält die Anforderungsdaten, um die Git-Anmeldeinformationen auf die konfigurierte Verbindung zu aktualisieren.

Name Erforderlich Typ Beschreibung
connectionId True

string (uuid)

Die Objekt-ID der Verbindung.
source True string:

ConfiguredConnection

Die Git-Anmeldeinformationsquelle.

UpdateGitCredentialsToNoneRequest

Enthält die Anforderungsdaten zum Aktualisieren der Git-Anmeldeinformationen auf keine.

Name Erforderlich Typ Beschreibung
source True string:

None

Die Git-Anmeldeinformationsquelle.

Antworten

Name Typ Beschreibung
200 OK GitCredentialsConfigurationResponse:

Die Anforderung wurde erfolgreich abgeschlossen.
Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • UnknownError – Ein Fehler ist aufgetreten.

  • UnzureichendesPrivileg - Der Anrufer verfügt über unzureichende Arbeitsbereichsberechtigungen.

  • WorkspaceNotConnectedToGit – Arbeitsbereich ist nicht mit Git verbunden.

  • ConnectionNotFound – Die angegebene Verbindung wurde nicht gefunden.

  • ConnectionMismatch – Die Verbindung stimmt nicht mit den Git-Anbieterdetails überein.

  • PrincipalTypeNotSupported – Der Identitätstyp des Anrufers wird nicht unterstützt.

Beispiele

Update user's Git credentials to Automatic example
Update user's Git credentials to ConfiguredConnection example
Update user's Git credentials to None example

Update user's Git credentials to Automatic example

Beispielanforderung

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

{
  "source": "Automatic"
}

Beispiel für eine Antwort

Statuscode:
200 
{
  "source": "Automatic"
}

Update user's Git credentials to ConfiguredConnection example

Beispielanforderung

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

{
  "source": "ConfiguredConnection",
  "connectionId": "3f2504e0-4f89-11d3-9a0c-0305e82c3301"
}

Beispiel für eine Antwort

Statuscode:
200 
{
  "source": "ConfiguredConnection",
  "connectionId": "3f2504e0-4f89-11d3-9a0c-0305e82c3301"
}

Update user's Git credentials to None example

Beispielanforderung

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

{
  "source": "None"
}

Beispiel für eine Antwort

Statuscode:
200 
{
  "source": "None"
}

Definitionen

Name Beschreibung
AutomaticGitCredentialsResponse

Automatische Git-Anmeldeinformationen.
ConfiguredConnectionGitCredentialsResponse

Konfigurierte Git-Anmeldeinformationen für die Verbindung.
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.
GitCredentialsSource

Die Git-Anmeldeinformationsquelle. Zusätzliche Git-Anmeldeinformationsquellen können im Laufe der Zeit hinzugefügt werden.
NoneGitCredentialsResponse

Nicht konfigurierte Git-Anmeldeinformationen.
UpdateGitCredentialsToAutomaticRequest

Enthält die Anforderungsdaten, um die Git-Anmeldeinformationen automatisch zu aktualisieren.
UpdateGitCredentialsToConfiguredConnectionRequest

Enthält die Anforderungsdaten, um die Git-Anmeldeinformationen auf die konfigurierte Verbindung zu aktualisieren.
UpdateGitCredentialsToNoneRequest

Enthält die Anforderungsdaten zum Aktualisieren der Git-Anmeldeinformationen auf keine.

AutomaticGitCredentialsResponse

Objekt

Automatische Git-Anmeldeinformationen.

Name Typ Beschreibung
source string:

Automatic

Die Git-Anmeldeinformationsquelle.

ConfiguredConnectionGitCredentialsResponse

Objekt

Konfigurierte Git-Anmeldeinformationen für die Verbindung.

Name Typ Beschreibung
connectionId

string (uuid)

Die Objekt-ID der Verbindung.
source string:

ConfiguredConnection

Die Git-Anmeldeinformationsquelle.

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.

GitCredentialsSource

Enumeration

Die Git-Anmeldeinformationsquelle. Zusätzliche Git-Anmeldeinformationsquellen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
ConfiguredConnection

Die Git-Anmeldeinformationen werden über eine konfigurierte Verbindung abgerufen.
Automatic

Die Git-Anmeldeinformationen werden automatisch vom System abgerufen und verwenden standardmäßige Anmeldeinformationen, sofern verfügbar.
None

Die Git-Anmeldeinformationen sind nicht konfiguriert.

NoneGitCredentialsResponse

Objekt

Nicht konfigurierte Git-Anmeldeinformationen.

Name Typ Beschreibung
source string:

None

Die Git-Anmeldeinformationsquelle.

UpdateGitCredentialsToAutomaticRequest

Objekt

Enthält die Anforderungsdaten, um die Git-Anmeldeinformationen automatisch zu aktualisieren.

Name Typ Beschreibung
source string:

Automatic

Die Git-Anmeldeinformationsquelle.

UpdateGitCredentialsToConfiguredConnectionRequest

Objekt

Enthält die Anforderungsdaten, um die Git-Anmeldeinformationen auf die konfigurierte Verbindung zu aktualisieren.

Name Typ Beschreibung
connectionId

string (uuid)

Die Objekt-ID der Verbindung.
source string:

ConfiguredConnection

Die Git-Anmeldeinformationsquelle.

UpdateGitCredentialsToNoneRequest

Objekt

Enthält die Anforderungsdaten zum Aktualisieren der Git-Anmeldeinformationen auf keine.

Name Typ Beschreibung
source string:

None

Die Git-Anmeldeinformationsquelle.