Workspaces - Assign To Domain

Tjeneste:
Core
API-version:
v1

Tildeler det angivne arbejdsområde til det angivne domæne.

Tilladelser

  • Den, der ringer op, skal have bidragydertilladelser eller være domæneadministrator.
  • Den, der ringer op, skal have rollen som administrator af arbejdsområdet.

Påkrævet område

Workspace.ReadWrite.All

Microsoft Entra-understøttede identiteter

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

Identitet Støtte
Bruger Ja
tjenesteprincipal og administrerede identiteter Ja

Interface

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

URI-parametre

Navn I Påkrævet Type Beskrivelse
workspaceId
 path True

string (uuid)

Arbejdsområde-id'et.

Brødtekst for anmodning

Navn Påkrævet Type Beskrivelse
domainId True

string (uuid)

Id'et for det domæne, arbejdsområdet skal tildeles til.

Svar

Navn Type Beskrivelse
200 OK

Anmodningen blev fuldført.
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:

  • DomainNotFound – Det angivne domæne blev ikke fundet

  • WorkspaceNotFound – Det angivne arbejdsområde blev ikke fundet

  • InsufficientPermissionsToDomain – Kalderen har ikke tilstrækkelige tilladelser til domænet til at udføre handlingen

  • InsufficientWorkspaceRole – Kalderen har ikke tilstrækkelige tilladelser til arbejdsområdet til at udføre handlingen

  • UnknownError – Der opstod en fejl.

Eksempler

Assign a workspace to a domain example

Eksempelanmodning

POST https://api.fabric.microsoft.com/v1/workspaces/f97451ca-d6a0-482f-a46a-cc4b2c48ba56/assignToDomain

{
  "domainId": "9d04ca81-bb30-4009-bd1a-a9213a4c8d75"
}

Eksempelsvar

Statuskode:
200

Definitioner

Navn Beskrivelse
AssignWorkspaceToDomainRequest

En anmodning om domænetildeling.
ErrorParameter

En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.
ErrorRelatedResource

Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse

Fejlsvaret.
ErrorResponseDetails

Oplysninger om fejlsvar.

AssignWorkspaceToDomainRequest

Objekt

En anmodning om domænetildeling.

Navn Type Beskrivelse
domainId

string (uuid)

Id'et for det domæne, arbejdsområdet skal tildeles til.

ErrorParameter

Objekt

En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.

Navn Type Beskrivelse
message

string

En læsevenlig beskrivelse af parameterens betydning.
name

string

Parameter-id'et.
value

string

Parameterens værdi.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Navn 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.

Navn 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.
parameters

ErrorParameter[]

Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.
relatedResource

ErrorRelatedResource

De fejlrelaterede ressourceoplysninger.
requestId

string (uuid)

Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Navn 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.
parameters

ErrorParameter[]

Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.
relatedResource

ErrorRelatedResource

De fejlrelaterede ressourceoplysninger.