Git - Create Workspace Relation

Service:
Core
Version d’API:
v1

Crée une relation d’espace de travail entre l’espace de travail spécifié et un espace de travail associé.

Note

Cette API fait partie d’une préversion et est fournie uniquement à des fins d’évaluation et de développement. Il peut changer en fonction des commentaires et n’est pas recommandé pour une utilisation en production.

Crée une relation de branche entre un espace de travail de branche et son espace de travail de base.

Permissions

L’appelant doit avoir un rôle d’administrateur sur l’espace de travail de branche et un rôle contributeur ou supérieur sur l’espace de travail de base.

Étendues déléguées requises

Workspace.ReadWrite.All

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identity Support
Utilisateur Oui
Service principal et identités gérées Oui

Interface

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

Paramètres URI

Nom Dans Obligatoire Type Description
workspaceId
 path True

string (uuid)

Identifiant de l’espace de travail.

Corps de la demande

Nom Obligatoire Type Description
relatedWorkspaceId True

string (uuid)

ID d’espace de travail associé.
relationType True

WorkspaceRelationType

Type de l’espace de travail associé à créer dans la relation. Uniquement Base et Branch sont valides pour la création.

Réponses

Nom Type Description
201 Created

WorkspaceRelation

Création réussie.
429 Too Many Requests

ErrorResponse

La limite de débit de service a été dépassée. Le serveur retourne un Retry-After en-tête indiquant, en secondes, combien de temps le client doit attendre avant d’envoyer des demandes supplémentaires.

En-têtes

Retry-After: integer
Other Status Codes

ErrorResponse

Codes d’erreur courants :

  • InsufficientPrivileges : l’appelant ne dispose pas des autorisations d’espace de travail suffisantes.

  • WorkspaceNotFound : l’espace de travail spécifié est introuvable.

  • WorkspaceRelationAlreadyExists : une relation entre les espaces de travail spécifiés existe déjà.

  • WorkspaceRelationBidirectionalExists : une relation entre ces espaces de travail existe déjà dans la direction opposée.

  • WorkspaceRelationInvalidArgument : arguments non valides fournis pour l’opération de relation d’espace de travail.

  • WorkspaceRelationInvalidType : type de relation d’espace de travail non valide.

  • WorkspaceRelationSelfReferencing : un espace de travail ne peut pas être lié à lui-même.

  • WorkspaceRelationBaseIsBranch : l’espace de travail de base est déjà une branche d’un autre espace de travail.

  • WorkspaceRelationTargetHasBranches : l’espace de travail cible possède déjà des espaces de travail de branche.

  • WorkspaceRelationDifferentBase : l’espace de travail cible a un autre espace de travail de base.

  • WorkspaceRelationRootDirectoryMismatch : les espaces de travail ne sont pas connectés à la même racine de référentiel Git.

Exemples

Create a workspace relation example

Exemple de requête

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

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

Exemple de réponse

Code d’état:
201 
{
  "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
  "workspaceId": "55555555-5555-5555-5555-555555555555",
  "relatedWorkspaceId": "33333333-3333-3333-3333-333333333333",
  "relationType": "Base"
}

Définitions

Nom Description
CreateWorkspaceRelationRequest

Charge utile de la requête pour la création d’une relation d’espace de travail.
ErrorRelatedResource

Objet de détails de ressource associé à l’erreur.
ErrorResponse

Réponse d’erreur.
ErrorResponseDetails

Détails de la réponse d’erreur.
WorkspaceRelation

Objet relation d’espace de travail.
WorkspaceRelationType

Type de l’espace de travail associé dans la relation. Des types d’espace de travail associés supplémentaires peuvent être ajoutés au fil du temps.

CreateWorkspaceRelationRequest

Objet

Charge utile de la requête pour la création d’une relation d’espace de travail.

Nom Type Description
relatedWorkspaceId

string (uuid)

ID d’espace de travail associé.
relationType

WorkspaceRelationType

Type de l’espace de travail associé à créer dans la relation. Uniquement Base et Branch sont valides pour la création.

ErrorRelatedResource

Objet

Objet de détails de ressource associé à l’erreur.

Nom Type Description
resourceId

string

ID de ressource impliqué dans l’erreur.
resourceType

string

Type de la ressource impliquée dans l’erreur.

ErrorResponse

Objet

Réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
isRetriable

boolean

Lorsque la valeur est true, la requête peut être retentée. Utilisez l’en-tête Retry-After de réponse pour déterminer le délai, le cas échéant.
message

string

Représentation lisible humaine de l’erreur.
moreDetails

ErrorResponseDetails[]

Liste des détails d’erreur supplémentaires.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.
requestId

string (uuid)

ID de la demande associée à l’erreur.

ErrorResponseDetails

Objet

Détails de la réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.

WorkspaceRelation

Objet

Objet relation d’espace de travail.

Nom Type Description
id

string (uuid)

ID de relation de l’espace de travail.
relatedWorkspaceId

string (uuid)

ID d’espace de travail associé.
relationType

WorkspaceRelationType

Type de l’espace de travail associé dans la relation.
workspaceId

string (uuid)

Identifiant de l’espace de travail.

WorkspaceRelationType

Énumération

Type de l’espace de travail associé dans la relation. Des types d’espace de travail associés supplémentaires peuvent être ajoutés au fil du temps.

Valeur Description
Base

L’espace de travail associé est l’espace de travail de base (source).
Branch

L’espace de travail associé est un espace de travail de branche.
RelatedWorkspace

L’espace de travail associé a une relation générale.