Items - Associate Identity (beta)

Dienst:: Core

API-Version:: v1

Ordnet die Standardidentität einem Element zu.

Hinweis

Diese API ist Teil einer Betaversion und wird nur für Evaluierungs- und Entwicklungszwecke bereitgestellt. Sie kann sich basierend auf Feedback ändern und wird nicht für den Produktionseinsatz empfohlen. Beim Aufrufen dieser API müssen Aufrufer als Wert für den Abfrageparameter trueangebenbeta.

Diese API unterstützt LRO-.

Diese API wird für eine Reihe von Elementtypen unterstützt, finden Sie die unterstützten Elementtypen und Informationen zu ihrer Definitionsstruktur in Übersicht über die Elementverwaltung.

Erlaubnisse

Der Aufrufer muss Lese- und Schreibberechtigungen für das Element besitzen.

Erforderliche delegierte Zugriffsbereiche

Verwenden Sie für Element-APIs die folgenden Bereichstypen:

Allgemeiner Bereich: Item.ReadWrite.All
Bestimmter Bereich: itemType-. ReadWrite.All (z. B.: Notebook.ReadWrite.All)

Weitere Informationen zu Bereichen finden Sie im Artikel Bereiche.

Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft identities.

Identität	Support
Benutzer	Ja
Service Principal und Verwaltete Identitäten	Wenn der Elementtyp im Anruf unterstützt wird. Überprüfen Sie die entsprechende API für den elementtyp, den Sie aufrufen, um festzustellen, ob Ihr Aufruf unterstützt wird.

Schnittstelle

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/identities/default/assign?beta={beta}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
itemId	path	True	string (uuid)	Die Element-ID.
workspaceId	path	True	string (uuid)	Die Arbeitsbereichs-ID.
beta	query	True	boolean	Dieser erforderliche Parameter muss für den Zugriff auf diese API festgelegt `true` werden, die sich derzeit in der Betaversion befindet.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
assignmentType	True	IdentityAssignmentEntityType	Der Typ des Betreffs, der eine associaste Identitätsanforderung vorgibt.

Antworten

Name	Typ	Beschreibung
200 OK	UpdateItemIdentityResponse	Der Auftrag wurde erfolgreich abgeschlossen.
202 Accepted		Anforderung akzeptiert, Identitätszuordnung wird ausgeführt. Header Location: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Der Dienstratenlimit 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: ItemNotFound – Das angeforderte Element wurde nicht gefunden. InvalidRequest – Ungültige Zuordnungsanforderung.

Beispiele

Associate identity example

Beispielanforderung

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/5b218778-e7a5-4d73-8187-f10824047715/identities/default/assign?beta=True

{
  "assignmentType": "Caller"
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "assignmentStatus": [
    {
      "itemId": "eab1679a-8cab-40d6-9ba6-5c2a07a7ce81",
      "status": "Succeeded"
    },
    {
      "itemId": "8eedb1b0-3af8-4b17-8e7e-663e61e12211",
      "parentItemId": "eab1679a-8cab-40d6-9ba6-5c2a07a7ce81",
      "status": "Succeeded"
    },
    {
      "itemId": "83b128a3-f58f-4eee-ab0b-e7e25a748f54",
      "parentItemId": "eab1679a-8cab-40d6-9ba6-5c2a07a7ce81",
      "status": "Failed",
      "errorInfo": {
        "errorCode": "AssignmentFailed",
        "message": "The assignment operation failed due to insufficient permissions."
      }
    }
  ]
}

Statuscode:: 202

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Definitionen

Name	Beschreibung
ErrorRelatedResource	Das Objekt der fehlerbezogenen Ressourcendetails.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
IdentityAssignmentEntityType	Der Typ des Betreffs, der eine associaste Identitätsanforderung vorgibt.
IdentityAssignmentStatusType	Der Status der Identitätszuweisung. Der zusätzliche Status kann im Laufe der Zeit hinzugefügt werden.
ItemAssignmentStatus	Der Status einer Identitätszuweisung zu einem Element.
UpdateItemIdentityRequest	Identitätsanforderungsnutzlast zuordnen.
UpdateItemIdentityResponse	Identitätsantwort zuordnen.

ErrorRelatedResource

Objekt

Das Objekt der fehlerbezogenen Ressourcendetails.

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

Objekt

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.
message	string	Eine menschenlesbare Darstellung des Fehlers.
moreDetails	ErrorResponseDetails[]	Liste der zusätzlichen Fehlerdetails.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.
requestId	string (uuid)	ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

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 menschenlesbare Darstellung des Fehlers.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.

IdentityAssignmentEntityType

Enumeration

Der Typ des Betreffs, der eine associaste Identitätsanforderung vorgibt.

Wert	Beschreibung
Caller	Benutzer- oder Dienstprinzipal, der die zuordnenden Identitätsanforderung vornimmt.

IdentityAssignmentStatusType

Enumeration

Der Status der Identitätszuweisung. Der zusätzliche Status kann im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Succeeded	Die Identität wird dem Element erfolgreich zugewiesen.
Failed	Fehler bei der Identitätszuweisung.

ItemAssignmentStatus

Objekt

Der Status einer Identitätszuweisung zu einem Element.

Name	Typ	Beschreibung
errorInfo	ErrorResponseDetails	Die Fehlerinformationen, wenn die Identitätszuweisung fehlgeschlagen ist.
itemId	string (uuid)	Die ID des Elements.
parentItemId	string (uuid)	Die ID des übergeordneten Elements.
status	IdentityAssignmentStatusType	Der Status der Identitätszuweisung. Der zusätzliche Status kann im Laufe der Zeit hinzugefügt werden.

UpdateItemIdentityRequest

Objekt

Identitätsanforderungsnutzlast zuordnen.

Name	Typ	Beschreibung
assignmentType	IdentityAssignmentEntityType	Der Typ des Betreffs, der eine associaste Identitätsanforderung vorgibt.

UpdateItemIdentityResponse

Objekt

Identitätsantwort zuordnen.

Name	Typ	Beschreibung
assignmentStatus	ItemAssignmentStatus[]	Die dem Element nach der Aktualisierung zugewiesene Identität.

Freigeben über

Items - Associate Identity (beta)

Erlaubnisse

Erforderliche delegierte Zugriffsbereiche

Microsoft Entra unterstützte Identitäten

Schnittstelle

URI-Parameter

Anforderungstext

Antworten

Beispiele

Associate identity example

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

IdentityAssignmentEntityType

IdentityAssignmentStatusType

ItemAssignmentStatus

UpdateItemIdentityRequest

UpdateItemIdentityResponse