Git - Create Workspace Relation

Tjeneste:
Core
API-versjon:
v1

Oppretter en arbeidsområderelasjon mellom det angitte arbeidsområdet og et relatert arbeidsområde.

Notat

Denne API-en er en del av en forhåndsversjon, og er bare tilgjengelig for evaluerings- og utviklingsformål. Det kan endres basert på tilbakemelding og anbefales ikke for produksjonsbruk.

Oppretter en forgreningsrelasjon mellom et arbeidsområde for gren og det grunnleggende arbeidsområdet.

Permissions

Innringeren må ha en administratorrolle i grenens arbeidsområde og en bidragsyter eller høyere rolle i det grunnleggende arbeidsområdet.

Nødvendige delegerte omfang

Workspace.ReadWrite.All

Microsoft Entra-støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identity Støtte
User Ja
tjenestekontohaver og administrerte identiteter Ja

Grensesnitt

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

URI-parametere

Navn I Obligatorisk Type Beskrivelse
workspaceId
 path True

string (uuid)

Arbeidsområde-ID-en.

Brødtekst for forespørsel

Navn Obligatorisk Type Beskrivelse
relatedWorkspaceId True

string (uuid)

Den relaterte arbeidsområde-ID-en.
relationType True

WorkspaceRelationType

Typen relatert arbeidsområde som skal opprettes i relasjonen. Bare Base og Branch er gyldige for oppretting.

Svar

Navn Type Beskrivelse
201 Created

WorkspaceRelation

Opprettet.
429 Too Many Requests

ErrorResponse

Grensen for tjenestesats ble overskredet. Serveren returnerer en Retry-After topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler.

Overskrifter

Retry-After: integer
Other Status Codes

ErrorResponse

Vanlige feilkoder:

  • InsufficientPrivileges – Innringeren har ikke tilstrekkelige arbeidsområdetillatelser.

  • WorkspaceNotFound – Det angitte arbeidsområdet ble ikke funnet.

  • WorkspaceRelationAlreadyExists – Det finnes allerede en relasjon mellom de angitte arbeidsområdene.

  • WorkspaceRelationBidirectionalExists – Det finnes allerede en relasjon mellom disse arbeidsområdene i motsatt retning.

  • WorkspaceRelationInvalidArgument – ugyldige argumenter for arbeidsområderelasjonsoperasjon.

  • WorkspaceRelationInvalidType – ugyldig relasjonstype for arbeidsområdet.

  • WorkspaceRelationSelfReferencing – Et arbeidsområde kan ikke være relatert til seg selv.

  • WorkspaceRelationBaseIsBranch – det grunnleggende arbeidsområdet er allerede en gren av et annet arbeidsområde.

  • WorkspaceRelationTargetHasBranches – målarbeidsområdet har allerede grenarbeidsområder.

  • WorkspaceRelationDifferentBase – målarbeidsområdet har et annet grunnleggende arbeidsområde.

  • WorkspaceRelationRootDirectoryMismatch – Arbeidsområdene er ikke koblet til samme Git-repositoriumrot.

Eksempler

Create a workspace relation example

Eksempelforespørsel

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

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

Eksempelsvar

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

Definisjoner

Navn Beskrivelse
CreateWorkspaceRelationRequest

Forespørselsnyttelasten for å opprette en arbeidsområderelasjon.
ErrorRelatedResource

Objektet for feilrelaterte ressursdetaljer.
ErrorResponse

Feilsvaret.
ErrorResponseDetails

Feilsvardetaljene.
WorkspaceRelation

Et arbeidsområderelasjonsobjekt.
WorkspaceRelationType

Typen relatert arbeidsområde i relasjonen. Flere relaterte arbeidsområdetyper kan legges til over tid.

CreateWorkspaceRelationRequest

Objekt

Forespørselsnyttelasten for å opprette en arbeidsområderelasjon.

Navn Type Beskrivelse
relatedWorkspaceId

string (uuid)

Den relaterte arbeidsområde-ID-en.
relationType

WorkspaceRelationType

Typen relatert arbeidsområde som skal opprettes i relasjonen. Bare Base og Branch er gyldige for oppretting.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Navn Type Beskrivelse
resourceId

string

Ressurs-ID-en som er involvert i feilen.
resourceType

string

Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Navn Type Beskrivelse
errorCode

string

En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
isRetriable

boolean

Når sann, kan forespørselen prøves på nytt. Retry-After Bruk svarhodet til å fastslå forsinkelsen, hvis tilgjengelig.
message

string

En menneskelig lesbar representasjon av feilen.
moreDetails

ErrorResponseDetails[]

Liste over flere feildetaljer.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.
requestId

string (uuid)

ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Navn Type Beskrivelse
errorCode

string

En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message

string

En menneskelig lesbar representasjon av feilen.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.

WorkspaceRelation

Objekt

Et arbeidsområderelasjonsobjekt.

Navn Type Beskrivelse
id

string (uuid)

Relasjons-IDen for arbeidsområdet.
relatedWorkspaceId

string (uuid)

Den relaterte arbeidsområde-ID-en.
relationType

WorkspaceRelationType

Typen relatert arbeidsområde i relasjonen.
workspaceId

string (uuid)

Arbeidsområde-ID-en.

WorkspaceRelationType

Opplisting

Typen relatert arbeidsområde i relasjonen. Flere relaterte arbeidsområdetyper kan legges til over tid.

Verdi Beskrivelse
Base

Det relaterte arbeidsområdet er det grunnleggende (kilde) arbeidsområdet.
Branch

Det relaterte arbeidsområdet er et arbeidsområde for gren.
RelatedWorkspace

Det relaterte arbeidsområdet har en generell relasjon.