Workspaces - Provision Identity

Tjeneste:: Core

API-version:: v1

Klargør et arbejdsområdeidentitet for et arbejdsområde.
Denne API understøtter LRO-handlinger (Long Running Operations).

Tilladelser

Den, der ringer op, skal have en administratorrolle i arbejdsområ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.

Identitet	Støtte
Bruger	Ja
tjenesteprincipal og administrerede identiteter	Ja

Grænseflade

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

URI-parametre

Navn	I	Påkrævet	Type	Beskrivelse
workspaceId	path	True	string (uuid)	Id'et for arbejdsområdet.

Svar

Navn	Type	Beskrivelse
200 OK	WorkspaceIdentity	Klargjort
202 Accepted		Anmodning accepteret, klargøring af identitet er i gang Headere Location: string x-ms-operation-id: string Retry-After: integer
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: UnknownError – Der opstod en fejl.

Eksempler

Provision workspace identity example

Eksempelanmodning

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227/provisionIdentity

Eksempelsvar

Statuskode:: 200

{
  "applicationId": "00a4a8f9-78d3-41b3-b87a-6ae5271c8d0d",
  "servicePrincipalId": "5ba4ae58-d402-45c6-a848-0253e834fd78",
  "identityReference": {
    "referenceType": "ById",
    "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
    "itemId": "4a1d86e3-d740-4610-b32d-7bae87d33e9d"
  }
}

Statuskode:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 5

Definitioner

Navn	Beskrivelse
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.
ItemReferenceById	En elementreference efter id-objekt.
ItemReferenceByVariable	En elementreference efter variabel.
ItemReferenceType	Elementreferencetypen. Der kan tilføjes flere `ItemReferenceType` typer over tid.
WorkspaceIdentity	Et identitetsobjekt for arbejdsområdet.

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.

ItemReferenceById

Objekt

En elementreference efter id-objekt.

Navn	Type	Beskrivelse
itemId	string (uuid)	Id'et for elementet.
referenceType	string: ById	Elementreferencetypen.
workspaceId	string (uuid)	Elementets arbejdsområde-id.

ItemReferenceByVariable

Objekt

En elementreference efter variabel.

Navn	Type	Beskrivelse
referenceType	string: ByVariable	Elementreferencetypen.
variableReference	string	En variabelreferencestreng, der angiver variabelbiblioteket og variabelnavnet i det. Format: `$(/**/_VarLibrary_/_VarName_)` for et variabelbibliotek med navnet VarLibrary og en variabel med navnet VarName.

ItemReferenceType

Optælling

Elementreferencetypen. Der kan tilføjes flere ItemReferenceType typer over tid.

Værdi	Beskrivelse
ById	Der refereres til elementet af dets id.
ByVariable	Der refereres til elementet af en variabel.

WorkspaceIdentity

Objekt

Et identitetsobjekt for arbejdsområdet.

Navn	Type	Beskrivelse
applicationId	string (uuid)	Program-id'et.
identityReference	ItemReference: ItemReferenceById ItemReferenceByVariable	Elementreferencen for arbejdsområdeidentiteten. Kun ItemReferenceById understøttes.
servicePrincipalId	string (uuid)	Tjenesteprincipalens id.