Compartir a través de

Git - Update My Git Credentials

Servicio:
Core
Versión de la API:
v1

Actualiza los detalles de configuración de las credenciales de Git del usuario.
Cada usuario del área de trabajo tiene sus propias credenciales de Git configuradas. Puede usar Get My Git Credentials API para obtener la configuración de credenciales de Git.

Para obtener el identificador de conexión, consulte Automatización de la integración de Git.

Permisos

El autor de la llamada debe tener un rol de colaborador o superior.

Para las credenciales de Git de conexión configuradas, el autor de la llamada debe tener permiso para la conexión.

Ámbitos delegados necesarios

Workspace.ReadWrite.All

Limitaciones

Al usar el origen de credenciales automáticas, esta API se bloquea para el proveedor de GitHub y para la entidad de servicio.

Identidades admitidas de Microsoft Entra

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

identidad Apoyo
Usuario Sí
de entidad de servicio y identidades administradas Solo se admite cuando source es ConfiguredConnection o None

Interfaz

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
workspaceId
 path True

string (uuid)

Identificador del área de trabajo.

Cuerpo de la solicitud

El cuerpo de la solicitud puede ser uno de los siguientes:

Nombre Description
UpdateGitCredentialsToAutomaticRequest

Contiene los datos de solicitud para actualizar las credenciales de Git a automático.
UpdateGitCredentialsToConfiguredConnectionRequest

Contiene los datos de solicitud para actualizar las credenciales de Git a la conexión configurada.
UpdateGitCredentialsToNoneRequest

Contiene los datos de solicitud para actualizar las credenciales de Git a ninguna.

UpdateGitCredentialsToAutomaticRequest

Contiene los datos de solicitud para actualizar las credenciales de Git a automático.

Nombre Requerido Tipo Description
source True string:

Automatic

Origen de credenciales de Git.

UpdateGitCredentialsToConfiguredConnectionRequest

Contiene los datos de solicitud para actualizar las credenciales de Git a la conexión configurada.

Nombre Requerido Tipo Description
connectionId True

string (uuid)

Identificador de objeto de la conexión.
source True string:

ConfiguredConnection

Origen de credenciales de Git.

UpdateGitCredentialsToNoneRequest

Contiene los datos de solicitud para actualizar las credenciales de Git a ninguna.

Nombre Requerido Tipo Description
source True string:

None

Origen de credenciales de Git.

Respuestas

Nombre Tipo Description
200 OK GitCredentialsConfigurationResponse:

Solicitud completada correctamente.
Other Status Codes

ErrorResponse

Códigos de error comunes:

  • UnknownError: se produjo un error.

  • InsufficientPrivileges: el autor de la llamada tiene permisos de área de trabajo insuficientes.

  • WorkspaceNotConnectedToGit: el área de trabajo no está conectada a Git.

  • ConnectionNotFound: no se encontró la conexión especificada.

  • ConnectionMismatch: la conexión no coincide con los detalles del proveedor de Git.

  • PrincipalTypeNotSupported: no se admite el tipo de identidad llamador.

Ejemplos

Update user's Git credentials to Automatic example
Update user's Git credentials to ConfiguredConnection example
Update user's Git credentials to None example

Update user's Git credentials to Automatic example

Solicitud de ejemplo

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

{
  "source": "Automatic"
}

Respuesta de muestra

status code:
200 
{
  "source": "Automatic"
}

Update user's Git credentials to ConfiguredConnection example

Solicitud de ejemplo

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

{
  "source": "ConfiguredConnection",
  "connectionId": "3f2504e0-4f89-11d3-9a0c-0305e82c3301"
}

Respuesta de muestra

status code:
200 
{
  "source": "ConfiguredConnection",
  "connectionId": "3f2504e0-4f89-11d3-9a0c-0305e82c3301"
}

Update user's Git credentials to None example

Solicitud de ejemplo

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

{
  "source": "None"
}

Respuesta de muestra

status code:
200 
{
  "source": "None"
}

Definiciones

Nombre Description
AutomaticGitCredentialsResponse

Credenciales automáticas de Git.
ConfiguredConnectionGitCredentialsResponse

Credenciales de Git de conexión configuradas.
ErrorRelatedResource

Objeto de detalles del recurso relacionado con el error.
ErrorResponse

Respuesta de error.
ErrorResponseDetails

Detalles de la respuesta de error.
GitCredentialsSource

Origen de credenciales de Git. Se pueden agregar orígenes de credenciales de Git adicionales a lo largo del tiempo.
NoneGitCredentialsResponse

Credenciales de Git no configuradas.
UpdateGitCredentialsToAutomaticRequest

Contiene los datos de solicitud para actualizar las credenciales de Git a automático.
UpdateGitCredentialsToConfiguredConnectionRequest

Contiene los datos de solicitud para actualizar las credenciales de Git a la conexión configurada.
UpdateGitCredentialsToNoneRequest

Contiene los datos de solicitud para actualizar las credenciales de Git a ninguna.

AutomaticGitCredentialsResponse

Object

Credenciales automáticas de Git.

Nombre Tipo Description
source string:

Automatic

Origen de credenciales de Git.

ConfiguredConnectionGitCredentialsResponse

Object

Credenciales de Git de conexión configuradas.

Nombre Tipo Description
connectionId

string (uuid)

Identificador de objeto de la conexión.
source string:

ConfiguredConnection

Origen de credenciales de Git.

ErrorRelatedResource

Object

Objeto de detalles del recurso relacionado con el error.

Nombre Tipo Description
resourceId

string

Identificador de recurso implicado en el error.
resourceType

string

Tipo del recurso implicado en el error.

ErrorResponse

Object

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 legible del error.
moreDetails

ErrorResponseDetails[]

Lista de detalles de error adicionales.
relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.
requestId

string

Identificador de la solicitud asociada al error.

ErrorResponseDetails

Object

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 legible del error.
relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.

GitCredentialsSource

Enumeración

Origen de credenciales de Git. Se pueden agregar orígenes de credenciales de Git adicionales a lo largo del tiempo.

Valor Description
ConfiguredConnection

Las credenciales de Git se obtienen a través de una conexión configurada.
Automatic

El sistema obtiene automáticamente las credenciales de Git mediante las credenciales predeterminadas si están disponibles.
None

Las credenciales de Git no están configuradas.

NoneGitCredentialsResponse

Object

Credenciales de Git no configuradas.

Nombre Tipo Description
source string:

None

Origen de credenciales de Git.

UpdateGitCredentialsToAutomaticRequest

Object

Contiene los datos de solicitud para actualizar las credenciales de Git a automático.

Nombre Tipo Description
source string:

Automatic

Origen de credenciales de Git.

UpdateGitCredentialsToConfiguredConnectionRequest

Object

Contiene los datos de solicitud para actualizar las credenciales de Git a la conexión configurada.

Nombre Tipo Description
connectionId

string (uuid)

Identificador de objeto de la conexión.
source string:

ConfiguredConnection

Origen de credenciales de Git.

UpdateGitCredentialsToNoneRequest

Object

Contiene los datos de solicitud para actualizar las credenciales de Git a ninguna.

Nombre Tipo Description
source string:

None

Origen de credenciales de Git.