Partilhar via

Git - Get Connection

Serviço:
Core
Versão da API:
v1

Retorna detalhes de conexão git para o espaço de trabalho especificado.

Permissões

O chamador deve ter uma função de de espaço de trabalho de contribuidor ou superior.

Escopos delegados necessários

Workspace.Read.All ou Workspace.ReadWrite.All

Identidades suportadas pelo Microsoft Entra

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identidade Apoio
Utilizador Yes
Entidade de serviço e identidades geridas Yes

Interfaz

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

Parâmetros do URI

Name Em Necessário Tipo Description
workspaceId
 path True

string (uuid)

O ID do espaço de trabalho.

Respostas

Name Tipo Description
200 OK

GitConnection

Pedido concluído com sucesso.
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • UnknownError - Ocorreu um erro.

  • InsufficientPrivileges - O chamador não tem permissões de espaço de trabalho suficientes.

Exemplos

Get Git connection details example
Workspace not connected to git example

Get Git connection details example

Pedido de amostra

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

Resposta da amostra

Código de estado:
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

Pedido de amostra

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

Resposta da amostra

Código de estado:
200 
{
  "gitProviderDetails": null,
  "gitSyncDetails": null,
  "gitConnectionState": "NotConnected"
}

Definições

Name Description
AzureDevOpsDetails

Detalhes do provedor do Azure DevOps.
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
GitConnection

Contém os detalhes da conexão Git.
GitConnectionState

Estado de conexão Git. Tipos de estado de conexão adicionais podem ser adicionados ao longo do tempo.
GitHubDetails

Detalhes do provedor GitHub.
GitProviderType

Um tipo de provedor Git. Tipos de provedores adicionais podem ser adicionados ao longo do tempo.
GitSyncDetails

Contém os detalhes da sincronização.

AzureDevOpsDetails

Object

Detalhes do provedor do Azure DevOps.

Name Tipo Description
branchName

string

maxLength: 250

O nome da filial. O comprimento máximo é de 250 caracteres.
directoryName

string

maxLength: 256

O caminho relativo para o diretório. O comprimento máximo é de 256 caracteres.
gitProviderType string:

AzureDevOps

Um tipo de provedor Git. Tipos de provedores adicionais podem ser adicionados ao longo do tempo.
organizationName

string

maxLength: 100

O nome da organização. O comprimento máximo é de 100 caracteres.
projectName

string

maxLength: 100

O nome do projeto. O comprimento máximo é de 100 caracteres.
repositoryName

string

maxLength: 128

O nome do repositório. O comprimento máximo é de 128 caracteres.

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Name Tipo Description
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.
requestId

string

ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.

GitConnection

Object

Contém os detalhes da conexão Git.

Name Tipo Description
gitConnectionState

GitConnectionState

Estado de conexão Git. Tipos de estado de conexão adicionais podem ser adicionados ao longo do tempo.
gitProviderDetails GitProviderDetails:

Os detalhes do provedor Git.
gitSyncDetails

GitSyncDetails

Contém os detalhes da sincronização.

GitConnectionState

Enumeração

Estado de conexão Git. Tipos de estado de conexão adicionais podem ser adicionados ao longo do tempo.

Valor Description
NotConnected

Estado não conectado.
Connected

Estado conectado.
ConnectedAndInitialized

Estado conectado e inicializado.

GitHubDetails

Object

Detalhes do provedor GitHub.

Name Tipo Description
branchName

string

maxLength: 250

O nome da filial. O comprimento máximo é de 250 caracteres.
customDomainName

string

maxLength: 100

Observação

O suporte para GitHub Enterprise com residência de dados (ghe.com) está atualmente em Preview. (Saiba mais).

O nome do domínio empresarial no github, caso não seja github.com. Apenas o GitHub Enterprise com domínios de residência de dados (ghe.com) é suportado. O comprimento máximo é de 100 caracteres.
directoryName

string

maxLength: 256

O caminho relativo para o diretório. O comprimento máximo é de 256 caracteres.
gitProviderType string:

GitHub

Um tipo de provedor Git. Tipos de provedores adicionais podem ser adicionados ao longo do tempo.
ownerName

string

maxLength: 100

O nome do proprietário. O comprimento máximo é de 100 caracteres.
repositoryName

string

maxLength: 128

O nome do repositório. O comprimento máximo é de 128 caracteres.

GitProviderType

Enumeração

Um tipo de provedor Git. Tipos de provedores adicionais podem ser adicionados ao longo do tempo.

Valor Description
AzureDevOps

Provedor de DevOps do Azure
GitHub

Provedor GitHub

GitSyncDetails

Object

Contém os detalhes da sincronização.

Name Tipo Description
head

string

O Secure Hash Algorithm 1 (SHA-1) completo do ID de confirmação sincronizado.
lastSyncTime

string (date-time)

A data e a hora do último estado de sincronização.