Git - Update Connection Settings

Servicio:: Core

Versión de la API:: v1

Note

Esta API forma parte de una versión preliminar y solo se proporciona con fines de evaluación y desarrollo. Puede cambiar en función de los comentarios y no se recomienda para su uso en producción. Obtenga más información.

Actualiza la configuración de conexión de un área de trabajo conectada a Git. Solo se actualizan las propiedades incluidas en el cuerpo de la solicitud; Las propiedades omitidas permanecen sin cambios.

Permissions

El autor de la llamada debe tener un rol de administrador para el área de trabajo.

Ámbitos delegados necesarios

Workspace.ReadWrite.All

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

Identity	Support
Usuario	Yes
Entidad de servicio e Identidades administradas	Yes

Interface

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
workspaceId	path	True	string (uuid)	El identificador del área de trabajo.

Cuerpo de la solicitud

Nombre	Tipo	Description
additionalRolesAuthorizedToChangeBranch	GitAdditionalBranchChangingRoles	Los roles de área de trabajo adicionales más allá del administrador que pueden cambiar la rama de Git conectada.

Respuestas

Nombre Tipo Description

200 OK

Nombre	Tipo	Description
200 OK	GitConnectionSettings	Solicitud completada correctamente.
429 Too Many Requests	ErrorResponse	Se superó el límite de frecuencia de servicio. El servidor devuelve un `Retry-After` encabezado que indica, en segundos, cuánto tiempo debe esperar el cliente antes de enviar solicitudes adicionales. Encabezados Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de error comunes: UnknownError: se produjo un error. InsufficientPrivileges: el autor de la llamada no tiene un rol de administrador para el área de trabajo. WorkspaceNotConnectedToGit: el área de trabajo no está conectada a Git.

GitConnectionSettings

Solicitud completada correctamente.

429 Too Many Requests

ErrorResponse

Se superó el límite de frecuencia de servicio. El servidor devuelve un Retry-After encabezado que indica, en segundos, cuánto tiempo debe esperar el cliente antes de enviar solicitudes adicionales.

Encabezados

Retry-After: integer

Other Status Codes

ErrorResponse

Códigos de error comunes:

UnknownError: se produjo un error.
InsufficientPrivileges: el autor de la llamada no tiene un rol de administrador para el área de trabajo.
WorkspaceNotConnectedToGit: el área de trabajo no está conectada a Git.

Ejemplos

Update connection settings example

Solicitud de ejemplo

HTTP

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

{
  "additionalRolesAuthorizedToChangeBranch": "MemberAndContributor"
}

Respuesta de muestra

status code:: 200

{
  "additionalRolesAuthorizedToChangeBranch": "MemberAndContributor"
}

Definiciones

Nombre	Description
ErrorParameter	Parámetro estructurado que proporciona contexto legible por máquina adicional sobre un error.
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
GitAdditionalBranchChangingRoles	Los roles de área de trabajo adicionales más allá del administrador que pueden cambiar la rama de Git conectada. Se pueden agregar valores adicionales a lo largo del tiempo.
GitConnectionSettings	Contiene la configuración de conexión de Git.
UpdateGitConnectionSettingsRequest	Contiene los datos de solicitud para actualizar la configuración de conexión de Git.

ErrorParameter

Objeto

Parámetro estructurado que proporciona contexto legible por máquina adicional sobre un error.

Nombre	Tipo	Description
message	string	Descripción legible del significado del parámetro.
name	string	El identificador de parámetros.
value	string	Es el valor del parámetro.

ErrorRelatedResource

Objeto

Objeto de detalles del recurso relacionado con el error.

Nombre	Tipo	Description
resourceId	string	ID de recurso que está involucrado en el error.
resourceType	string	Tipo del recurso implicado en el error.

ErrorResponse

Objeto

Respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
isRetriable	boolean	Cuando es true, se puede reintentar la solicitud. Use el `Retry-After` encabezado de respuesta para determinar el retraso, si está disponible.
message	string	Representación comprensible para humanos del error.
moreDetails	ErrorResponseDetails[]	Lista de detalles de error adicionales.
parameters	ErrorParameter[]	Parámetros estructurados que proporcionan contexto legible por máquina adicional sobre el error.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.
requestId	string (uuid)	Identificador de la solicitud asociada al error.

ErrorResponseDetails

Objeto

Detalles de la respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message	string	Representación comprensible para humanos del error.
parameters	ErrorParameter[]	Parámetros estructurados que proporcionan contexto legible por máquina adicional sobre el error.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.

GitAdditionalBranchChangingRoles

Enumeración

Los roles de área de trabajo adicionales más allá del administrador que pueden cambiar la rama de Git conectada. Se pueden agregar valores adicionales a lo largo del tiempo.

Valor	Description
None	Ningún rol adicional más allá del administrador puede cambiar las ramas. Este es el valor predeterminado.
MemberAndContributor	Los miembros y colaboradores también pueden cambiar las ramas además de los administradores.

GitConnectionSettings

Objeto

Contiene la configuración de conexión de Git.

Nombre	Tipo	Description
additionalRolesAuthorizedToChangeBranch	GitAdditionalBranchChangingRoles	Los roles de área de trabajo adicionales más allá del administrador que pueden cambiar la rama de Git conectada.

UpdateGitConnectionSettingsRequest

Objeto

Contiene los datos de solicitud para actualizar la configuración de conexión de Git.

Nombre	Tipo	Description
additionalRolesAuthorizedToChangeBranch	GitAdditionalBranchChangingRoles	Los roles de área de trabajo adicionales más allá del administrador que pueden cambiar la rama de Git conectada.