Git - Initialize Connection

Serviço:

Core

Versão da API:

v1

Inicialize uma conexão para um espaço de trabalho conectado ao Git.
Esta API suporta operações de longa duração (LRO).

Para usar essa API, as credenciais do Git do chamador devem ser configuradas usando Update My Git Credentials API. Você pode usar a API Get My Git Credentials para verificar a configuração das 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 espaço de trabalho, use a operação Ação necessária para chamar a operação de sincronização relevante, Commit To Git ou Update From Git.

Permissions

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

Escopos delegados necessários

Workspace.ReadWrite.All

Identidades suportadas pelo Microsoft Entra

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

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

Interface

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
workspaceId	path	True	string (uuid)	O ID do espaço de trabalho.

Corpo do Pedido

Name	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 espaço de trabalho. Estratégias adicionais podem ser adicionadas ao longo do tempo.

Respostas

Name	Tipo	Description
200 OK	InitializeGitConnectionResponse	Pedido concluído com sucesso.
202 Accepted		Solicitação aceita, inicializar 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 espaço de trabalho não está conectado ao git. WorkspaceHasNoCapacityAssigned - Nenhuma capacidade atribuída ao espaço de trabalho. MissingInitializationPolicy - A política de inicialização está ausente. InsufficientPrivileges - O chamador não tem permissões suficientes no espaço de trabalho. PrincipalTypeNotSupported - O tipo de identidade do chamador não é suportado.

Exemplos

Initialize the connection of a workspace connected to a Git example

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:

200

{
  "requiredAction": "UpdateFromGit",
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705"
}

Código de estado:

202

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

Name	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 espaço de trabalho. 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

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.

InitializationStrategy

Enumeração

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

Valor	Description
None	Nenhuma estratégia definida.
PreferRemote	Prefira conteúdo remoto do lado Git.
PreferWorkspace	Prefira o conteúdo do lado do espaço de trabalho.

InitializeGitConnectionRequest

Object

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

Name	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 espaço de trabalho. Estratégias adicionais podem ser adicionadas ao longo do tempo.

InitializeGitConnectionResponse

Object

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

Name	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 com o qual o espaço de trabalho está sincronizado.

RequiredAction

Enumeração

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	É necessária uma atualização a partir do Git.
CommitToGit	É necessário comprometer-se com o Git.