Git - Create Workspace Relation

Serviço:

Core

Versão da API:

v1

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

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.

Cria uma relação de ramificação entre um espaço de trabalho ramal e o seu espaço de trabalho base.

Permissions

O chamador deve ter um papel de administrador no espaço de trabalho da filial e um cargo de contribuidor ou superior no espaço de trabalho base.

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	Suporte
User	Sim
Entidade de serviço e identidades geridas	Sim

Interface

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

Parâmetros do URI

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

Corpo do Pedido

Name	Obrigatório	Tipo	Descrição
relatedWorkspaceId	True	string (uuid)	O ID do espaço de trabalho relacionado.
relationType	True	WorkspaceRelationType	O tipo do espaço de trabalho relacionado a criar na relação. Apenas Base e Branch são válidos para criação.

Respostas

Name	Tipo	Descrição
201 Created	WorkspaceRelation	Criado 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: InsufficientPrivileges - O chamador não tem permissões de espaço de trabalho suficientes. WorkspaceNotFound - O espaço de trabalho especificado não foi encontrado. WorkspaceRelationAlreadyExists - Já existe uma relação entre os espaços de trabalho especificados. Relação do Espaço de TrabalhoBidirecionalExiste - Uma relação entre estes espaços de trabalho já existe na direção oposta. WorkspaceRelationshipInvalidArgument - Argumentos inválidos fornecidos para a operação da relação workspace. WorkspaceRelationshipInvalidType - Tipo de relação de workspace inválido. WorkspaceRelationshipSelfReferencing - Um espaço de trabalho não pode ser relacionado consigo próprio. WorkspaceRelationshipBaseIsBranch - O workspace base já é um ramo de outro workspace. WorkspaceRelationshipTargetHasBranches - O workspace alvo já tem espaços de trabalho de ramos. WorkspaceRelationshipDifferentBase - O espaço de trabalho alvo tem um espaço de trabalho base diferente. Espaço de TrabalhoRelacionamentoRootDirectoryMismatch - Os espaços de trabalho não estão ligados à mesma raiz do repositório Git.

Exemplos

Create a workspace relation example

Pedido de amostra

HTTP

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

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

Resposta da amostra

Código de estado:

201

{
  "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
  "workspaceId": "55555555-5555-5555-5555-555555555555",
  "relatedWorkspaceId": "33333333-3333-3333-3333-333333333333",
  "relationType": "Base"
}

Definições

Name	Descrição
CreateWorkspaceRelationRequest	O payload de pedido para criar uma relação de espaço de trabalho.
ErrorRelatedResource	Os detalhes do objeto de recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes do erro na resposta.
WorkspaceRelation	Um objeto de relação de espaço de trabalho.
WorkspaceRelationType	O tipo do espaço de trabalho relacionado na relação. Tipos adicionais de espaços de trabalho relacionados podem ser adicionados ao longo do tempo.

CreateWorkspaceRelationRequest

Object

O payload de pedido para criar uma relação de espaço de trabalho.

Name	Tipo	Descrição
relatedWorkspaceId	string (uuid)	O ID do espaço de trabalho relacionado.
relationType	WorkspaceRelationType	O tipo do espaço de trabalho relacionado a criar na relação. Apenas Base e Branch são válidos para criação.

ErrorRelatedResource

Object

Os detalhes do objeto de recurso relacionado ao erro.

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

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

Name	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.
relatedResource	ErrorRelatedResource	Detalhes do recurso relacionado ao erro.

WorkspaceRelation

Object

Um objeto de relação de espaço de trabalho.

Name	Tipo	Descrição
id	string (uuid)	O ID de relação do espaço de trabalho.
relatedWorkspaceId	string (uuid)	O ID do espaço de trabalho relacionado.
relationType	WorkspaceRelationType	O tipo do espaço de trabalho relacionado na relação.
workspaceId	string (uuid)	O ID do espaço de trabalho.

WorkspaceRelationType

Enumeração

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

Valor	Descrição
Base	O espaço de trabalho relacionado é o espaço de trabalho base (fonte).
Branch	O espaço de trabalho relacionado é um espaço de trabalho ramificado.
RelatedWorkspace	O espaço de trabalho relacionado tem uma relação geral.