Udostępnij przez

Git - Update My Git Credentials

Usługa:
Core
Wersja interfejsu API:
v1

Aktualizuje szczegóły konfiguracji poświadczeń usługi Git użytkownika.
Każdy użytkownik w obszarze roboczym ma własne skonfigurowane poświadczenia usługi Git. Aby uzyskać konfigurację poświadczeń usługi Git, możesz użyć interfejsu API Uzyskiwanie poświadczeń usługi Git .

Aby uzyskać identyfikator połączenia, zobacz Automatyzowanie integracji z usługą Git.

Uprawnienia

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

W przypadku skonfigurowanych poświadczeń usługi Git połączenia obiekt wywołujący musi mieć uprawnienia do połączenia.

Wymagane zakresy delegowane

Przestrzeń robocza.OdczytZapis.Wszystko

Ograniczenia

W przypadku korzystania ze źródła poświadczeń automatycznych ten interfejs API jest blokowany dla dostawcy usługi GitHub i jednostki usługi.

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 Obsługiwane tylko wtedy, gdy źródło ma wartość ConfiguredConnection lub None

Interfejs

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
workspaceId
 path True

string (uuid)

Identyfikator obszaru roboczego.

Treść żądania

Treść żądania może być jedną z następujących:

Nazwa Opis
UpdateGitCredentialsToAutomaticRequest

Zawiera dane żądania w celu zaktualizowania poświadczeń usługi Git do automatycznego.
UpdateGitCredentialsToConfiguredConnectionRequest

Zawiera dane żądania w celu zaktualizowania poświadczeń usługi Git w celu skonfigurowania połączenia.
UpdateGitCredentialsToNoneRequest

Zawiera dane żądania w celu zaktualizowania poświadczeń usługi Git do żadnego.

UpdateGitCredentialsToAutomaticRequest

Zawiera dane żądania w celu zaktualizowania poświadczeń usługi Git do automatycznego.

Nazwa Wymagane Typ Opis
source True string:

Automatic

Źródło poświadczeń usługi Git.

UpdateGitCredentialsToConfiguredConnectionRequest

Zawiera dane żądania w celu zaktualizowania poświadczeń usługi Git w celu skonfigurowania połączenia.

Nazwa Wymagane Typ Opis
connectionId True

string (uuid)

Identyfikator obiektu połączenia.
source True string:

ConfiguredConnection

Źródło poświadczeń usługi Git.

UpdateGitCredentialsToNoneRequest

Zawiera dane żądania w celu zaktualizowania poświadczeń usługi Git do żadnego.

Nazwa Wymagane Typ Opis
source True string:

None

Źródło poświadczeń usługi Git.

Odpowiedzi

Nazwa Typ Opis
200 OK GitCredentialsConfigurationResponse:

Żą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 ma niewystarczające uprawnienia obszaru roboczego.

  • WorkspaceNotConnectedToGit — obszar roboczy nie jest połączony z usługą git.

  • ConnectionNotFound — nie można odnaleźć określonego połączenia.

  • ConnectionMismatch — połączenie nie jest zgodne ze szczegółami dostawcy Git.

  • PrincipalTypeNotSupported — typ tożsamości obiektu wywołującego nie jest obsługiwany.

Przykłady

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

Przykładowe żądanie

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

{
  "source": "Automatic"
}

Przykładowa odpowiedź

Kod stanu:
200 
{
  "source": "Automatic"
}

Update user's Git credentials to ConfiguredConnection example

Przykładowe żądanie

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

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

Przykładowa odpowiedź

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

Update user's Git credentials to None example

Przykładowe żądanie

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

{
  "source": "None"
}

Przykładowa odpowiedź

Kod stanu:
200 
{
  "source": "None"
}

Definicje

Nazwa Opis
AutomaticGitCredentialsResponse

Automatyczne poświadczenia usługi Git.
ConfiguredConnectionGitCredentialsResponse

Skonfigurowano poświadczenia usługi Git połączenia.
ErrorRelatedResource

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

Odpowiedź na błąd.
ErrorResponseDetails

Szczegóły odpowiedzi na błąd.
GitCredentialsSource

Źródło poświadczeń usługi Git. Dodatkowe źródła poświadczeń usługi Git można dodawać z upływem czasu.
NoneGitCredentialsResponse

Nie skonfigurowano poświadczeń usługi Git.
UpdateGitCredentialsToAutomaticRequest

Zawiera dane żądania w celu zaktualizowania poświadczeń usługi Git do automatycznego.
UpdateGitCredentialsToConfiguredConnectionRequest

Zawiera dane żądania w celu zaktualizowania poświadczeń usługi Git w celu skonfigurowania połączenia.
UpdateGitCredentialsToNoneRequest

Zawiera dane żądania w celu zaktualizowania poświadczeń usługi Git do żadnego.

AutomaticGitCredentialsResponse

Objekt

Automatyczne poświadczenia usługi Git.

Nazwa Typ Opis
source string:

Automatic

Źródło poświadczeń usługi Git.

ConfiguredConnectionGitCredentialsResponse

Objekt

Skonfigurowano poświadczenia usługi Git połączenia.

Nazwa Typ Opis
connectionId

string (uuid)

Identyfikator obiektu połączenia.
source string:

ConfiguredConnection

Źródło poświadczeń usługi Git.

ErrorRelatedResource

Objekt

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

Objekt

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

Objekt

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.

GitCredentialsSource

Wyliczanie

Źródło poświadczeń usługi Git. Dodatkowe źródła poświadczeń usługi Git można dodawać z upływem czasu.

Wartość Opis
ConfiguredConnection

Poświadczenia usługi Git są uzyskiwane za pośrednictwem skonfigurowanego połączenia.
Automatic

Poświadczenia usługi Git są automatycznie uzyskiwane przez system przy użyciu poświadczeń domyślnych, jeśli są dostępne.
None

Poświadczenia usługi Git nie są skonfigurowane.

NoneGitCredentialsResponse

Objekt

Nie skonfigurowano poświadczeń usługi Git.

Nazwa Typ Opis
source string:

None

Źródło poświadczeń usługi Git.

UpdateGitCredentialsToAutomaticRequest

Objekt

Zawiera dane żądania w celu zaktualizowania poświadczeń usługi Git do automatycznego.

Nazwa Typ Opis
source string:

Automatic

Źródło poświadczeń usługi Git.

UpdateGitCredentialsToConfiguredConnectionRequest

Objekt

Zawiera dane żądania w celu zaktualizowania poświadczeń usługi Git w celu skonfigurowania połączenia.

Nazwa Typ Opis
connectionId

string (uuid)

Identyfikator obiektu połączenia.
source string:

ConfiguredConnection

Źródło poświadczeń usługi Git.

UpdateGitCredentialsToNoneRequest

Objekt

Zawiera dane żądania w celu zaktualizowania poświadczeń usługi Git do żadnego.

Nazwa Typ Opis
source string:

None

Źródło poświadczeń usługi Git.