Git - Create Workspace Relation

Dienst:
Core
API-Version:
v1

Erstellt eine Arbeitsbereichsbeziehung zwischen dem angegebenen Arbeitsbereich und einem verwandten Arbeitsbereich.

Note

Diese API ist Teil einer Preview-Version und wird nur für Evaluierungs- und Entwicklungszwecke bereitgestellt. Sie kann sich basierend auf Feedback ändern und wird nicht für den Produktionseinsatz empfohlen.

Erstellt eine Verzweigungsbeziehung zwischen einem Verzweigungsarbeitsbereich und seinem Basisarbeitsbereich.

Erlaubnisse

Der Anrufer muss über eine Administratorrolle im Zweigarbeitsbereich und einen Mitwirkenden oder eine höhere Rolle im Basisarbeitsbereich verfügen.

Erforderliche delegierte Zugriffsbereiche

Arbeitsbereich.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identity Support
Benutzer Ja
Service Principal und Verwaltete Identitäten Ja

Interface

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
workspaceId
 path True

string (uuid)

Die Arbeitsbereichs-ID.

Anforderungstext

Name Erforderlich Typ Beschreibung
relatedWorkspaceId True

string (uuid)

Die zugehörige Arbeitsbereichs-ID.
relationType True

WorkspaceRelationType

Der Typ des verknüpften Arbeitsbereichs, der in der Beziehung erstellt werden soll. Nur Base und Branch sind für die Erstellung gültig.

Antworten

Name Typ Beschreibung
201 Created

WorkspaceRelation

Erfolgreich erstellt.
429 Too Many Requests

ErrorResponse

Der Dienstratenlimit wurde überschritten. Der Server gibt einen Retry-After Header zurück, der in Sekunden angibt, wie lange der Client warten muss, bevor zusätzliche Anforderungen gesendet werden.

Header

Retry-After: integer
Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • InsufficientPrivileges – Der Aufrufer verfügt nicht über ausreichende Arbeitsbereichsberechtigungen.

  • WorkspaceNotFound – Der angegebene Arbeitsbereich wurde nicht gefunden.

  • WorkspaceRelationAlreadyExists – Eine Beziehung zwischen den angegebenen Arbeitsbereichen ist bereits vorhanden.

  • WorkspaceRelationBidirectionalExists – Eine Beziehung zwischen diesen Arbeitsbereichen ist bereits in entgegengesetzter Richtung vorhanden.

  • WorkspaceRelationInvalidArgument – Ungültige Argumente, die für den Arbeitsbereichsbeziehungsvorgang bereitgestellt werden.

  • WorkspaceRelationInvalidType – Ungültiger Arbeitsbereichsbeziehungstyp.

  • WorkspaceRelationSelfReferencing – Ein Arbeitsbereich kann nicht mit sich selbst verknüpft werden.

  • WorkspaceRelationBaseIsBranch – Der Basisarbeitsbereich ist bereits eine Verzweigung eines anderen Arbeitsbereichs.

  • WorkspaceRelationTargetHasBranches – Der Zielarbeitsbereich verfügt bereits über Zweigarbeitsbereiche.

  • WorkspaceRelationDifferentBase – Der Zielarbeitsbereich weist einen anderen Basisarbeitsbereich auf.

  • WorkspaceRelationRootDirectoryMismatch – Die Arbeitsbereiche sind nicht mit demselben Git-Repositorystamm verbunden.

Beispiele

Create a workspace relation example

Beispielanforderung

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

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
CreateWorkspaceRelationRequest

Die Anforderungsnutzlast zum Erstellen einer Arbeitsbereichsbeziehung.
ErrorRelatedResource

Das Objekt der fehlerbezogenen Ressourcendetails.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.
WorkspaceRelation

Ein Arbeitsbereichsbeziehungsobjekt.
WorkspaceRelationType

Der Typ des verknüpften Arbeitsbereichs in der Beziehung. Weitere verwandte Arbeitsbereichstypen können im Laufe der Zeit hinzugefügt werden.

CreateWorkspaceRelationRequest

Objekt

Die Anforderungsnutzlast zum Erstellen einer Arbeitsbereichsbeziehung.

Name Typ Beschreibung
relatedWorkspaceId

string (uuid)

Die zugehörige Arbeitsbereichs-ID.
relationType

WorkspaceRelationType

Der Typ des verknüpften Arbeitsbereichs, der in der Beziehung erstellt werden soll. Nur Base und Branch sind für die Erstellung gültig.

ErrorRelatedResource

Objekt

Das Objekt der fehlerbezogenen Ressourcendetails.

Name Typ Beschreibung
resourceId

string

Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType

string

Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
isRetriable

boolean

Wenn true, kann die Anforderung wiederholt werden. Verwenden Sie den Retry-After Antwortheader, um die Verzögerung zu ermitteln, falls verfügbar.
message

string

Eine menschenlesbare Darstellung des Fehlers.
moreDetails

ErrorResponseDetails[]

Liste der zusätzlichen Fehlerdetails.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.
requestId

string (uuid)

ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine menschenlesbare Darstellung des Fehlers.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.

WorkspaceRelation

Objekt

Ein Arbeitsbereichsbeziehungsobjekt.

Name Typ Beschreibung
id

string (uuid)

Die Arbeitsbereichsbeziehungs-ID.
relatedWorkspaceId

string (uuid)

Die zugehörige Arbeitsbereichs-ID.
relationType

WorkspaceRelationType

Der Typ des verknüpften Arbeitsbereichs in der Beziehung.
workspaceId

string (uuid)

Die Arbeitsbereichs-ID.

WorkspaceRelationType

Enumeration

Der Typ des verknüpften Arbeitsbereichs in der Beziehung. Weitere verwandte Arbeitsbereichstypen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
Base

Der zugehörige Arbeitsbereich ist der Basisarbeitsbereich (Quellarbeitsbereich).
Branch

Der zugehörige Arbeitsbereich ist ein Verzweigungsarbeitsbereich.
RelatedWorkspace

Der zugehörige Arbeitsbereich hat eine allgemeine Beziehung.