Items - Update Logical Id

Dienst:

Core

API-Version:

v1

Aktualisiert die logische ID für das angegebene Element.
Die entsprechenden Elementinstanzen teilen dieselbe logische ID. Verwenden Sie diesen Vorgang, um logische ID-Konflikte zu lösen. Überprüfen Sie vor dem Ändern der logischen ID alle Automatisierungen, die auf dem aktuellen Wert basieren, und aktualisieren Sie sie nach Bedarf. Andernfalls können diese Automatisierungen das Element nicht finden oder aufgrund eines doppelten Anzeigenamens fehlschlagen. Weitere Informationen finden Sie unter Beheben von logischen ID-Konflikten in Microsoft Fabric.

Erlaubnisse

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

Erforderliche delegierte Zugriffsbereiche

Verwenden Sie für Element-APIs einen der folgenden Bereichstypen:

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

Weitere Informationen zu Bereichen finden Sie unter "Bereiche".

Limitations

• Die logische ID kann keine leere GUID (00000000-0000-0000-0000-000000000000) sein.
• Die logische ID muss innerhalb des Arbeitsbereichs eindeutig sein.
• Der Vorgang wird nicht unterstützt, während ein CI/CD-Vorgang im Arbeitsbereich aktiv ist.

Von Microsoft Entra unterstützte Identitäten

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

Identity	Support
User	Ja
Service Principal und Verwaltete Identitäten	Ja

Interface

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/logicalId

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
itemId	path	True	string (uuid)	Die Element-ID.
workspaceId	path	True	string (uuid)	Die Arbeitsbereichs-ID.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
logicalId	True	string (uuid)	Die logische ID, die für das Element aktualisiert werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	LogicalIdResponse	Der Auftrag wurde erfolgreich abgeschlossen.
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. ActiveCiCdOperationInProgress – Ein CI/CD-Vorgang ist im Arbeitsbereich aktiv.

Beispiele

Update logical ID example

Beispielanforderung

HTTP

PATCH https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/5b218778-e7a5-4d73-8187-f10824047715/logicalId

{
  "logicalId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}

Beispiel für eine Antwort

Statuscode:

200

{
  "logicalId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}

Definitionen

Name	Beschreibung
ErrorParameter	Ein strukturierter Parameter, der zusätzlichen computerlesbaren Kontext zu einem Fehler bereitstellt.
ErrorRelatedResource	Das Objekt der fehlerbezogenen Ressourcendetails.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
LogicalIdResponse	Logische ID-Antwort.
UpdateLogicalIdRequest	Aktualisieren der Nutzlast der logischen ID-Anforderung.

ErrorParameter

Objekt

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

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

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.
parameters	ErrorParameter[]	Strukturierte Parameter, die zusätzlichen maschinenlesbaren Kontext zu dem Fehler bereitstellen.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.

LogicalIdResponse

Objekt

Logische ID-Antwort.

Name	Typ	Beschreibung
logicalId	string (uuid)	Die logische ID des Elements.

UpdateLogicalIdRequest

Objekt

Aktualisieren der Nutzlast der logischen ID-Anforderung.

Name	Typ	Beschreibung
logicalId	string (uuid)	Die logische ID, die für das Element aktualisiert werden soll.