Git - Create Workspace Relation

Servizio:: Core

Versione API:: v1

Crea una relazione tra l'area di lavoro specificata e un'area di lavoro correlata.

Note

Questa API fa parte di una versione di anteprima e viene fornita solo a scopo di valutazione e sviluppo. Può cambiare in base al feedback e non è consigliato per l'uso in produzione.

Crea una relazione di diramazione tra un'area di lavoro del ramo e la relativa area di lavoro di base.

Permissions

Il chiamante deve avere un ruolo di amministratore nell'area di lavoro del ramo e un ruolo di collaboratore o superiore nell'area di lavoro di base.

Ambiti delegati obbligatori

SpazioDiLavoro.LetturaScrittura.Tutti

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identity	Support
User	Sì
Principale del servizio e Identità gestite	Sì

Interfaccia

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
workspaceId	path	True	string (uuid)	L’ID dell’area di lavoro.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
relatedWorkspaceId	True	string (uuid)	ID dell'area di lavoro correlata.
relationType	True	WorkspaceRelationType	Tipo dell'area di lavoro correlata da creare nella relazione. Solo `Base` e `Branch` sono validi per la creazione.

Risposte

Nome Tipo Descrizione

201 Created

Nome	Tipo	Descrizione
201 Created	WorkspaceRelation	Creazione completata.
429 Too Many Requests	ErrorResponse	È stato superato il limite di velocità del servizio. Il server restituisce un'intestazione `Retry-After` che indica, in secondi, per quanto tempo il client deve attendere prima di inviare richieste aggiuntive. Intestazioni Retry-After: integer
Other Status Codes	ErrorResponse	Codici di errore comuni: InsufficientPrivileges: il chiamante non dispone di autorizzazioni sufficienti per l'area di lavoro. WorkspaceNotFound: l'area di lavoro specificata non è stata trovata. WorkspaceRelationAlreadyExists: esiste già una relazione tra le aree di lavoro specificate. WorkspaceRelationBidirectionalExists: esiste già una relazione tra queste aree di lavoro nella direzione opposta. WorkspaceRelationInvalidArgument: argomenti non validi forniti per l'operazione di relazione dell'area di lavoro. WorkspaceRelationInvalidType : tipo di relazione dell'area di lavoro non valido. WorkspaceRelationSelfReferencing: un'area di lavoro non può essere correlata a se stessa. WorkspaceRelationBaseIsBranch: l'area di lavoro di base è già un ramo di un'altra area di lavoro. WorkspaceRelationTargetHasBranches: l'area di lavoro di destinazione dispone già di aree di lavoro di succursale. WorkspaceRelationDifferentBase: l'area di lavoro di destinazione ha un'area di lavoro di base diversa. WorkspaceRelationRootDirectoryMismatch: le aree di lavoro non sono connesse alla stessa radice del repository Git.

WorkspaceRelation

Creazione completata.

429 Too Many Requests

ErrorResponse

È stato superato il limite di velocità del servizio. Il server restituisce un'intestazione Retry-After che indica, in secondi, per quanto tempo il client deve attendere prima di inviare richieste aggiuntive.

Intestazioni

Retry-After: integer

Other Status Codes

ErrorResponse

Codici di errore comuni:

InsufficientPrivileges: il chiamante non dispone di autorizzazioni sufficienti per l'area di lavoro.
WorkspaceNotFound: l'area di lavoro specificata non è stata trovata.
WorkspaceRelationAlreadyExists: esiste già una relazione tra le aree di lavoro specificate.
WorkspaceRelationBidirectionalExists: esiste già una relazione tra queste aree di lavoro nella direzione opposta.
WorkspaceRelationInvalidArgument: argomenti non validi forniti per l'operazione di relazione dell'area di lavoro.
WorkspaceRelationInvalidType : tipo di relazione dell'area di lavoro non valido.
WorkspaceRelationSelfReferencing: un'area di lavoro non può essere correlata a se stessa.
WorkspaceRelationBaseIsBranch: l'area di lavoro di base è già un ramo di un'altra area di lavoro.
WorkspaceRelationTargetHasBranches: l'area di lavoro di destinazione dispone già di aree di lavoro di succursale.
WorkspaceRelationDifferentBase: l'area di lavoro di destinazione ha un'area di lavoro di base diversa.
WorkspaceRelationRootDirectoryMismatch: le aree di lavoro non sono connesse alla stessa radice del repository Git.

Esempio

Create a workspace relation example

Esempio di richiesta

HTTP

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

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

Risposta di esempio

Codice di stato:: 201

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

Definizioni

Nome	Descrizione
CreateWorkspaceRelationRequest	Payload della richiesta per la creazione di una relazione dell'area di lavoro.
ErrorRelatedResource	Oggetto dei dettagli della risorsa relativo all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
WorkspaceRelation	Oggetto relazione dell'area di lavoro.
WorkspaceRelationType	Tipo dell'area di lavoro correlata nella relazione. È possibile aggiungere altri tipi di area di lavoro correlati nel tempo.

CreateWorkspaceRelationRequest

Oggetto

Payload della richiesta per la creazione di una relazione dell'area di lavoro.

Nome	Tipo	Descrizione
relatedWorkspaceId	string (uuid)	ID dell'area di lavoro correlata.
relationType	WorkspaceRelationType	Tipo dell'area di lavoro correlata da creare nella relazione. Solo `Base` e `Branch` sono validi per la creazione.

ErrorRelatedResource

Oggetto

Oggetto dei dettagli della risorsa relativo all'errore.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa coinvolto nell'errore.
resourceType	string	Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Oggetto

Risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
isRetriable	boolean	Se true, la richiesta può essere ritentata. Usare l'intestazione della `Retry-After` risposta per determinare il ritardo, se disponibile.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.
requestId	string (uuid)	ID della richiesta associata all'errore.

ErrorResponseDetails

Oggetto

Dettagli della risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.

WorkspaceRelation

Oggetto

Oggetto relazione dell'area di lavoro.

Nome	Tipo	Descrizione
id	string (uuid)	ID relazione dell'area di lavoro.
relatedWorkspaceId	string (uuid)	ID dell'area di lavoro correlata.
relationType	WorkspaceRelationType	Tipo dell'area di lavoro correlata nella relazione.
workspaceId	string (uuid)	L’ID dell’area di lavoro.

WorkspaceRelationType

Enumerazione

Tipo dell'area di lavoro correlata nella relazione. È possibile aggiungere altri tipi di area di lavoro correlati nel tempo.

Valore	Descrizione
Base	L'area di lavoro correlata è l'area di lavoro di base (origine).
Branch	L'area di lavoro correlata è un'area di lavoro del ramo.
RelatedWorkspace	L'area di lavoro correlata ha una relazione generale.