Git - Get Connection

Serviço:

Core

Versão da API:

v1

Retorna detalhes de conexão git para o workspace especificado.

Permissões

O chamador deve ter um colaborador ou uma função de workspace superior.

Escopos delegados necessários

Workspace.Read.All ou Workspace.ReadWrite.All

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identidade	Apoio
Utilizador	Yes
entidade de serviço e identidades gerenciadas	Yes

Interface

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
workspaceId	path	True	string (uuid)	O identificador do espaço de trabalho.

Respostas

Nome	Tipo	Description
200 OK	GitConnection	Solicitação concluída com êxito.
Other Status Codes	ErrorResponse	Códigos de erro comuns: UnknownError – Ocorreu um erro. InsufficientPrivileges - O chamador não tem permissões de workspace suficientes.

Exemplos

Get Git connection details example

Workspace not connected to git example

Get Git connection details example

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:

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

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:

200

{
  "gitProviderDetails": null,
  "gitSyncDetails": null,
  "gitConnectionState": "NotConnected"
}

Definições

Nome	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 do Git.
GitConnectionState	Estado de conexão do Git. Tipos de estado de conexão adicionais podem ser adicionados ao longo do tempo.
GitHubDetails	Detalhes do provedor do GitHub.
GitProviderType	Um tipo de provedor Git. Tipos de provedor adicionais podem ser adicionados ao longo do tempo.
GitSyncDetails	Contém os detalhes da sincronização.

AzureDevOpsDetails

Objeto

Detalhes do provedor do Azure DevOps.

Nome	Tipo	Description
branchName	string maxLength: 250	O nome do branch. 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 provedor 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

Objeto

O objeto de detalhes do recurso relacionado ao erro.

Nome	Tipo	Description
resourceId	string	A ID do recurso envolvida no erro.
resourceType	string	O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.
requestId	string	ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.

GitConnection

Objeto

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

Nome	Tipo	Description
gitConnectionState	GitConnectionState	Estado de conexão do Git. Tipos de estado de conexão adicionais podem ser adicionados ao longo do tempo.
gitProviderDetails	GitProviderDetails: AzureDevOpsDetails GitHubDetails	Os detalhes do provedor Git.
gitSyncDetails	GitSyncDetails	Contém os detalhes da sincronização.

GitConnectionState

Enumeração

Estado de conexão do 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

Objeto

Detalhes do provedor do GitHub.

Nome	Tipo	Description
branchName	string maxLength: 250	O nome do branch. 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: GitHub	Um tipo de provedor Git. Tipos de provedor 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 provedor adicionais podem ser adicionados ao longo do tempo.

Valor	Description
AzureDevOps	Provedor do Azure DevOps
GitHub	Provedor do GitHub

GitSyncDetails

Objeto

Contém os detalhes da sincronização.

Nome	Tipo	Description
head	string	O algoritmo de hash seguro completo 1 (SHA-1) da ID de confirmação sincronizada.
lastSyncTime	string (date-time)	A data e a hora do último estado de sincronização.