Freigeben über

Items - Update Item

Dienst:
Core
API-Version:
v1

Aktualisiert die Eigenschaften des angegebenen Elements.
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 Bereiche

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.

Von Microsoft Entra unterstützte Identitäten

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

Identität Unterstützen
Benutzer Ja
Dienstprinzipal 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. So werden z. B. semantische Modelle unterstützt.

Schnittstelle

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

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 Typ Beschreibung
description

string

Die Elementbeschreibung. Die maximale Länge beträgt 256 Zeichen.
displayName

string

Der Anzeigename des Elements. Der Anzeigename muss den Benennungsregeln entsprechend dem Elementtyp entsprechen.

Antworten

Name Typ Beschreibung
200 OK

Item

Die Anforderung wurde erfolgreich abgeschlossen.
Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • ItemNotFound – Das angeforderte Element wurde nicht gefunden.

  • InvalidRequest – Ungültige Updateanforderung.

Beispiele

Update an item example

Beispielanforderung

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

{
  "displayName": "Item's New name",
  "description": "Item's New description"
}

Beispiel für eine Antwort

Statuscode:
200 
{
  "displayName": "Item's New name",
  "description": "Item's New description",
  "type": "Lakehouse",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Definitionen

Name Beschreibung
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.
Item

Ein Elementobjekt.
ItemTag

Stellt ein Tag dar, das auf ein Element angewendet wird.
ItemType

Der Typ des Elements. Zusätzliche Elementtypen können im Laufe der Zeit hinzugefügt werden.
UpdateItemRequest

Elementanforderung aktualisieren.

ErrorRelatedResource

Objekt

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

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

ErrorResponseDetails[]

Liste der zusätzlichen Fehlerdetails.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.
requestId

string

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

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.

Item

Objekt

Ein Elementobjekt.

Name Typ Beschreibung
description

string

Die Elementbeschreibung.
displayName

string

Der Anzeigename des Elements.
folderId

string (uuid)

Die Ordner-ID.
id

string (uuid)

Die Element-ID.
tags

ItemTag[]

Liste der angewendeten Tags.
type

ItemType

Der Elementtyp.
workspaceId

string (uuid)

Die Arbeitsbereichs-ID.

ItemTag

Objekt

Stellt ein Tag dar, das auf ein Element angewendet wird.

Name Typ Beschreibung
displayName

string

Der Name des Tags.
id

string (uuid)

Die Tag-ID.

ItemType

Enumeration

Der Typ des Elements. Zusätzliche Elementtypen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
Dashboard

PowerBI-Dashboard.
Report

PowerBI-Bericht.
SemanticModel

PowerBI-Semantikmodell.
PaginatedReport

PowerBI-Paginated-Bericht.
Datamart

PowerBI datamart.
Lakehouse

Ein Seehaus.
Eventhouse

Ein Eventhouse.
Environment

Eine Umgebung.
KQLDatabase

Eine KQL-Datenbank.
KQLQueryset

Ein KQL-Abfrageset.
KQLDashboard

Ein KQL-Dashboard.
DataPipeline

Eine Datenpipeline.
Notebook

Ein Notizbuch.
SparkJobDefinition

Eine Sparkauftragsdefinition.
MLExperiment

Ein Machine Learning-Experiment.
MLModel

Ein Machine Learning-Modell.
Warehouse

Ein Lagerhaus.
Eventstream

Ein Ereignisstream.
SQLEndpoint

Ein SQL-Endpunkt.
MirroredWarehouse

Ein gespiegeltes Lager.
MirroredDatabase

Eine gespiegelte Datenbank.
Reflex

Ein Reflex.
GraphQLApi

Eine API für GraphQL-Element.
MountedDataFactory

Eine MountedDataFactory.
SQLDatabase

Eine SQLDatabase.
CopyJob

Ein Kopierauftrag.
VariableLibrary

Eine VariableLibrary.
Dataflow

Ein Datenfluss.
ApacheAirflowJob

Ein ApacheAirflowJob.
WarehouseSnapshot

Eine Warehouse-Momentaufnahme.
DigitalTwinBuilder

Ein DigitalTwinBuilder.
DigitalTwinBuilderFlow

Ein Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog

Ein gespiegelter Azure Databricks-Katalog.
Map

Eine Karte.
AnomalyDetector

Anomaliedetektor.
UserDataFunction

Eine Benutzerdatenfunktion.
GraphModel

Ein GraphModel.
GraphQuerySet

Ein Graph QuerySet.
SnowflakeDatabase

Eine Snowflake-Datenbank zum Speichern von Iceberg-Tabellen, die aus dem Snowflake-Konto erstellt wurden.
OperationsAgent

Ein OperationsAgent.
CosmosDBDatabase

Eine Cosmos DB-Datenbank.
Ontology

Eine Ontologie.
EventSchemaSet

Ein EventSchemaSet.

UpdateItemRequest

Objekt

Elementanforderung aktualisieren.

Name Typ Beschreibung
description

string

Die Elementbeschreibung. Die maximale Länge beträgt 256 Zeichen.
displayName

string

Der Anzeigename des Elements. Der Anzeigename muss den Benennungsregeln entsprechend dem Elementtyp entsprechen.