Git - Update Connection Settings

Serviço:

Core

Versão da API:

v1

Note

Esta API faz parte de uma versão de pré-visualização e é fornecida apenas para fins de avaliação e desenvolvimento. Ele pode mudar com base no feedback e não é recomendado para uso em produção. Mais informações.

Atualiza as definições de ligação para um espaço de trabalho ligado ao Git. Apenas as propriedades incluídas no corpo do pedido são atualizadas; as propriedades omitidas permanecem inalteradas.

Permissions

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

Escopos delegados necessários

Workspace.ReadWrite.All

Identidades suportadas pelo Entra da Microsoft

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

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

Interface

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

Parâmetros do URI

Nome	Em	Obrigatório	Tipo	Descrição
workspaceId	path	True	string (uuid)	O ID do espaço de trabalho.

Corpo do Pedido

Nome	Tipo	Descrição
additionalRolesAuthorizedToChangeBranch	GitAdditionalBranchChangingRoles	Os papéis adicionais do workspace para além de administrador que podem alterar o branch Git ligado.

Respostas

Nome	Tipo	Descrição
200 OK	GitConnectionSettings	Pedido concluído com sucesso.
429 Too Many Requests	ErrorResponse	O limite de tarifa de serviço foi ultrapassado. O servidor devolve um Retry-After cabeçalho que indica, em segundos, quanto tempo o cliente deve esperar antes de enviar pedidos adicionais. Cabeçalhos Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de erro comuns: UnknownError - Ocorreu um erro. InsufficientPrivileges - O chamador não tem um papel de administrador para o espaço de trabalho. WorkspaceNotConnectedToGit - O espaço de trabalho não está conectado ao git.

Exemplos

Update connection settings example

Pedido de amostra

HTTP

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

{
  "additionalRolesAuthorizedToChangeBranch": "MemberAndContributor"
}

Resposta da amostra

Código de estado:

200

{
  "additionalRolesAuthorizedToChangeBranch": "MemberAndContributor"
}

Definições

Nome	Descrição
ErrorParameter	Um parâmetro estruturado que fornece contexto adicional legível por máquina sobre um erro.
ErrorRelatedResource	Os detalhes do objeto de recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes do erro na resposta.
GitAdditionalBranchChangingRoles	Os papéis adicionais do workspace para além de administrador que podem alterar o branch Git ligado. Podem ser adicionados valores adicionais ao longo do tempo.
GitConnectionSettings	Contém as definições de ligação Git.
UpdateGitConnectionSettingsRequest	Contém os dados do pedido para atualizar as definições de ligação Git.

ErrorParameter

Object

Um parâmetro estruturado que fornece contexto adicional legível por máquina sobre um erro.

Nome	Tipo	Descrição
message	string	Uma descrição legível para humanos do significado do parâmetro.
name	string	O identificador de parâmetro.
value	string	O valor do parâmetro.

ErrorRelatedResource

Object

Os detalhes do objeto de recurso relacionado ao erro.

Nome	Tipo	Descrição
resourceId	string	O ID do recurso envolvido no erro.
resourceType	string	O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Nome	Tipo	Descrição
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.
isRetriable	boolean	Quando confirmado, o pedido pode ser retentado. Use o Retry-After cabeçalho de resposta para determinar o atraso, se disponível.
message	string	Uma representação legível por humanos do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
parameters	ErrorParameter[]	Parâmetros estruturados que fornecem contexto adicional legível pela máquina sobre o erro.
relatedResource	ErrorRelatedResource	Detalhes do recurso relacionado ao erro.
requestId	string (uuid)	ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes do erro na resposta.

Nome	Tipo	Descrição
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.
parameters	ErrorParameter[]	Parâmetros estruturados que fornecem contexto adicional legível pela máquina sobre o erro.
relatedResource	ErrorRelatedResource	Detalhes do recurso relacionado ao erro.

GitAdditionalBranchChangingRoles

Enumeração

Os papéis adicionais do workspace para além de administrador que podem alterar o branch Git ligado. Podem ser adicionados valores adicionais ao longo do tempo.

Valor	Descrição
None	Nenhum cargo adicional além da administração pode mudar de filial. Este é o padrão.
MemberAndContributor	Membros e colaboradores também podem mudar de ramo para além dos administradores.

GitConnectionSettings

Object

Contém as definições de ligação Git.

Nome	Tipo	Descrição
additionalRolesAuthorizedToChangeBranch	GitAdditionalBranchChangingRoles	Os papéis adicionais do workspace para além de administrador que podem alterar o branch Git ligado.

UpdateGitConnectionSettingsRequest

Object

Contém os dados do pedido para atualizar as definições de ligação Git.

Nome	Tipo	Descrição
additionalRolesAuthorizedToChangeBranch	GitAdditionalBranchChangingRoles	Os papéis adicionais do workspace para além de administrador que podem alterar o branch Git ligado.