Compartilhar via

Git - Update My Git Credentials

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

Atualiza os detalhes de configuração de credenciais git do usuário.
Cada usuário no workspace tem suas próprias credenciais do Git configuradas. Você pode usar a API Obter Minhas Credenciais do Git para obter a configuração de credenciais do Git.

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

Permissões

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

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 Com suporte somente quando a origem for ConfiguredConnection ou None

Interfase

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

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

O corpo da solicitação pode ser um dos seguintes:

Nome Description
UpdateGitCredentialsToAutomaticRequest

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

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

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

UpdateGitCredentialsToAutomaticRequest

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

Nome Obrigatório Tipo Description
source True string:

Automatic

A fonte de credenciais do Git.

UpdateGitCredentialsToConfiguredConnectionRequest

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

Nome Obrigatório Tipo Description
connectionId True

string (uuid)

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

ConfiguredConnection

A fonte de credenciais do Git.

UpdateGitCredentialsToNoneRequest

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

Nome Obrigatório Tipo Description
source True string:

None

A fonte de credenciais do Git.

Respostas

Nome Tipo Description
200 OK GitCredentialsConfigurationResponse:

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

ErrorResponse

Códigos de erro comuns:

  • UnknownError – Ocorreu um erro.

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

  • WorkspaceNotConnectedToGit – O workspace 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 – Não há suporte para o tipo de identidade do chamador.

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

Solicitação de exemplo

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

{
  "source": "Automatic"
}

Resposta de exemplo

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

Update user's Git credentials to ConfiguredConnection example

Solicitação de exemplo

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

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

Resposta de exemplo

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

Update user's Git credentials to None example

Solicitação de exemplo

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

{
  "source": "None"
}

Resposta de exemplo

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

Definições

Nome Description
AutomaticGitCredentialsResponse

Credenciais automáticas do Git.
ConfiguredConnectionGitCredentialsResponse

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

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

Credenciais do Git não configuradas.
UpdateGitCredentialsToAutomaticRequest

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

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

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

AutomaticGitCredentialsResponse

Objeto

Credenciais automáticas do Git.

Nome Tipo Description
source string:

Automatic

A fonte de credenciais do Git.

ConfiguredConnectionGitCredentialsResponse

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.

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.

NoneGitCredentialsResponse

Objeto

Credenciais do Git não configuradas.

Nome Tipo Description
source string:

None

A fonte de credenciais do Git.

UpdateGitCredentialsToAutomaticRequest

Objeto

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

Nome Tipo Description
source string:

Automatic

A fonte de credenciais do Git.

UpdateGitCredentialsToConfiguredConnectionRequest

Objeto

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

Nome Tipo Description
connectionId

string (uuid)

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

ConfiguredConnection

A fonte de credenciais do Git.

UpdateGitCredentialsToNoneRequest

Objeto

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

Nome Tipo Description
source string:

None

A fonte de credenciais do Git.