Git - Update My Git Credentials

Service:: Core

API-versie:: v1

Hiermee werkt u de configuratiegegevens van de Git-referenties van de gebruiker bij.
Elke gebruiker in de werkruimte heeft zijn eigen geconfigureerde Git-referenties. U kunt de API Mijn Git-referenties ophalen gebruiken om de configuratie van Git-referenties op te halen.

Zie Git-integratie automatiseren om de verbindings-id op te halen.

Machtigingen

De aanroeper moet een inzender hebben of een hogere werkruimterol.

Voor geconfigureerde Git-referenties voor de verbinding moet de aanroeper gemachtigd zijn voor de verbinding.

Vereiste gedelegeerde bereiken

Workspace.ReadWrite.All

Beperkingen

Wanneer u de bron voor automatische referenties gebruikt, wordt deze API geblokkeerd voor de GitHub-provider en voor de service-principal.

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft -identiteiten vermeld in deze sectie.

Identiteit	Ondersteuning
Gebruiker	Ja
serviceprincipal en beheerde identiteiten	Alleen ondersteund wanneer bron is GeconfigureerdConnection of Geen

gebruikersinterface

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

URI-parameters

Naam	In	Vereist	Type	Description
workspaceId	path	True	string (uuid)	De werkruimte-id.

Aanvraagbody

De aanvraagtekst kan een van de volgende zijn:

Naam	Description
UpdateGitCredentialsToAutomaticRequest	Bevat de aanvraaggegevens om de Git-referenties automatisch bij te werken.
UpdateGitCredentialsToConfiguredConnectionRequest	Bevat de aanvraaggegevens voor het bijwerken van de Git-referenties voor de geconfigureerde verbinding.
UpdateGitCredentialsToNoneRequest	Bevat de aanvraaggegevens voor het bijwerken van de Git-referenties naar geen.

UpdateGitCredentialsToAutomaticRequest

Bevat de aanvraaggegevens om de Git-referenties automatisch bij te werken.

Naam	Vereist	Type	Description
source	True	string: Automatic	De Git-referentiebron.

UpdateGitCredentialsToConfiguredConnectionRequest

Bevat de aanvraaggegevens voor het bijwerken van de Git-referenties voor de geconfigureerde verbinding.

Naam	Vereist	Type	Description
connectionId	True	string (uuid)	De object-id van de verbinding.
source	True	string: ConfiguredConnection	De Git-referentiebron.

UpdateGitCredentialsToNoneRequest

Bevat de aanvraaggegevens voor het bijwerken van de Git-referenties naar geen.

Naam	Vereist	Type	Description
source	True	string: None	De Git-referentiebron.

Antwoorden

Naam Type Description

200 OK

Naam	Type	Description
200 OK	GitCredentialsConfigurationResponse: ConfiguredConnectionGitCredentialsResponse AutomaticGitCredentialsResponse NoneGitCredentialsResponse	De aanvraag is voltooid.
429 Too Many Requests	ErrorResponse	De servicesnelheidslimiet is overschreden. De server retourneert een `Retry-After` header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden. Kopteksten Retry-After: integer
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: UnknownError: er is een fout opgetreden. InsufficientPrivileges - Aanroeper heeft onvoldoende werkruimtemachtigingen. WorkspaceNotConnectedToGit - Werkruimte is niet verbonden met Git. ConnectionNotFound: de opgegeven verbinding is niet gevonden. ConnectionMismatch: de verbinding komt niet overeen met de details van de Git-provider. PrincipalTypeNotSupported - Identiteitstype beller wordt niet ondersteund.

GitCredentialsConfigurationResponse:

ConfiguredConnectionGitCredentialsResponse
AutomaticGitCredentialsResponse
NoneGitCredentialsResponse

De aanvraag is voltooid.

429 Too Many Requests

ErrorResponse

De servicesnelheidslimiet is overschreden. De server retourneert een Retry-After header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden.

Kopteksten

Retry-After: integer

Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

UnknownError: er is een fout opgetreden.
InsufficientPrivileges - Aanroeper heeft onvoldoende werkruimtemachtigingen.
WorkspaceNotConnectedToGit - Werkruimte is niet verbonden met Git.
ConnectionNotFound: de opgegeven verbinding is niet gevonden.
ConnectionMismatch: de verbinding komt niet overeen met de details van de Git-provider.
PrincipalTypeNotSupported - Identiteitstype beller wordt niet ondersteund.

Voorbeelden

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

Voorbeeldaanvraag

HTTP

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

{
  "source": "Automatic"
}

Voorbeeldrespons

Statuscode:: 200

{
  "source": "Automatic"
}

Update user's Git credentials to ConfiguredConnection example

Voorbeeldaanvraag

HTTP

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

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

Voorbeeldrespons

Statuscode:: 200

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

Update user's Git credentials to None example

Voorbeeldaanvraag

HTTP

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

{
  "source": "None"
}

Voorbeeldrespons

Statuscode:: 200

{
  "source": "None"
}

Definities

Naam	Description
AutomaticGitCredentialsResponse	Automatische Git-referenties.
ConfiguredConnectionGitCredentialsResponse	Geconfigureerde Git-referenties voor verbinding.
ErrorParameter	Een gestructureerde parameter die extra machineleesbare context biedt over een fout.
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	Het foutbericht.
ErrorResponseDetails	De details van het foutbericht.
GitCredentialsSource	De Git-referentiebron. Er kunnen na verloop van tijd extra Git-referentiesbronnen worden toegevoegd.
NoneGitCredentialsResponse	Niet geconfigureerde Git-referenties.
UpdateGitCredentialsToAutomaticRequest	Bevat de aanvraaggegevens om de Git-referenties automatisch bij te werken.
UpdateGitCredentialsToConfiguredConnectionRequest	Bevat de aanvraaggegevens voor het bijwerken van de Git-referenties voor de geconfigureerde verbinding.
UpdateGitCredentialsToNoneRequest	Bevat de aanvraaggegevens voor het bijwerken van de Git-referenties naar geen.

AutomaticGitCredentialsResponse

Object

Automatische Git-referenties.

Naam	Type	Description
source	string: Automatic	De Git-referentiebron.

ConfiguredConnectionGitCredentialsResponse

Object

Geconfigureerde Git-referenties voor verbinding.

Naam	Type	Description
connectionId	string (uuid)	De object-id van de verbinding.
source	string: ConfiguredConnection	De Git-referentiebron.

ErrorParameter

Object

Een gestructureerde parameter die extra machineleesbare context biedt over een fout.

Naam	Type	Description
message	string	Een door mensen leesbare beschrijving van de betekenis van de parameter.
name	string	De parameter-id.
value	string	De waarde van de parameter.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Naam	Type	Description
resourceId	string	De resource-id die betrokken is bij de fout.
resourceType	string	Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Naam	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
isRetriable	boolean	Wanneer waar, kan de aanvraag opnieuw worden geprobeerd. Gebruik de `Retry-After` antwoordheader om de vertraging te bepalen, indien beschikbaar.
message	string	Een leesbare weergave van de fout.
moreDetails	ErrorResponseDetails[]	Lijst met aanvullende foutdetails.
parameters	ErrorParameter[]	Gestructureerde parameters die extra machineleesbare context bieden over de fout.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.
requestId	string (uuid)	Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Naam	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
parameters	ErrorParameter[]	Gestructureerde parameters die extra machineleesbare context bieden over de fout.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.

GitCredentialsSource

Opsomming

De Git-referentiebron. Er kunnen na verloop van tijd extra Git-referentiesbronnen worden toegevoegd.

Waarde	Description
ConfiguredConnection	De Git-referenties worden verkregen via een geconfigureerde verbinding.
Automatic	De Git-referenties worden automatisch door het systeem verkregen met behulp van standaardreferenties, indien beschikbaar.
None	De Git-referenties zijn niet geconfigureerd.

NoneGitCredentialsResponse

Object

Niet geconfigureerde Git-referenties.

Naam	Type	Description
source	string: None	De Git-referentiebron.

UpdateGitCredentialsToAutomaticRequest

Object

Bevat de aanvraaggegevens om de Git-referenties automatisch bij te werken.

Naam	Type	Description
source	string: Automatic	De Git-referentiebron.

UpdateGitCredentialsToConfiguredConnectionRequest

Object

Bevat de aanvraaggegevens voor het bijwerken van de Git-referenties voor de geconfigureerde verbinding.

Naam	Type	Description
connectionId	string (uuid)	De object-id van de verbinding.
source	string: ConfiguredConnection	De Git-referentiebron.

UpdateGitCredentialsToNoneRequest

Object

Bevat de aanvraaggegevens voor het bijwerken van de Git-referenties naar geen.

Naam	Type	Description
source	string: None	De Git-referentiebron.