Git - Get Connection Settings

Tjeneste:: Core

API-version:: v1

Henter forbindelsesindstillingerne for et Git-forbundet arbejdsområde.

Note

Denne API er en del af en prøveversion og leveres kun til evaluerings- og udviklingsformål. Det kan ændre sig baseret på feedback og anbefales ikke til produktionsbrug. Få mere at vide.

Returnerer forbindelsesindstillingerne for et Git-forbundet arbejdsområde.

Tilladelser

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

Påkrævede delegerede områder

Workspace.Read.All eller Workspace.ReadWrite.All

Microsoft Entra understøttede identiteter

Denne API understøtter de Microsoft identities, der er angivet i dette afsnit.

Identity	Support
User	Ja
tjenesteprincipal og administrerede identiteter	Ja

Brugerflade

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

URI-parametre

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

Svar

Navn Type Beskrivelse

200 OK

Navn	Type	Beskrivelse
200 OK	GitConnectionSettings	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 – Den kaldende bruger har ikke tilstrækkelige tilladelser til arbejdsområdet. WorkspaceNotConnectedToGit – Arbejdsområdet har ikke forbindelse til git.

GitConnectionSettings

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 – Den kaldende bruger har ikke tilstrækkelige tilladelser til arbejdsområdet.
WorkspaceNotConnectedToGit – Arbejdsområdet har ikke forbindelse til git.

Eksempler

Get connection settings example

Eksempelanmodning

HTTP

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

Eksempelsvar

Statuskode:: 200

{
  "additionalRolesAuthorizedToChangeBranch": "None"
}

Definitioner

Navn	Beskrivelse
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.
GitAdditionalBranchChangingRoles	De ekstra arbejdsområderoller ud over administrator, der har tilladelse til at ændre den forbundne Git-forgrening. Der kan tilføjes flere værdier over tid.
GitConnectionSettings	Indeholder indstillingerne for Git-forbindelse.

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.

GitAdditionalBranchChangingRoles

Optælling

De ekstra arbejdsområderoller ud over administrator, der har tilladelse til at ændre den forbundne Git-forgrening. Der kan tilføjes flere værdier over tid.

Værdi	Beskrivelse
None	Ingen yderligere roller ud over administratoren kan ændre forgreninger. Dette er standarden.
MemberAndContributor	Medlemmer og bidragydere kan også ændre forgreninger ud over administratorer.

GitConnectionSettings

Objekt

Indeholder indstillingerne for Git-forbindelse.

Navn	Type	Beskrivelse
additionalRolesAuthorizedToChangeBranch	GitAdditionalBranchChangingRoles	De ekstra arbejdsområderoller ud over administrator, der har tilladelse til at ændre den forbundne Git-forgrening.