Git - Update Connection Settings

Service:: Core

Version d’API:: v1

Note

Cette API fait partie d’une préversion et est fournie uniquement à des fins d’évaluation et de développement. Il peut changer en fonction des commentaires et n’est pas recommandé pour une utilisation en production. En savoir plus.

Met à jour les paramètres de connexion d’un espace de travail connecté à Git. Seules les propriétés incluses dans le corps de la requête sont mises à jour ; Les propriétés omises restent inchangées.

Permissions

L’appelant doit avoir un rôle d’administrateur pour l’espace de travail.

Étendues déléguées requises

Workspace.ReadWrite.All

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identity	Support
Utilisateur	Yes
Service principal et identités gérées	Yes

Interface

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
workspaceId	path	True	string (uuid)	Identifiant de l’espace de travail.

Corps de la demande

Nom	Type	Description
additionalRolesAuthorizedToChangeBranch	GitAdditionalBranchChangingRoles	Les rôles d’espace de travail supplémentaires au-delà de l’administrateur autorisés à modifier la branche Git connectée.

Réponses

Nom Type Description

200 OK

Nom	Type	Description
200 OK	GitConnectionSettings	La demande s’est terminée avec succès.
429 Too Many Requests	ErrorResponse	La limite de débit de service a été dépassée. Le serveur retourne un `Retry-After` en-tête indiquant, en secondes, combien de temps le client doit attendre avant d’envoyer des demandes supplémentaires. En-têtes Retry-After: integer
Other Status Codes	ErrorResponse	Codes d’erreur courants : UnknownError : une erreur s’est produite. InsufficientPrivileges : l’appelant n’a pas de rôle d’administrateur pour l’espace de travail. WorkspaceNotConnectedToGit : l’espace de travail n’est pas connecté à Git.

GitConnectionSettings

La demande s’est terminée avec succès.

429 Too Many Requests

ErrorResponse

La limite de débit de service a été dépassée. Le serveur retourne un Retry-After en-tête indiquant, en secondes, combien de temps le client doit attendre avant d’envoyer des demandes supplémentaires.

En-têtes

Retry-After: integer

Other Status Codes

ErrorResponse

Codes d’erreur courants :

UnknownError : une erreur s’est produite.
InsufficientPrivileges : l’appelant n’a pas de rôle d’administrateur pour l’espace de travail.
WorkspaceNotConnectedToGit : l’espace de travail n’est pas connecté à Git.

Exemples

Update connection settings example

Exemple de requête

HTTP

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

{
  "additionalRolesAuthorizedToChangeBranch": "MemberAndContributor"
}

Exemple de réponse

Code d’état:: 200

{
  "additionalRolesAuthorizedToChangeBranch": "MemberAndContributor"
}

Définitions

Nom	Description
ErrorParameter	Paramètre structuré fournissant un contexte lisible par l’ordinateur supplémentaire à propos d’une erreur.
ErrorRelatedResource	Objet de détails de ressource associé à l’erreur.
ErrorResponse	Réponse d’erreur.
ErrorResponseDetails	Détails de la réponse d’erreur.
GitAdditionalBranchChangingRoles	Les rôles d’espace de travail supplémentaires au-delà de l’administrateur autorisés à modifier la branche Git connectée. Des valeurs supplémentaires peuvent être ajoutées au fil du temps.
GitConnectionSettings	Contient les paramètres de connexion Git.
UpdateGitConnectionSettingsRequest	Contient les données de requête pour mettre à jour les paramètres de connexion Git.

ErrorParameter

Objet

Paramètre structuré fournissant un contexte lisible par l’ordinateur supplémentaire à propos d’une erreur.

Nom	Type	Description
message	string	Description lisible par l’homme de la signification du paramètre.
name	string	L’identifiant de paramètre.
value	string	Représente la valeur du paramètre.

ErrorRelatedResource

Objet

Objet de détails de ressource associé à l’erreur.

Nom	Type	Description
resourceId	string	ID de ressource impliqué dans l’erreur.
resourceType	string	Type de la ressource impliquée dans l’erreur.

ErrorResponse

Objet

Réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
isRetriable	boolean	Lorsque la valeur est true, la requête peut être retentée. Utilisez l’en-tête `Retry-After` de réponse pour déterminer le délai, le cas échéant.
message	string	Représentation lisible humaine de l’erreur.
moreDetails	ErrorResponseDetails[]	Liste des détails d’erreur supplémentaires.
parameters	ErrorParameter[]	Paramètres structurés fournissant un contexte lisible par l’ordinateur supplémentaire sur l’erreur.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.
requestId	string (uuid)	ID de la demande associée à l’erreur.

ErrorResponseDetails

Objet

Détails de la réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
parameters	ErrorParameter[]	Paramètres structurés fournissant un contexte lisible par l’ordinateur supplémentaire sur l’erreur.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.

GitAdditionalBranchChangingRoles

Énumération

Les rôles d’espace de travail supplémentaires au-delà de l’administrateur autorisés à modifier la branche Git connectée. Des valeurs supplémentaires peuvent être ajoutées au fil du temps.

Valeur	Description
None	Aucun rôle supplémentaire au-delà de l’administrateur ne peut modifier les branches. Il s’agit de la valeur par défaut.
MemberAndContributor	Les membres et les contributeurs peuvent également modifier les branches en plus des administrateurs.

GitConnectionSettings

Objet

Contient les paramètres de connexion Git.

Nom	Type	Description
additionalRolesAuthorizedToChangeBranch	GitAdditionalBranchChangingRoles	Les rôles d’espace de travail supplémentaires au-delà de l’administrateur autorisés à modifier la branche Git connectée.

UpdateGitConnectionSettingsRequest

Objet

Contient les données de requête pour mettre à jour les paramètres de connexion Git.

Nom	Type	Description
additionalRolesAuthorizedToChangeBranch	GitAdditionalBranchChangingRoles	Les rôles d’espace de travail supplémentaires au-delà de l’administrateur autorisés à modifier la branche Git connectée.