Partilhar via

Git - Update My Git Credentials

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

Atualiza os detalhes de configuração das credenciais do Git do usuário.
Cada usuário no espaço de trabalho tem suas próprias credenciais Git configuradas. Você pode usar Get My Git Credentials API para obter a configuração de credenciais do Git.

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

Permissões

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

Para credenciais 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 fonte de credenciais automática, essa API é bloqueada para o provedor GitHub e para a entidade de serviço.

Identidades suportadas pelo Microsoft Entra

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

Identidade Apoio
Utilizador Sim
Entidade de serviço e identidades geridas Suportado apenas quando a origem é ConfiguredConnection ou None

Interfaz

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/myGitCredentials

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

O corpo de pedido pode ser um dos seguintes:

Name Description
UpdateGitCredentialsToAutomaticRequest

Contém os dados da solicitação para atualizar as credenciais do Git para automáticas.
UpdateGitCredentialsToConfiguredConnectionRequest

Contém os dados da solicitação para atualizar as credenciais do Git para a conexão configurada.
UpdateGitCredentialsToNoneRequest

Contém os dados da solicitação para atualizar as credenciais do Git para nenhuma.

UpdateGitCredentialsToAutomaticRequest

Contém os dados da solicitação para atualizar as credenciais do Git para automáticas.

Name Necessário Tipo Description
source True string:

Automatic

A fonte de credenciais do Git.

UpdateGitCredentialsToConfiguredConnectionRequest

Contém os dados da solicitação para atualizar as credenciais do Git para a conexão configurada.

Name Necessário Tipo Description
connectionId True

string (uuid)

O ID do objeto da conexão.
source True string:

ConfiguredConnection

A fonte de credenciais do Git.

UpdateGitCredentialsToNoneRequest

Contém os dados da solicitação para atualizar as credenciais do Git para nenhuma.

Name Necessário Tipo Description
source True string:

None

A fonte de credenciais do Git.

Respostas

Name Tipo Description
200 OK GitCredentialsConfigurationResponse:

Pedido concluído com sucesso.
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • UnknownError - Ocorreu um erro.

  • InsufficientPrivileges - O chamador tem permissões de espaço de trabalho insuficientes.

  • WorkspaceNotConnectedToGit - O espaço de trabalho não está conectado ao git.

  • ConnectionNotFound - A conexão especificada não foi encontrada.

  • ConnectionMismatch - A conexão não corresponde aos detalhes do provedor Git.

  • PrincipalTypeNotSupported - O tipo de identidade do chamador não é suportado.

Exemplos

Update user's Git credentials to Automatic example
Update user's Git credentials to ConfiguredConnection example
Update user's Git credentials to None example

Update user's Git credentials to Automatic example

Pedido de amostra

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

{
  "source": "Automatic"
}

Resposta da amostra

Código de estado:
200 
{
  "source": "Automatic"
}

Update user's Git credentials to ConfiguredConnection example

Pedido de amostra

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

{
  "source": "ConfiguredConnection",
  "connectionId": "3f2504e0-4f89-11d3-9a0c-0305e82c3301"
}

Resposta da amostra

Código de estado:
200 
{
  "source": "ConfiguredConnection",
  "connectionId": "3f2504e0-4f89-11d3-9a0c-0305e82c3301"
}

Update user's Git credentials to None example

Pedido de amostra

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

{
  "source": "None"
}

Resposta da amostra

Código de estado:
200 
{
  "source": "None"
}

Definições

Name Description
AutomaticGitCredentialsResponse

Credenciais automáticas do Git.
ConfiguredConnectionGitCredentialsResponse

Credenciais 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.
GitCredentialsSource

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

Credenciais do Git não configuradas.
UpdateGitCredentialsToAutomaticRequest

Contém os dados da solicitação para atualizar as credenciais do Git para automáticas.
UpdateGitCredentialsToConfiguredConnectionRequest

Contém os dados da solicitação para atualizar as credenciais do Git para a conexão configurada.
UpdateGitCredentialsToNoneRequest

Contém os dados da solicitação para atualizar as credenciais do Git para nenhuma.

AutomaticGitCredentialsResponse

Object

Credenciais automáticas do Git.

Name Tipo Description
source string:

Automatic

A fonte de credenciais do Git.

ConfiguredConnectionGitCredentialsResponse

Object

Credenciais Git de conexão configuradas.

Name Tipo Description
connectionId

string (uuid)

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

ConfiguredConnection

A fonte de credenciais do Git.

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.

GitCredentialsSource

Enumeração

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

NoneGitCredentialsResponse

Object

Credenciais do Git não configuradas.

Name Tipo Description
source string:

None

A fonte de credenciais do Git.

UpdateGitCredentialsToAutomaticRequest

Object

Contém os dados da solicitação para atualizar as credenciais do Git para automáticas.

Name Tipo Description
source string:

Automatic

A fonte de credenciais do Git.

UpdateGitCredentialsToConfiguredConnectionRequest

Object

Contém os dados da solicitação para atualizar as credenciais do Git para a conexão configurada.

Name Tipo Description
connectionId

string (uuid)

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

ConfiguredConnection

A fonte de credenciais do Git.

UpdateGitCredentialsToNoneRequest

Object

Contém os dados da solicitação para atualizar as credenciais do Git para nenhuma.

Name Tipo Description
source string:

None

A fonte de credenciais do Git.