Freigeben über

Items - Update Lakehouse

  • Referenz
Dienst:
Lakehouse
API-Version:
v1

Aktualisiert die Eigenschaften des angegebenen Seehauses.

Erlaubnisse

Der Anrufer muss Mitwirkender oder höherer Arbeitsbereichsrolle haben.

Erforderliche delegierte Bereiche

Lakehouse.ReadWrite.All oder Item.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ützen
Benutzer Ja
Dienstprinzipal und verwaltete Identitäten Ja

Schnittstelle

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/lakehouses/{lakehouseId}

URI-Parameter

Name In Erforderlich Typ Beschreibung
lakehouseId
 path True

string

uuid

Die Seehaus-ID.
workspaceId
 path True

string

uuid

Die Arbeitsbereichs-ID.

Anforderungstext

Name Typ Beschreibung
description

string

Die Beschreibung des Seehauses. Die maximale Länge beträgt 256 Zeichen.
displayName

string

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

Antworten

Name Typ Beschreibung
200 OK

Lakehouse

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 a lakehouse example

Beispielanforderung

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

{
  "displayName": "Lakehouse_New_Name",
  "description": "A new description for lakehouse."
}

Beispiel für eine Antwort

Statuscode:
200 
{
  "displayName": "Lakehouse_New_Name",
  "description": "A new description for lakehouse.",
  "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.
ItemType

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

Ein Seehauselement.
LakehouseProperties

Die Seehauseigenschaften.
SqlEndpointProperties

Ein Objekt, das die Eigenschaften des SQL-Endpunkts enthält.
SqlEndpointProvisioningStatus

Der SQL-Endpunktbereitstellungsstatustyp. Zusätzliche SqlEndpointProvisioningStatus Typen können im Laufe der Zeit hinzugefügt werden.
UpdateLakehouseRequest

Aktualisieren sie die Lakehouse-Anforderung.

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.

ItemType

Enumeration

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

Wert Beschreibung
Dashboard

PowerBI-Dashboard.
DataPipeline

Eine Datenpipeline.
Datamart

PowerBI datamart.
Environment

Eine Umgebung.
Eventhouse

Ein Eventhouse.
Eventstream

Ein Ereignisstream.
GraphQLApi

Eine API für GraphQL-Element.
KQLDashboard

Ein KQL-Dashboard.
KQLDatabase

Eine KQL-Datenbank.
KQLQueryset

Ein KQL-Abfrageset.
Lakehouse

Ein Seehaus.
MLExperiment

Ein Machine Learning-Experiment.
MLModel

Ein Machine Learning-Modell.
MirroredDatabase

Eine gespiegelte Datenbank.
MirroredWarehouse

Ein gespiegeltes Lager.
MountedDataFactory

Eine MountedDataFactory.
Notebook

Ein Notizbuch.
PaginatedReport

PowerBI-Paginated-Bericht.
Reflex

Ein Reflex.
Report

PowerBI-Bericht.
SQLDatabase

Eine SQLDatabase.
SQLEndpoint

Ein SQL-Endpunkt.
SemanticModel

PowerBI-Semantikmodell.
SparkJobDefinition

Eine Sparkauftragsdefinition.
Warehouse

Ein Lagerhaus.

Lakehouse

Objekt

Ein Seehauselement.

Name Typ Beschreibung
description

string

Die Elementbeschreibung.
displayName

string

Der Anzeigename des Elements.
id

string

uuid

Die Element-ID.
properties

LakehouseProperties

Die Seehauseigenschaften.
type

ItemType

Der Elementtyp.
workspaceId

string

uuid

Die Arbeitsbereichs-ID.

LakehouseProperties

Objekt

Die Seehauseigenschaften.

Name Typ Beschreibung
defaultSchema

string

Standardschema des Seehauses. Diese Eigenschaft wird nur für schemafähiges Lakehouse zurückgegeben.
oneLakeFilesPath

string

OneLake-Pfad zum Verzeichnis der Lakehouse-Dateien.
oneLakeTablesPath

string

OneLake-Pfad zum Verzeichnis der Lakehouse-Tabellen.
sqlEndpointProperties

SqlEndpointProperties

Ein Objekt, das die Eigenschaften des SQL-Endpunkts enthält.

SqlEndpointProperties

Objekt

Ein Objekt, das die Eigenschaften des SQL-Endpunkts enthält.

Name Typ Beschreibung
connectionString

string

SQL-Endpunktverbindungszeichenfolge.
id

string

SQL-Endpunkt-ID.
provisioningStatus

SqlEndpointProvisioningStatus

Der Bereitstellungsstatus des SQL-Endpunkts.

SqlEndpointProvisioningStatus

Enumeration

Der SQL-Endpunktbereitstellungsstatustyp. Zusätzliche SqlEndpointProvisioningStatus Typen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
Failed

Fehler bei der SQL-Endpunktbereitstellung.
InProgress

Die SQL-Endpunktbereitstellung wird ausgeführt.
Success

Die SQL-Endpunktbereitstellung war erfolgreich.

UpdateLakehouseRequest

Objekt

Aktualisieren sie die Lakehouse-Anforderung.

Name Typ Beschreibung
description

string

Die Beschreibung des Seehauses. Die maximale Länge beträgt 256 Zeichen.
displayName

string

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