Git - Update Connection Settings

Tjänst:: Core

API-version:: v1

Note

Det här API:et är en del av en förhandsversion och tillhandahålls endast i utvärderings- och utvecklingssyfte. Den kan ändras baserat på feedback och rekommenderas inte för produktionsanvändning. Läs mer.

Uppdaterar anslutningsinställningarna för en Git-ansluten arbetsyta. Endast egenskaper som ingår i begärandetexten uppdateras. utelämnade egenskaper förblir oförändrade.

Permissions

Anroparen måste ha en administratörsroll för arbetsytan.

Obligatoriska delegerade omfång

Workspace.ReadWrite.All

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identity	Support
User	Yes
Tjänsthuvudnamn och hanterade identiteter	Yes

Interface

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
workspaceId	path	True	string (uuid)	Arbetsyte-ID.

Begärandetext

Name	Typ	Description
additionalRolesAuthorizedToChangeBranch	GitAdditionalBranchChangingRoles	De ytterligare arbetsyteroller utöver administratören som tillåts ändra den anslutna Git-grenen.

Svar

Name Typ Description

200 OK

Name	Typ	Description
200 OK	GitConnectionSettings	Begäran har slutförts.
429 Too Many Requests	ErrorResponse	Gränsen för tjänstfrekvens överskreds. Servern returnerar ett `Retry-After` huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas. Sidhuvuden Retry-After: integer
Other Status Codes	ErrorResponse	Vanliga felkoder: UnknownError – Ett fel uppstod. InsufficientPrivileges – anroparen har ingen administratörsroll för arbetsytan. ArbetsytaNotConnectedToGit – Arbetsytan är inte ansluten till git.

GitConnectionSettings

Begäran har slutförts.

429 Too Many Requests

ErrorResponse

Gränsen för tjänstfrekvens överskreds. Servern returnerar ett Retry-After huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas.

Sidhuvuden

Retry-After: integer

Other Status Codes

ErrorResponse

Vanliga felkoder:

UnknownError – Ett fel uppstod.
InsufficientPrivileges – anroparen har ingen administratörsroll för arbetsytan.
ArbetsytaNotConnectedToGit – Arbetsytan är inte ansluten till git.

Exempel

Update connection settings example

Exempelbegäran

HTTP

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

{
  "additionalRolesAuthorizedToChangeBranch": "MemberAndContributor"
}

Exempelsvar

Statuskod:: 200

{
  "additionalRolesAuthorizedToChangeBranch": "MemberAndContributor"
}

Definitioner

Name	Description
ErrorParameter	En strukturerad parameter som ger ytterligare datorläsbar kontext om ett fel.
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Detaljer om felsvaret.
GitAdditionalBranchChangingRoles	De ytterligare arbetsyteroller utöver administratören som tillåts ändra den anslutna Git-grenen. Ytterligare värden kan läggas till över tid.
GitConnectionSettings	Innehåller inställningarna för Git-anslutning.
UpdateGitConnectionSettingsRequest	Innehåller begärandedata för att uppdatera Git-anslutningsinställningarna.

ErrorParameter

Objekt

En strukturerad parameter som ger ytterligare datorläsbar kontext om ett fel.

Name	Typ	Description
message	string	En beskrivning av parameterns betydelse som kan läsas av människor.
name	string	Parameteridentifieraren.
value	string	Parametervärdet.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name	Typ	Description
resourceId	string	Resurs-ID:t som är inblandat i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
isRetriable	boolean	När det är sant kan begäran göras på nytt. Använd svarshuvudet `Retry-After` för att fastställa fördröjningen, om den är tillgänglig.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
parameters	ErrorParameter[]	Strukturerade parametrar som ger ytterligare datorläsbar kontext om felet.
relatedResource	ErrorRelatedResource	Detaljer om resursen relaterad till felet.
requestId	string (uuid)	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Detaljer om felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
parameters	ErrorParameter[]	Strukturerade parametrar som ger ytterligare datorläsbar kontext om felet.
relatedResource	ErrorRelatedResource	Detaljer om resursen relaterad till felet.

GitAdditionalBranchChangingRoles

Uppräkning

De ytterligare arbetsyteroller utöver administratören som tillåts ändra den anslutna Git-grenen. Ytterligare värden kan läggas till över tid.

Värde	Description
None	Inga ytterligare roller utöver administratören kan ändra grenar. Det här är standardinställningen.
MemberAndContributor	Medlemmar och deltagare kan också ändra grenar utöver administratörer.

GitConnectionSettings

Objekt

Innehåller inställningarna för Git-anslutning.

Name	Typ	Description
additionalRolesAuthorizedToChangeBranch	GitAdditionalBranchChangingRoles	De ytterligare arbetsyteroller utöver administratören som tillåts ändra den anslutna Git-grenen.

UpdateGitConnectionSettingsRequest

Objekt

Innehåller begärandedata för att uppdatera Git-anslutningsinställningarna.

Name	Typ	Description
additionalRolesAuthorizedToChangeBranch	GitAdditionalBranchChangingRoles	De ytterligare arbetsyteroller utöver administratören som tillåts ändra den anslutna Git-grenen.