Compartir a través de

Git - Get Connection

Servicio:
Core
Versión de la API:
v1

Devuelve los detalles de conexión de Git para el área de trabajo especificada.

Permisos

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

Ámbitos delegados necesarios

Workspace.Read.All o Workspace.ReadWrite.All

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 Sí

Interfaz

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/connection

Parámetros de identificador URI

Nombre En Requerido Tipo Description
workspaceId
 path True

string (uuid)

Identificador del área de trabajo.

Respuestas

Nombre Tipo Description
200 OK

GitConnection

Solicitud completada correctamente.
Other Status Codes

ErrorResponse

Códigos de error comunes:

  • UnknownError: se produjo un error.

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

Ejemplos

Get Git connection details example
Workspace not connected to git example

Get Git connection details example

Solicitud de ejemplo

GET https://api.fabric.microsoft.com/v1/workspaces/1455b6a2-c120-4c1c-dda7-92bafe99bec3/git/connection

Respuesta de muestra

status code:
200 
{
  "gitProviderDetails": {
    "organizationName": "Test Organization",
    "projectName": "Test Project",
    "gitProviderType": "AzureDevOps",
    "repositoryName": "Test Repo",
    "branchName": "Test Branch",
    "directoryName": ""
  },
  "gitSyncDetails": {
    "head": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
    "lastSyncTime": "2021-11-20T09:26:43.153"
  },
  "gitConnectionState": "ConnectedAndInitialized"
}

Workspace not connected to git example

Solicitud de ejemplo

GET https://api.fabric.microsoft.com/v1/workspaces/1455b6a2-c120-4c1c-dda7-92bafe99bec3/git/connection

Respuesta de muestra

status code:
200 
{
  "gitProviderDetails": null,
  "gitSyncDetails": null,
  "gitConnectionState": "NotConnected"
}

Definiciones

Nombre Description
AzureDevOpsDetails

Detalles del proveedor de Azure DevOps.
ErrorRelatedResource

Objeto de detalles del recurso relacionado con el error.
ErrorResponse

Respuesta de error.
ErrorResponseDetails

Detalles de la respuesta de error.
GitConnection

Contiene los detalles de conexión de Git.
GitConnectionState

Estado de conexión de Git. Se pueden agregar tipos de estado de conexión 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.
GitSyncDetails

Contiene los detalles de sincronización.

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.

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.
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

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.
relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.

GitConnection

Objeto

Contiene los detalles de conexión de Git.

Nombre Tipo Description
gitConnectionState

GitConnectionState

Estado de conexión de Git. Se pueden agregar tipos de estado de conexión adicionales a lo largo del tiempo.
gitProviderDetails GitProviderDetails:

Detalles del proveedor de Git.
gitSyncDetails

GitSyncDetails

Contiene los detalles de sincronización.

GitConnectionState

Enumeración

Estado de conexión de Git. Se pueden agregar tipos de estado de conexión adicionales a lo largo del tiempo.

Valor Description
NotConnected

Estado no conectado.
Connected

Estado conectado.
ConnectedAndInitialized

Estado conectado e inicializado.

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

Nota:

La compatibilidad con GitHub Enterprise con residencia de datos (ghe.com) está actualmente en versión preliminar. (más información).

Nombre del dominio de github empresarial 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

GitSyncDetails

Objeto

Contiene los detalles de sincronización.

Nombre Tipo Description
head

string

El algoritmo hash seguro completo 1 (SHA-1) del identificador de confirmación sincronizado.
lastSyncTime

string (date-time)

Fecha y hora del último estado de sincronización.