Git - Create Workspace Relation

Tjeneste:

Core

API-version:

v1

Opretter en arbejdsområderelation mellem det angivne arbejdsområde og et relateret arbejdsområde.

Bemærk

Denne API er en del af en prøveversion og leveres kun til evaluerings- og udviklingsformål. Det kan ændre sig baseret på feedback og anbefales ikke til produktionsbrug.

Opretter en forgreningsrelation mellem et forgreningsarbejdsområde og dets basisarbejdsområde.

Permissions

Den, der ringer op, skal have en administratorrolle i forgreningsarbejdsområdet og en bidragyder eller en højere rolle i basisarbejdsområdet.

Påkrævede delegerede områder

Workspace.ReadWrite.All

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Id	Støtte
User	Ja
tjenesteprincipal og administrerede identiteter	Ja

Grænseflade

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

URI-parametre

Name	I	Påkrævet	Type	Beskrivelse
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.

Brødtekst for anmodning

Name	Påkrævet	Type	Beskrivelse
relatedWorkspaceId	True	string (uuid)	Det relaterede arbejdsområde-id.
relationType	True	WorkspaceRelationType	Typen af det relaterede arbejdsområde, der skal oprettes i relationen. Kun Base og Branch er gyldige til oprettelse.

Svar

Name	Type	Beskrivelse
201 Created	WorkspaceRelation	Oprettet.
429 Too Many Requests	ErrorResponse	Grænsen for tjenestetakst blev overskredet. Serveren returnerer en Retry-After header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger. Headere Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: InsufficientPrivileges – Den kaldende bruger har ikke tilstrækkelige tilladelser til arbejdsområdet. WorkspaceNotFound – Det angivne arbejdsområde blev ikke fundet. WorkspaceRelationAlreadyExists – Der findes allerede en relation mellem de angivne arbejdsområder. WorkspaceRelationBidirectionalExists – Der findes allerede en relation mellem disse arbejdsområder i den modsatte retning. WorkspaceRelationInvalidArgument – Der er angivet ugyldige argumenter for relationshandlingen for arbejdsområdet. WorkspaceRelationInvalidType – Ugyldig type af arbejdsområderelation. WorkspaceRelationSelfReferencing – Et arbejdsområde kan ikke relatere til sig selv. WorkspaceRelationBaseIsBranch – Basisarbejdsområdet er allerede en gren af et andet arbejdsområde. WorkspaceRelationTargetHasBranches – Destinationsarbejdsområdet har allerede forgreningsarbejdsområder. WorkspaceRelationDifferentBase – Destinationsarbejdsområdet har et andet basisarbejdsområde. WorkspaceRelationRootDirectoryMismatch – Arbejdsområderne er ikke forbundet til den samme Git-lagerrod.

Eksempler

Create a workspace relation example

Eksempelanmodning

HTTP

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"
}

Definitioner

Name	Beskrivelse
CreateWorkspaceRelationRequest	Nyttedata for anmodning om oprettelse af en arbejdsområderelation.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
WorkspaceRelation	Et objekt til arbejdsområderelation.
WorkspaceRelationType	Typen af det relaterede arbejdsområde i relationen. Der kan tilføjes flere relaterede arbejdsområdetyper over tid.

CreateWorkspaceRelationRequest

Objekt

Nyttedata for anmodning om oprettelse af en arbejdsområderelation.

Name	Type	Beskrivelse
relatedWorkspaceId	string (uuid)	Det relaterede arbejdsområde-id.
relationType	WorkspaceRelationType	Typen af det relaterede arbejdsområde, der skal oprettes i relationen. Kun Base og Branch er gyldige til oprettelse.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Name	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
isRetriable	boolean	Når sand, kan anmodningen prøves igen. Brug svarheaderen Retry-After til at bestemme forsinkelsen, hvis den er tilgængelig.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

WorkspaceRelation

Objekt

Et objekt til arbejdsområderelation.

Name	Type	Beskrivelse
id	string (uuid)	Relations-id'et for arbejdsområdet.
relatedWorkspaceId	string (uuid)	Det relaterede arbejdsområde-id.
relationType	WorkspaceRelationType	Typen af det relaterede arbejdsområde i relationen.
workspaceId	string (uuid)	Arbejdsområde-id'et.

WorkspaceRelationType

Optælling

Typen af det relaterede arbejdsområde i relationen. Der kan tilføjes flere relaterede arbejdsområdetyper over tid.

Værdi	Beskrivelse
Base	Det relaterede arbejdsområde er basisarbejdsområdet (kildearbejdsområdet).
Branch	Det relaterede arbejdsområde er et forgreningsarbejdsområde.
RelatedWorkspace	Det relaterede arbejdsområde har en generel relation.