Git - Connect

Servicio:
Core
Versión de la API:
v1

Conecte un área de trabajo específica a un repositorio y una rama de Git.
Esta operación no se sincroniza entre el área de trabajo y la rama conectada. Para completar la sincronización, use la operación Inicializar conexión y siga con la operación Confirmar en Git o actualizar desde Git .

Para empezar a trabajar con GitHub, consulte: Introducción a la integración 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 administrador para el área de trabajo.

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 myGitCredentials.source es ConfiguredConnection

Interfaz

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/connect

Parámetros de identificador URI

Nombre En Requerido Tipo Description
workspaceId
 path True

string (uuid)

Identificador del área de trabajo.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
gitProviderDetails True GitProviderDetails:

Detalles del proveedor de Git.
connectionSettings

GitConnectionSettings

Configuración de conexión opcional que se aplicará en el momento de la conexión. Si se omite, se aplican los valores predeterminados.
myGitCredentials GitCredentials:

Credenciales de Git específicas del usuario para la autenticación en GitProvider. Estas credenciales no se comparten con otros colaboradores del área de trabajo. Para GitHub, esta propiedad es necesaria. Para AzureDevOps, esta propiedad es opcional. Si no se establece, el valor predeterminado es AutomaticGitCredentials.

Respuestas

Nombre Tipo Description
200 OK

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.

  • WorkspaceAlreadyConnectedToGit: el área de trabajo ya está conectada a Git.

  • WorkspaceHasNoCapacityAssigned: no hay capacidad asignada al área de trabajo.

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

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

Ejemplos

Connect a workspace to Azure DevOps example
Connect a workspace to Azure DevOps using configured connection example
Connect a workspace to Azure DevOps with connection settings example
Connect a workspace to GitHub example
Connect a workspace to GitHub example - GitHub Enterprise With Data Residency (ghe.com)

Connect a workspace to Azure DevOps example

Solicitud de ejemplo

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

{
  "gitProviderDetails": {
    "organizationName": "Test Organization",
    "projectName": "Test Project",
    "gitProviderType": "AzureDevOps",
    "repositoryName": "Test Repo",
    "branchName": "Test Branch",
    "directoryName": "Test Directory"
  }
}

Respuesta de muestra

status code:
200

Connect a workspace to Azure DevOps using configured connection example

Solicitud de ejemplo

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

{
  "gitProviderDetails": {
    "organizationName": "Test Organization",
    "projectName": "Test Project",
    "gitProviderType": "AzureDevOps",
    "repositoryName": "Test Repo",
    "branchName": "Test Branch",
    "directoryName": "Test Directory/Test Subdirectory"
  },
  "myGitCredentials": {
    "source": "ConfiguredConnection",
    "connectionId": "3f2504e0-4f89-11d3-9a0c-0305e82c3301"
  }
}

Respuesta de muestra

status code:
200

Connect a workspace to Azure DevOps with connection settings example

Solicitud de ejemplo

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

{
  "gitProviderDetails": {
    "organizationName": "Test Organization",
    "projectName": "Test Project",
    "gitProviderType": "AzureDevOps",
    "repositoryName": "Test Repo",
    "branchName": "Test Branch",
    "directoryName": "Test Directory"
  },
  "connectionSettings": {
    "additionalRolesAuthorizedToChangeBranch": "MemberAndContributor"
  }
}

Respuesta de muestra

status code:
200

Connect a workspace to GitHub example

Solicitud de ejemplo

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

{
  "gitProviderDetails": {
    "ownerName": "Test Owner",
    "gitProviderType": "GitHub",
    "repositoryName": "Test Repo",
    "branchName": "Test Branch",
    "directoryName": "Test Directory/Test Subdirectory"
  },
  "myGitCredentials": {
    "source": "ConfiguredConnection",
    "connectionId": "3f2504e0-4f89-11d3-9a0c-0305e82c3301"
  }
}

Respuesta de muestra

status code:
200

Connect a workspace to GitHub example - GitHub Enterprise With Data Residency (ghe.com)

Solicitud de ejemplo

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

{
  "gitProviderDetails": {
    "ownerName": "Test Owner",
    "customDomainName": "my-enterprise.ghe.com",
    "gitProviderType": "GitHub",
    "repositoryName": "Test Repo",
    "branchName": "Test Branch",
    "directoryName": "Test Directory/Test Subdirectory"
  },
  "myGitCredentials": {
    "source": "ConfiguredConnection",
    "connectionId": "3f2504e0-4f89-11d3-9a0c-0305e82c3301"
  }
}

Respuesta de muestra

status code:
200

Definiciones

Nombre Description
AutomaticGitCredentials

Credenciales automáticas de Git.
AzureDevOpsDetails

Detalles del proveedor de Azure DevOps.
ConfiguredConnectionGitCredentials

Credenciales de Git de conexión configuradas.
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.
GitConnectRequest

Contiene los datos de solicitud de conexión de Git.
GitCredentialsSource

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

Detalles del proveedor de GitHub.
GitProviderType

Tipo de proveedor de Git. Se pueden agregar tipos de proveedor adicionales a lo largo del tiempo.

AutomaticGitCredentials

Objeto

Credenciales automáticas de Git.

Nombre Tipo Description
source string:

Automatic

Origen de credenciales de Git.

AzureDevOpsDetails

Objeto

Detalles del proveedor de Azure DevOps.

Nombre Tipo Description
branchName

string

maxLength: 250

Nombre de la rama. La longitud máxima es de 250 caracteres.
directoryName

string

maxLength: 256

Ruta de acceso relativa al directorio. La longitud máxima es de 256 caracteres.
gitProviderType string:

AzureDevOps

Tipo de proveedor de Git. Se pueden agregar tipos de proveedor adicionales a lo largo del tiempo.
organizationName

string

maxLength: 100

El nombre de la organización. La longitud máxima es de 100 caracteres.
projectName

string

maxLength: 100

Nombre del proyecto. La longitud máxima es de 100 caracteres.
repositoryName

string

maxLength: 128

Nombre del repositorio. La longitud máxima es de 128 caracteres.

ConfiguredConnectionGitCredentials

Objeto

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.

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

Identificador de recurso implicado 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 legible 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 legible 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.

GitConnectRequest

Objeto

Contiene los datos de solicitud de conexión de Git.

Nombre Tipo Description
connectionSettings

GitConnectionSettings

Configuración de conexión opcional que se aplicará en el momento de la conexión. Si se omite, se aplican los valores predeterminados.
gitProviderDetails GitProviderDetails:

Detalles del proveedor de Git.
myGitCredentials GitCredentials:

Credenciales de Git específicas del usuario para la autenticación en GitProvider. Estas credenciales no se comparten con otros colaboradores del área de trabajo. Para GitHub, esta propiedad es necesaria. Para AzureDevOps, esta propiedad es opcional. Si no se establece, el valor predeterminado es AutomaticGitCredentials.

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.

GitHubDetails

Objeto

Detalles del proveedor de GitHub.

Nombre Tipo Description
branchName

string

maxLength: 250

Nombre de la rama. La longitud máxima es de 250 caracteres.
customDomainName

string

maxLength: 100

Nombre del dominio de GitHub de empresa si no es github.com. Solo se admite GitHub Enterprise con dominios de residencia de datos (ghe.com). La longitud máxima es de 100 caracteres.
directoryName

string

maxLength: 256

Ruta de acceso relativa al directorio. La longitud máxima es de 256 caracteres.
gitProviderType string:

GitHub

Tipo de proveedor de Git. Se pueden agregar tipos de proveedor adicionales a lo largo del tiempo.
ownerName

string

maxLength: 100

Nombre del propietario. La longitud máxima es de 100 caracteres.
repositoryName

string

maxLength: 128

Nombre del repositorio. La longitud máxima es de 128 caracteres.

GitProviderType

Enumeración

Tipo de proveedor de Git. Se pueden agregar tipos de proveedor adicionales a lo largo del tiempo.

Valor Description
AzureDevOps

Proveedor de Azure DevOps
GitHub

Proveedor de GitHub