Git - Update Connection Settings

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

Note

Essa API faz parte de uma versão prévia e é fornecida apenas para fins de avaliação e desenvolvimento. Ele pode mudar com base nos comentários e não é recomendado para uso em produção. Saiba mais.

Atualiza as configurações de conexão para um workspace conectado ao Git. Somente as propriedades incluídas no corpo da solicitação são atualizadas; as propriedades omitidas permanecem inalteradas.

Permissions

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

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

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

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
additionalRolesAuthorizedToChangeBranch

GitAdditionalBranchChangingRoles

As funções de workspace adicionais além do administrador que têm permissão para alterar o branch do Git conectado.

Respostas

Nome Tipo Description
200 OK

GitConnectionSettings

Solicitação concluída com êxito.
429 Too Many Requests

ErrorResponse

O limite de taxa de serviço foi excedido. O servidor retorna um Retry-After cabeçalho indicando, em segundos, quanto tempo o cliente deve aguardar antes de enviar solicitações 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 uma função de administrador para o workspace.

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

Exemplos

Update connection settings example

Solicitação de exemplo

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

{
  "additionalRolesAuthorizedToChangeBranch": "MemberAndContributor"
}

Resposta de exemplo

Código de status:
200 
{
  "additionalRolesAuthorizedToChangeBranch": "MemberAndContributor"
}

Definições

Nome Description
ErrorParameter

Um parâmetro estruturado que fornece contexto legível por computador adicional sobre um erro.
ErrorRelatedResource

O objeto relacionado ao erro nos detalhes do recurso.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
GitAdditionalBranchChangingRoles

As funções de workspace adicionais além do administrador que têm permissão para alterar o branch do Git conectado. Valores adicionais podem ser adicionados ao longo do tempo.
GitConnectionSettings

Contém as configurações de conexão do Git.
UpdateGitConnectionSettingsRequest

Contém os dados de solicitação para atualizar as configurações de conexão do Git.

ErrorParameter

Objeto

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

Nome Tipo Description
message

string

Uma descrição legível pelo ser humano do significado do parâmetro.
name

string

O identificador de parâmetro.
value

string

O valor do parâmetro.

ErrorRelatedResource

Objeto

O objeto relacionado ao erro nos detalhes do recurso.

Nome Tipo Description
resourceId

string

O identificador do recurso envolvido 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.
isRetriable

boolean

Quando true, a solicitação pode ser repetida. Use o Retry-After cabeçalho de resposta para determinar o atraso, se disponível.
message

string

Uma representação legível humana do erro.
moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
parameters

ErrorParameter[]

Parâmetros estruturados que fornecem contexto legível por computador adicional sobre o erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.
requestId

string (uuid)

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

ErrorParameter[]

Parâmetros estruturados que fornecem contexto legível por computador adicional sobre o erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.

GitAdditionalBranchChangingRoles

Enumeração

As funções de workspace adicionais além do administrador que têm permissão para alterar o branch do Git conectado. Valores adicionais podem ser adicionados ao longo do tempo.

Valor Description
None

Nenhuma função adicional além do administrador pode alterar branches. Este é o padrão.
MemberAndContributor

Membros e colaboradores também podem alterar branches, além de administradores.

GitConnectionSettings

Objeto

Contém as configurações de conexão do Git.

Nome Tipo Description
additionalRolesAuthorizedToChangeBranch

GitAdditionalBranchChangingRoles

As funções de workspace adicionais além do administrador que têm permissão para alterar o branch do Git conectado.

UpdateGitConnectionSettingsRequest

Objeto

Contém os dados de solicitação para atualizar as configurações de conexão do Git.

Nome Tipo Description
additionalRolesAuthorizedToChangeBranch

GitAdditionalBranchChangingRoles

As funções de workspace adicionais além do administrador que têm permissão para alterar o branch do Git conectado.