Git - Create Workspace Relation

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

Cria uma relação de workspace entre o workspace especificado e um workspace relacionado.

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.

Cria uma relação de ramificação entre um workspace de branch e seu workspace base.

Permissões

O chamador deve ter uma função de administrador no workspace do branch e um colaborador ou uma função superior no workspace base.

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 Suporte
Usuário Sim
Entidade de serviço e identidades gerenciadas Sim

Interface

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

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 Obrigatório Tipo Description
relatedWorkspaceId True

string (uuid)

A ID do workspace relacionado.
relationType True

WorkspaceRelationType

O tipo do workspace relacionado a ser criado na relação. Somente Base e Branch são válidos para criação.

Respostas

Nome Tipo Description
201 Created

WorkspaceRelation

Criado 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:

  • InsufficientPrivileges - O chamador não tem permissões de workspace suficientes.

  • WorkspaceNotFound – O workspace especificado não foi encontrado.

  • WorkspaceRelationAlreadyExists – já existe uma relação entre os workspaces especificados.

  • WorkspaceRelationBidirectionalExists – uma relação entre esses workspaces já existe na direção oposta.

  • WorkspaceRelationInvalidArgument - Argumentos inválidos fornecidos para a operação de relação do workspace.

  • WorkspaceRelationInvalidType – tipo de relação de workspace inválido.

  • WorkspaceRelationSelfReferencing – Um workspace não pode estar relacionado a si mesmo.

  • WorkspaceRelationBaseIsBranch – O workspace base já é um branch de outro workspace.

  • WorkspaceRelationTargetHasBranches – O workspace de destino já tem workspaces de branch.

  • WorkspaceRelationDifferentBase – O workspace de destino tem um workspace base diferente.

  • WorkspaceRelationRootDirectoryMismatch – os workspaces não estão conectados à mesma raiz do repositório Git.

Exemplos

Create a workspace relation example

Solicitação de exemplo

POST https://api.fabric.microsoft.com/v1/workspaces/55555555-5555-5555-5555-555555555555/git/workspaceRelations

{
  "relatedWorkspaceId": "33333333-3333-3333-3333-333333333333",
  "relationType": "Base"
}

Resposta de exemplo

Código de status:
201 
{
  "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
  "workspaceId": "55555555-5555-5555-5555-555555555555",
  "relatedWorkspaceId": "33333333-3333-3333-3333-333333333333",
  "relationType": "Base"
}

Definições

Nome Description
CreateWorkspaceRelationRequest

O conteúdo da solicitação para criar uma relação de workspace.
ErrorRelatedResource

O objeto relacionado ao erro nos detalhes do recurso.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
WorkspaceRelation

Um objeto de relação de workspace.
WorkspaceRelationType

O tipo do workspace relacionado na relação. Tipos de workspace relacionados adicionais podem ser adicionados ao longo do tempo.

CreateWorkspaceRelationRequest

Objeto

O conteúdo da solicitação para criar uma relação de workspace.

Nome Tipo Description
relatedWorkspaceId

string (uuid)

A ID do workspace relacionado.
relationType

WorkspaceRelationType

O tipo do workspace relacionado a ser criado na relação. Somente Base e Branch são válidos para criação.

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

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.

WorkspaceRelation

Objeto

Um objeto de relação de workspace.

Nome Tipo Description
id

string (uuid)

A ID da relação do workspace.
relatedWorkspaceId

string (uuid)

A ID do workspace relacionado.
relationType

WorkspaceRelationType

O tipo do workspace relacionado na relação.
workspaceId

string (uuid)

O identificador do espaço de trabalho.

WorkspaceRelationType

Enumeração

O tipo do workspace relacionado na relação. Tipos de workspace relacionados adicionais podem ser adicionados ao longo do tempo.

Valor Description
Base

O workspace relacionado é o workspace base (origem).
Branch

O workspace relacionado é um workspace de branch.
RelatedWorkspace

O workspace relacionado tem uma relação geral.