Compartilhar via


Git - Initialize Connection

Inicialize uma conexão para um workspace conectado ao Git.
Essa API dá suporte a LRO (operações de execução longa).

Para usar essa API, as credenciais do Git do chamador devem ser configuradas usando a API Atualizar Minhas Credenciais do Git . Você pode usar a API Obter Minhas Credenciais do Git para verificar a configuração de credenciais do Git.

Essa API deve ser chamada após uma chamada bem-sucedida para a API connect . Para concluir uma sincronização completa do workspace, use a operação de Ação Necessária para chamar a operação de sincronização relevante, confirmar para Git ou atualizar do Git.

Permissions

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

Escopos delegados necessários

Workspace.ReadWrite.All

Identidades com suporte do Microsoft Entra

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

Identity Support
User Yes
Entidade de serviço e identidades gerenciadas Yes

Interface

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

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 Tipo Description
initializationStrategy

InitializationStrategy

A estratégia necessária para um processo de inicialização quando o conteúdo existe no lado remoto e no lado do workspace. Estratégias adicionais podem ser adicionadas ao longo do tempo.

Respostas

Nome Tipo Description
200 OK

InitializeGitConnectionResponse

Solicitação concluída com êxito.

202 Accepted

Solicitação aceita, inicialize a conexão em andamento.

Cabeçalhos

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • WorkspaceNotConnectedToGit – O workspace não está conectado ao git.

  • WorkspaceHasNoCapacityAssigned – nenhuma capacidade atribuída ao Workspace.

  • MissingInitializationPolicy – A política de inicialização está ausente.

  • InsufficientPrivileges - O chamador não tem permissões suficientes no workspace.

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

Exemplos

Initialize the connection of a workspace connected to a Git example

Solicitação de exemplo

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

Resposta de exemplo

{
  "requiredAction": "UpdateFromGit",
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705"
}
Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Definições

Nome Description
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.

ErrorResponse

A resposta de erro.

ErrorResponseDetails

Os detalhes da resposta de erro.

InitializationStrategy

A estratégia necessária para um processo de inicialização quando o conteúdo existe no lado remoto e no lado do workspace. Estratégias adicionais podem ser adicionadas ao longo do tempo.

InitializeGitConnectionRequest

Contém os dados de solicitação de conexão git inicializados.

InitializeGitConnectionResponse

Contém os dados de resposta de conexão git inicializados.

RequiredAction

Ação necessária após a conclusão do processo de inicialização. Ações adicionais podem ser adicionadas ao longo do tempo.

ErrorRelatedResource

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

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

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.

InitializationStrategy

A estratégia necessária para um processo de inicialização quando o conteúdo existe no lado remoto e no lado do workspace. Estratégias adicionais podem ser adicionadas ao longo do tempo.

Valor Description
None

Nenhuma estratégia definida.

PreferRemote

Prefira conteúdo remoto do lado do Git.

PreferWorkspace

Prefira o conteúdo do lado do workspace.

InitializeGitConnectionRequest

Contém os dados de solicitação de conexão git inicializados.

Nome Tipo Description
initializationStrategy

InitializationStrategy

A estratégia necessária para um processo de inicialização quando o conteúdo existe no lado remoto e no lado do workspace. Estratégias adicionais podem ser adicionadas ao longo do tempo.

InitializeGitConnectionResponse

Contém os dados de resposta de conexão git inicializados.

Nome Tipo Description
remoteCommitHash

string

Hash de confirmação SHA completo remoto.

requiredAction

RequiredAction

Ação necessária após a conclusão do processo de inicialização. Ações adicionais podem ser adicionadas ao longo do tempo.

workspaceHead

string

Hash SHA completo ao qual o workspace está sincronizado.

RequiredAction

Ação necessária após a conclusão do processo de inicialização. Ações adicionais podem ser adicionadas ao longo do tempo.

Valor Description
None

Nenhuma ação é necessária.

UpdateFromGit

A atualização do Git é necessária.

CommitToGit

A confirmação com o Git é necessária.