Workspaces - Provision Identity

Stellen Sie eine Arbeitsbereichsidentität für einen Arbeitsbereich bereit.
Diese API unterstützt LRO-.

Erlaubnisse

Der Anrufer muss über eine Administratorrolle im Arbeitsbereich verfügen.

Erforderliche delegierte Bereiche

Arbeitsbereich.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

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

Identität Unterstützung
Benutzer Ja
Service Principal und Verwaltete Identitäten Ja

Schnittstelle

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
workspaceId
path True

string (uuid)

Die ID des Arbeitsbereichs.

Antworten

Name Typ Beschreibung
200 OK

WorkspaceIdentity

Erfolgreich bereitgestellt

202 Accepted

Akzeptierte Anforderung, Identitätsbereitstellung in Bearbeitung

Header

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
429 Too Many Requests

ErrorResponse

Der Dienstratengrenzwert 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:

  • UnknownError – Ein Fehler ist aufgetreten.

Beispiele

Provision workspace identity example

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
ErrorParameter

Ein strukturierter Parameter, der zusätzlichen computerlesbaren Kontext zu einem Fehler bereitstellt.

ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.

ErrorResponse

Die Fehlerantwort.

ErrorResponseDetails

Die Fehlerantwortdetails.

ItemReferenceById

Ein Elementverweis nach ID-Objekt.

ItemReferenceByVariable

Ein Elementverweis nach Variable.

ItemReferenceType

Der Elementverweistyp. Zusätzliche ItemReferenceType Typen können im Laufe der Zeit hinzugefügt werden.

WorkspaceIdentity

Ein Arbeitsbereichsidentitätsobjekt.

ErrorParameter

Ein strukturierter Parameter, der zusätzlichen computerlesbaren Kontext zu einem Fehler bereitstellt.

Name Typ Beschreibung
message

string

Eine lesbare Beschreibung der Bedeutung des Parameters.

name

string

Die Parameterkennung.

value

string

Der übergebene Wert

ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.

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

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 lesbare Darstellung des Fehlers.

moreDetails

ErrorResponseDetails[]

Liste der zusätzlichen Fehlerdetails.

parameters

ErrorParameter[]

Strukturierte Parameter, die zusätzlichen maschinenlesbaren Kontext zu dem Fehler bereitstellen.

relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.

requestId

string (uuid)

ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

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 lesbare Darstellung des Fehlers.

parameters

ErrorParameter[]

Strukturierte Parameter, die zusätzlichen maschinenlesbaren Kontext zu dem Fehler bereitstellen.

relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.

ItemReferenceById

Ein Elementverweis nach ID-Objekt.

Name Typ Beschreibung
itemId

string (uuid)

Die ID des Elements.

referenceType string:

ById

Der Elementverweistyp.

workspaceId

string (uuid)

Die Arbeitsbereichs-ID des Elements.

ItemReferenceByVariable

Ein Elementverweis nach Variable.

Name Typ Beschreibung
referenceType string:

ByVariable

Der Elementverweistyp.

variableReference

string

Eine Variablenverweiszeichenfolge, die die Variable Library und den Variablennamen darin angibt. Format: $(/**/_VarLibrary_/_VarName_) für eine Variable Library namens VarLibrary und eine Variable namens VarName.

ItemReferenceType

Der Elementverweistyp. Zusätzliche ItemReferenceType Typen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
ById

Auf das Element wird anhand seiner ID verwiesen.

ByVariable

Auf das Element wird von einer Variablen verwiesen.

WorkspaceIdentity

Ein Arbeitsbereichsidentitätsobjekt.

Name Typ Beschreibung
applicationId

string (uuid)

Die Anwendungs-ID.

identityReference ItemReference:

Der Elementverweis für die Arbeitsbereichsidentität. Nur ItemReferenceById wird unterstützt.

servicePrincipalId

string (uuid)

Die Dienstprinzipal-ID.