Git - Update My Git Credentials

Tjeneste:: Core

API-version:: v1

Opdaterer konfigurationsoplysningerne for brugerens Git-legitimationsoplysninger.
Hver bruger i arbejdsområdet har deres egne konfigurerede Git-legitimationsoplysninger. Du kan bruge API'en Get My Git Credentials til at få konfigurationen af Git-legitimationsoplysningerne.

Hvis du vil hente forbindelses-id'et, skal du se Automatiser Git-integration.

Tilladelser

Den, der ringer op, skal have en bidragyder eller en højere rolle i arbejdsområdet.

Hvis Git-legitimationsoplysningerne for konfigureret forbindelse er konfigureret, skal den, der ringer op, have tilladelse til forbindelsen.

Påkrævede delegerede områder

Workspace.ReadWrite.All

Begrænsninger

Når du bruger kilden til automatiske legitimationsoplysninger, blokeres denne API for GitHub-udbyderen og tjenesteprincipalen.

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identitet	Støtte
Bruger	Ja
tjenesteprincipal og administrerede identiteter	Understøttes kun, når kilden er ConfiguredConnection eller None

Grænseflade

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

URI-parametre

Navn	I	Påkrævet	Type	Beskrivelse
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.

Brødtekst for anmodning

Brødteksten i denne anmodning kan være en af følgende:

Navn	Beskrivelse
UpdateGitCredentialsToAutomaticRequest	Indeholder anmodningsdata om automatisk opdatering af Git-legitimationsoplysningerne.
UpdateGitCredentialsToConfiguredConnectionRequest	Indeholder anmodningsdataene om at opdatere Git-legitimationsoplysningerne til den konfigurerede forbindelse.
UpdateGitCredentialsToNoneRequest	Indeholder anmodningsdataene om at opdatere Git-legitimationsoplysningerne til ingen.

UpdateGitCredentialsToAutomaticRequest

Indeholder anmodningsdata om automatisk opdatering af Git-legitimationsoplysningerne.

Navn	Påkrævet	Type	Beskrivelse
source	True	string: Automatic	Kilden med Git-legitimationsoplysninger.

UpdateGitCredentialsToConfiguredConnectionRequest

Indeholder anmodningsdataene om at opdatere Git-legitimationsoplysningerne til den konfigurerede forbindelse.

Navn	Påkrævet	Type	Beskrivelse
connectionId	True	string (uuid)	Objekt-id'et for forbindelsen.
source	True	string: ConfiguredConnection	Kilden med Git-legitimationsoplysninger.

UpdateGitCredentialsToNoneRequest

Indeholder anmodningsdataene om at opdatere Git-legitimationsoplysningerne til ingen.

Navn	Påkrævet	Type	Beskrivelse
source	True	string: None	Kilden med Git-legitimationsoplysninger.

Svar

Navn Type Beskrivelse

200 OK

Navn	Type	Beskrivelse
200 OK	GitCredentialsConfigurationResponse: ConfiguredConnectionGitCredentialsResponse AutomaticGitCredentialsResponse NoneGitCredentialsResponse	Anmodningen blev fuldført.
429 Too Many Requests	ErrorResponse	Grænsen for tjenestetakst blev overskredet. Serveren returnerer en `Retry-After` header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger. Headere Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: UnknownError – Der opstod en fejl. InsufficientPrivileges – Kalderen har ikke tilstrækkelige tilladelser til arbejdsområdet. WorkspaceNotConnectedToGit – Arbejdsområdet har ikke forbindelse til git. ConnectionNotFound - Den angivne forbindelse blev ikke fundet. ConnectionMismatch – Forbindelsen svarer ikke til oplysningerne om Git-udbyderen. PrincipalTypeNotSupported – Opkaldsidentitetstypen understøttes ikke.

GitCredentialsConfigurationResponse:

ConfiguredConnectionGitCredentialsResponse
AutomaticGitCredentialsResponse
NoneGitCredentialsResponse

Anmodningen blev fuldført.

429 Too Many Requests

ErrorResponse

Grænsen for tjenestetakst blev overskredet. Serveren returnerer en Retry-After header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger.

Headere

Retry-After: integer

Other Status Codes

ErrorResponse

Almindelige fejlkoder:

UnknownError – Der opstod en fejl.
InsufficientPrivileges – Kalderen har ikke tilstrækkelige tilladelser til arbejdsområdet.
WorkspaceNotConnectedToGit – Arbejdsområdet har ikke forbindelse til git.
ConnectionNotFound - Den angivne forbindelse blev ikke fundet.
ConnectionMismatch – Forbindelsen svarer ikke til oplysningerne om Git-udbyderen.
PrincipalTypeNotSupported – Opkaldsidentitetstypen understøttes ikke.

Eksempler

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

Eksempelanmodning

HTTP

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

{
  "source": "Automatic"
}

Eksempelsvar

Statuskode:: 200

{
  "source": "Automatic"
}

Update user's Git credentials to ConfiguredConnection example

Eksempelanmodning

HTTP

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

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

Eksempelsvar

Statuskode:: 200

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

Update user's Git credentials to None example

Eksempelanmodning

HTTP

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

{
  "source": "None"
}

Eksempelsvar

Statuskode:: 200

{
  "source": "None"
}

Definitioner

Navn	Beskrivelse
AutomaticGitCredentialsResponse	Automatiske Git-legitimationsoplysninger.
ConfiguredConnectionGitCredentialsResponse	Git-legitimationsoplysninger for konfigureret forbindelse.
ErrorParameter	En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
GitCredentialsSource	Kilden med Git-legitimationsoplysninger. Der kan tilføjes flere Git-legitimationsoplysninger over tid.
NoneGitCredentialsResponse	Ikke konfigurerede Git-legitimationsoplysninger.
UpdateGitCredentialsToAutomaticRequest	Indeholder anmodningsdata om automatisk opdatering af Git-legitimationsoplysningerne.
UpdateGitCredentialsToConfiguredConnectionRequest	Indeholder anmodningsdataene om at opdatere Git-legitimationsoplysningerne til den konfigurerede forbindelse.
UpdateGitCredentialsToNoneRequest	Indeholder anmodningsdataene om at opdatere Git-legitimationsoplysningerne til ingen.

AutomaticGitCredentialsResponse

Objekt

Automatiske Git-legitimationsoplysninger.

Navn	Type	Beskrivelse
source	string: Automatic	Kilden med Git-legitimationsoplysninger.

ConfiguredConnectionGitCredentialsResponse

Objekt

Git-legitimationsoplysninger for konfigureret forbindelse.

Navn	Type	Beskrivelse
connectionId	string (uuid)	Objekt-id'et for forbindelsen.
source	string: ConfiguredConnection	Kilden med Git-legitimationsoplysninger.

ErrorParameter

Objekt

En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.

Navn	Type	Beskrivelse
message	string	En læsevenlig beskrivelse af parameterens betydning.
name	string	Parameter-id'et.
value	string	Parameterens værdi.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Navn	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Navn	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
isRetriable	boolean	Når sand, kan anmodningen prøves igen. Brug svarheaderen `Retry-After` til at bestemme forsinkelsen, hvis den er tilgængelig.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
parameters	ErrorParameter[]	Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Navn	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
parameters	ErrorParameter[]	Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

GitCredentialsSource

Optælling

Kilden med Git-legitimationsoplysninger. Der kan tilføjes flere Git-legitimationsoplysninger over tid.

Værdi	Beskrivelse
ConfiguredConnection	Git-legitimationsoplysningerne hentes via en konfigureret forbindelse.
Automatic	Git-legitimationsoplysningerne hentes automatisk af systemet ved hjælp af standardlegitimationsoplysninger, hvis de er tilgængelige.
None	Git-legitimationsoplysningerne er ikke konfigureret.

NoneGitCredentialsResponse

Objekt

Ikke konfigurerede Git-legitimationsoplysninger.

Navn	Type	Beskrivelse
source	string: None	Kilden med Git-legitimationsoplysninger.

UpdateGitCredentialsToAutomaticRequest

Objekt

Indeholder anmodningsdata om automatisk opdatering af Git-legitimationsoplysningerne.

Navn	Type	Beskrivelse
source	string: Automatic	Kilden med Git-legitimationsoplysninger.

UpdateGitCredentialsToConfiguredConnectionRequest

Objekt

Indeholder anmodningsdataene om at opdatere Git-legitimationsoplysningerne til den konfigurerede forbindelse.

Navn	Type	Beskrivelse
connectionId	string (uuid)	Objekt-id'et for forbindelsen.
source	string: ConfiguredConnection	Kilden med Git-legitimationsoplysninger.

UpdateGitCredentialsToNoneRequest

Objekt

Indeholder anmodningsdataene om at opdatere Git-legitimationsoplysningerne til ingen.

Navn	Type	Beskrivelse
source	string: None	Kilden med Git-legitimationsoplysninger.