Compartilhar via

Git - Connect

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

Conecte um workspace específico a um repositório git e branch.
Essa operação não é sincronizada entre o workspace e o branch conectado. Para concluir a sincronização, use a operação Inicializar Conexão e siga com a operação Commit To Git ou Update From Git .

Para começar a usar o GitHub, confira: Introdução à integração do Git.

Para obter a ID de conexão, consulte Automatizar a integração do Git.

Permissões

O chamador deve ter uma função de administrador para o workspace.

Para credenciais do Git de conexão configuradas, o chamador deve ter permissão para a conexão.

Escopos delegados necessários

Workspace.ReadWrite.All

Limitações

Ao usar a origem de credenciais automáticas, essa API é bloqueada para o provedor GitHub e para a Entidade de Serviço.

Identidades com suporte do Microsoft Entra

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

Identidade Apoio
Utilizador Sim
entidade de serviço e identidades gerenciadas Suporte somente quando myGitCredentials.source for ConfiguredConnection

Interfase

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
workspaceId
 path True

string (uuid)

O identificador do espaço de trabalho.

Corpo da solicitação

Nome Obrigatório Tipo Description
gitProviderDetails True GitProviderDetails:

Os detalhes do provedor Git.
myGitCredentials GitCredentials:

Credenciais do Git específicas do usuário para autenticação no GitProvider. Essas credenciais não são compartilhadas com outros colaboradores do workspace. Para o GitHub, essa propriedade é necessária. Para o AzureDevOps, essa propriedade é opcional. Se não for definido, o padrão será AutomaticGitCredentials.

Respostas

Nome Tipo Description
200 OK

Solicitação concluída com êxito.
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • UnknownError – Ocorreu um erro.

  • WorkspaceAlreadyConnectedToGit – O workspace já está conectado ao git.

  • WorkspaceHasNoCapacityAssigned – nenhuma capacidade atribuída ao workspace.

  • InsufficientPrivileges – o chamador tem permissões de workspace insuficientes.

  • PrincipalTypeNotSupported – Não há suporte para o tipo de identidade do chamador.

Exemplos

Connect a workspace to Azure DevOps example
Connect a workspace to Azure DevOps using configured connection 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

Solicitação de exemplo

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"
  }
}

Resposta de exemplo

Código de status:
200

Connect a workspace to Azure DevOps using configured connection example

Solicitação de exemplo

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"
  }
}

Resposta de exemplo

Código de status:
200

Connect a workspace to GitHub example

Solicitação de exemplo

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"
  }
}

Resposta de exemplo

Código de status:
200

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

Solicitação de exemplo

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"
  }
}

Resposta de exemplo

Código de status:
200

Definições

Nome Description
AutomaticGitCredentials

Credenciais automáticas do Git.
AzureDevOpsDetails

Detalhes do provedor do Azure DevOps.
ConfiguredConnectionGitCredentials

Credenciais do Git de conexão configuradas.
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
GitConnectRequest

Contém os dados de solicitação do Git Connect.
GitCredentialsSource

A fonte de credenciais do Git. Fontes de credenciais adicionais do Git podem ser adicionadas 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.

AutomaticGitCredentials

Objeto

Credenciais automáticas do Git.

Nome Tipo Description
source string:

Automatic

A fonte de credenciais do Git.

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.

ConfiguredConnectionGitCredentials

Objeto

Credenciais do Git de conexão configuradas.

Nome Tipo Description
connectionId

string (uuid)

A ID do objeto da conexão.
source string:

ConfiguredConnection

A fonte de credenciais do Git.

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.

GitConnectRequest

Objeto

Contém os dados de solicitação do Git Connect.

Nome Tipo Description
gitProviderDetails GitProviderDetails:

Os detalhes do provedor Git.
myGitCredentials GitCredentials:

Credenciais do Git específicas do usuário para autenticação no GitProvider. Essas credenciais não são compartilhadas com outros colaboradores do workspace. Para o GitHub, essa propriedade é necessária. Para o AzureDevOps, essa propriedade é opcional. Se não for definido, o padrão será AutomaticGitCredentials.

GitCredentialsSource

Enumeração

A fonte de credenciais do Git. Fontes de credenciais adicionais do Git podem ser adicionadas ao longo do tempo.

Valor Description
ConfiguredConnection

As credenciais do Git são obtidas por meio de uma conexão configurada.
Automatic

As credenciais do Git são obtidas automaticamente pelo sistema, usando credenciais padrão, se disponíveis.
None

As credenciais do Git não estão configuradas.

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

string

maxLength: 100

Observação

O suporte para o GitHub Enterprise com residência de dados (ghe.com) está atualmente em versão prévia. (saiba mais).

O nome do domínio github da empresa se ele não for github.com. Há suporte apenas para o GitHub Enterprise com domínios de residência de dados (ghe.com). 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 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