Git - Update Connection Settings

Service:
Core
Versione API:
v1

Note

Questa API fa parte di una versione di anteprima e viene fornita solo a scopo di valutazione e sviluppo. Può cambiare in base al feedback e non è consigliato per l'uso in produzione. Scopri di più.

Aggiorna le impostazioni di connessione per un'area di lavoro connessa a Git. Vengono aggiornate solo le proprietà incluse nel corpo della richiesta; le proprietà omesse rimangono invariate.

Permissions

Il chiamante deve avere un ruolo di amministratore per l'area di lavoro.

Ambiti delegati obbligatori

Workspace.ReadWrite.All

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identità Support
User Yes
Principale del servizio e Identità gestite Yes

Interfaccia

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
workspaceId
 path True

string (uuid)

L’ID dell’area di lavoro.

Corpo della richiesta

Nome Tipo Descrizione
additionalRolesAuthorizedToChangeBranch

GitAdditionalBranchChangingRoles

Ruoli dell'area di lavoro aggiuntivi oltre all'amministratore che possono modificare il ramo Git connesso.

Risposte

Nome Tipo Descrizione
200 OK

GitConnectionSettings

Richiesta completata correttamente.
429 Too Many Requests

ErrorResponse

È stato superato il limite di velocità del servizio. Il server restituisce un'intestazione Retry-After che indica, in secondi, per quanto tempo il client deve attendere prima di inviare richieste aggiuntive.

Intestazioni

Retry-After: integer
Other Status Codes

ErrorResponse

Codici di errore comuni:

  • UnknownError: si è verificato un errore.

  • InsufficientPrivileges: il chiamante non ha un ruolo di amministratore per l'area di lavoro.

  • WorkspaceNotConnectedToGit: l'area di lavoro non è connessa a Git.

Esempio

Update connection settings example

Esempio di richiesta

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

{
  "additionalRolesAuthorizedToChangeBranch": "MemberAndContributor"
}

Risposta di esempio

Codice di stato:
200 
{
  "additionalRolesAuthorizedToChangeBranch": "MemberAndContributor"
}

Definizioni

Nome Descrizione
ErrorParameter

Parametro strutturato che fornisce un contesto aggiuntivo leggibile dal computer relativo a un errore.
ErrorRelatedResource

Oggetto dei dettagli della risorsa relativo all'errore.
ErrorResponse

Risposta di errore.
ErrorResponseDetails

Dettagli della risposta di errore.
GitAdditionalBranchChangingRoles

Ruoli dell'area di lavoro aggiuntivi oltre all'amministratore che possono modificare il ramo Git connesso. È possibile aggiungere valori aggiuntivi nel tempo.
GitConnectionSettings

Contiene le impostazioni di connessione Git.
UpdateGitConnectionSettingsRequest

Contiene i dati della richiesta per aggiornare le impostazioni di connessione Git.

ErrorParameter

Oggetto

Parametro strutturato che fornisce un contesto aggiuntivo leggibile dal computer relativo a un errore.

Nome Tipo Descrizione
message

string

Descrizione leggibile del significato del parametro.
name

string

L'identificatore dei parametri.
value

string

Valore del parametro.

ErrorRelatedResource

Oggetto

Oggetto dei dettagli della risorsa relativo all'errore.

Nome Tipo Descrizione
resourceId

string

ID risorsa coinvolto nell'errore.
resourceType

string

Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Oggetto

Risposta di errore.

Nome Tipo Descrizione
errorCode

string

Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
isRetriable

boolean

Se true, la richiesta può essere ritentata. Usare l'intestazione della Retry-After risposta per determinare il ritardo, se disponibile.
message

string

Rappresentazione leggibile dell'errore.
moreDetails

ErrorResponseDetails[]

Elenco di dettagli aggiuntivi sull'errore.
parameters

ErrorParameter[]

Parametri strutturati che forniscono un contesto aggiuntivo leggibile dal computer sull'errore.
relatedResource

ErrorRelatedResource

Dettagli della risorsa correlati all'errore.
requestId

string (uuid)

ID della richiesta associata all'errore.

ErrorResponseDetails

Oggetto

Dettagli della risposta di errore.

Nome Tipo Descrizione
errorCode

string

Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message

string

Rappresentazione leggibile dell'errore.
parameters

ErrorParameter[]

Parametri strutturati che forniscono un contesto aggiuntivo leggibile dal computer sull'errore.
relatedResource

ErrorRelatedResource

Dettagli della risorsa correlati all'errore.

GitAdditionalBranchChangingRoles

Enumerazione

Ruoli dell'area di lavoro aggiuntivi oltre all'amministratore che possono modificare il ramo Git connesso. È possibile aggiungere valori aggiuntivi nel tempo.

Valore Descrizione
None

Nessun ruolo aggiuntivo oltre l'amministratore può modificare i rami. Si tratta dell'impostazione predefinita.
MemberAndContributor

I membri e i collaboratori possono anche modificare rami oltre agli amministratori.

GitConnectionSettings

Oggetto

Contiene le impostazioni di connessione Git.

Nome Tipo Descrizione
additionalRolesAuthorizedToChangeBranch

GitAdditionalBranchChangingRoles

Ruoli dell'area di lavoro aggiuntivi oltre all'amministratore che possono modificare il ramo Git connesso.

UpdateGitConnectionSettingsRequest

Oggetto

Contiene i dati della richiesta per aggiornare le impostazioni di connessione Git.

Nome Tipo Descrizione
additionalRolesAuthorizedToChangeBranch

GitAdditionalBranchChangingRoles

Ruoli dell'area di lavoro aggiuntivi oltre all'amministratore che possono modificare il ramo Git connesso.