Freigeben über


OneLake Shortcuts - Get Shortcut

Gibt Verknüpfungseigenschaften zurück.

Erforderliche delegierte Bereiche

OneLake.Read.All oder OneLake.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

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/shortcuts/{shortcutPath}/{shortcutName}

URI-Parameter

Name In Erforderlich Typ Beschreibung
itemId
path True

string (uuid)

Die ID des Datenelements.

shortcutName
path True

string

Der Name der Verknüpfung. Weitere Informationen finden Sie unter: Verzeichnis- und Dateinamen.

shortcutPath
path True

string

Der Erstellungspfad der Verknüpfung. Weitere Informationen finden Sie unter: Verzeichnis- und Dateinamen.

workspaceId
path True

string (uuid)

Die ID des Arbeitsbereichs.

Antworten

Name Typ Beschreibung
200 OK

Shortcut

Die Anforderung wurde erfolgreich abgeschlossen.

Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • ItemNotFound – Der Server kann das angeforderte Element nicht finden.

  • UnknownError – Ein Fehler ist aufgetreten.

Beispiele

Get shortcut AzureBlobStorage target example
Get shortcut ExternalDataShare target example
Get shortcut Google Cloud Storage target example
Get shortcut One Lake target example
Get shortcut S3 Compatible target example
Get shortcut transform with One Lake target example

Get shortcut AzureBlobStorage target example

Beispielanforderung

GET https://api.fabric.microsoft.com/v1/workspaces/bf94607f-3ba1-4a95-8259-27649ccd7755/items/884e71cd-f5b4-45f9-8e00-b71355f7ea5d/shortcuts/Files/MyAzureBlobStorage

Beispiel für eine Antwort

{
  "path": "Files",
  "name": "MyAzureBlobStorage",
  "target": {
    "type": "AzureBlobStorage",
    "azureBlobStorage": {
      "connectionId": "97e33458-1353-4911-96b1-6f4f4bbfd335",
      "location": "https://azureblobstoragetesting.blob.core.windows.net",
      "subpath": "tables"
    }
  }
}

Get shortcut ExternalDataShare target example

Beispielanforderung

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/shortcuts/Files/blafolder/folder3/MyExternalDataShareShortcut

Beispiel für eine Antwort

{
  "path": "Files/blafolder/folder3",
  "name": "MyExternalDataShareShortcut",
  "target": {
    "type": "ExternalDataShare",
    "externalDataShare": {
      "connectionId": "3c976446-0bda-472e-8800-f1d6e4f162dc"
    }
  }
}

Get shortcut Google Cloud Storage target example

Beispielanforderung

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/shortcuts/Files/blafolder/folder3/MyGCSShortcut

Beispiel für eine Antwort

{
  "path": "Files/blafolder/folder3",
  "name": "MyGCSShortcut",
  "target": {
    "type": "GoogleCloudStorage",
    "googleCloudStorage": {
      "connectionId": "3c976446-0bda-472e-8800-f1d6e4f162dc",
      "location": "https://gcs-contosoBucket.storage.googleapis.com",
      "subpath": "gcsDirectory"
    }
  }
}

Get shortcut One Lake target example

Beispielanforderung

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/shortcuts/Files/blafolder/folder3/MyOneLakeShortcut

Beispiel für eine Antwort

{
  "path": "Files/blafolder/folder3",
  "name": "MyOneLakeShortcut",
  "target": {
    "type": "OneLake",
    "oneLake": {
      "workspaceId": "acafbeb1-8037-4d0c-896e-a46fb27ff256",
      "itemId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
      "path": "Tables/myTablesFolder/someTableSubFolder"
    }
  }
}

Get shortcut S3 Compatible target example

Beispielanforderung

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/shortcuts/Files/blafolder/folder3/MyS3CompatibleShortcut

Beispiel für eine Antwort

{
  "path": "Files/blafolder/folder3",
  "name": "MyS3CompatibleShortcut",
  "target": {
    "type": "S3Compatible",
    "s3Compatible": {
      "connectionId": "3c976446-0bda-472e-8800-f1d6e4f162dc",
      "location": "https://s3endpoint.contoso.com",
      "bucket": "contosoBucket",
      "subpath": "s3CompatibleDirectory"
    }
  }
}

Get shortcut transform with One Lake target example

Beispielanforderung

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/shortcuts/Files/blafolder/folder3/MyOneLakeShortcutTransform

Beispiel für eine Antwort

{
  "path": "Files/blafolder/folder3",
  "name": "MyOneLakeShortcutTransform",
  "target": {
    "type": "OneLake",
    "oneLake": {
      "workspaceId": "acafbeb1-8037-4d0c-896e-a46fb27ff256",
      "itemId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
      "path": "Tables/myTablesFolder/someTableSubFolder"
    }
  },
  "transform": {
    "type": "csvToDelta",
    "properties": {
      "useFirstRowAsHeader": false,
      "delimiter": ",",
      "skipFilesWithErrors": true
    }
  }
}

Definitionen

Name Beschreibung
AdlsGen2

Ein Objekt, das die Eigenschaften der ADLS Gen2-Zieldatenquelle enthält.

AmazonS3

Ein Objekt, das die Eigenschaften der Amazon S3-Zieldatenquelle enthält.

AzureBlobStorage

Ein Objekt, das die Eigenschaften der Azure Blob Storage-Zieldatenquelle enthält.

CsvToDeltaTransform

CSV-zu-Delta-Transformation.

CsvToDeltaTransformProperties

Eigenschaften für die CSV-zu-Delta-Transformation.

Dataverse

Ein Objekt, das die Eigenschaften der Dataverse-Zieldatenquelle enthält.

ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.

ErrorResponse

Die Fehlerantwort.

ErrorResponseDetails

Die Fehlerantwortdetails.

ExternalDataShareTarget

Ein Objekt, das die Eigenschaften der externen Zieldatenfreigabe enthält.

GoogleCloudStorage

Ein Objekt, das die Eigenschaften der Google Cloud Storage-Zieldatenquelle enthält.

OneLake

Ein Objekt, das die Eigenschaften der OneLake-Zieldatenquelle enthält.

S3Compatible

Ein Objekt, das die Eigenschaften der mit S3 kompatiblen Zieldatenquelle enthält.

Shortcut

Ein Objekt, das einen Verweis darstellt, der auf andere Speicherorte verweist, die intern oder extern zu OneLake sein können. Die Verknüpfung wird anhand des Namens definiert, pfad, in dem die Verknüpfung erstellt wird, und das Ziel, das den Zielspeicherort angibt.

Target

Ein Objekt, das die Zieldatenquelle enthält, und muss genau eines der unterstützten Ziele angeben, wie in der folgenden Tabelle beschrieben.

Type

Das Typobjekt enthält Eigenschaften wie den Zielverknüpfungskontotyp. Zusätzliche Typen können im Laufe der Zeit hinzugefügt werden.

AdlsGen2

Ein Objekt, das die Eigenschaften der ADLS Gen2-Zieldatenquelle enthält.

Name Typ Beschreibung
connectionId

string (uuid)

Eine Zeichenfolge, die die Verbindung darstellt, die an die Verknüpfung gebunden ist. Die connectionId ist ein eindeutiger Bezeichner, der zum Herstellen einer Verbindung zwischen der Verknüpfung und der Zieldatenquelle verwendet wird. Um diese Verbindungs-ID zu finden, erstellen Sie zuerst eine Cloudverbindung , die von der Verknüpfung beim Herstellen einer Verbindung mit dem ADLS-Datenspeicherort verwendet werden soll. Öffnen Sie die Ansicht "Einstellungen" der Cloudverbindung, und kopieren Sie die Verbindungs-ID. Dies ist eine GUID.

location

string (uri)

Gibt den Speicherort des ADLS-Zielcontainers an. Der URI muss im Format https://[Kontoname].dfs.core.windows.net sein, wobei [Kontoname] der Name des ADLS-Zielkontos ist.

subpath

string

Gibt den Container und unterordner innerhalb des ADLS-Kontos an, in dem sich der Zielordner befindet. Muss das Format [container]/[Unterordner] aufweisen, wobei [container] der Name des Containers ist, der die Dateien und Ordner enthält; [Unterordner] ist der Name des Unterordners innerhalb des Containers (optional). Beispiel: /mycontainer/mysubfolder

AmazonS3

Ein Objekt, das die Eigenschaften der Amazon S3-Zieldatenquelle enthält.

Name Typ Beschreibung
connectionId

string (uuid)

Eine Zeichenfolge, die die Verbindung darstellt, die an die Verknüpfung gebunden ist. Die connectionId ist ein eindeutiger Bezeichner, der zum Herstellen einer Verbindung zwischen der Verknüpfung und der Zieldatenquelle verwendet wird. Um diese Verbindungs-ID zu finden, erstellen Sie zuerst eine Cloudverbindung , die von der Verknüpfung beim Herstellen einer Verbindung mit dem Amazon S3-Datenspeicherort verwendet werden soll. Öffnen Sie die Ansicht "Einstellungen" der Cloudverbindung, und kopieren Sie die Verbindungs-ID. Dies ist eine GUID.

location

string (uri)

HTTP-URL, die auf den Ziel-Bucket in S3 verweist. Die URL sollte im Format https://[Bucketname].s3 vorliegen. [Region-Code].amazonaws.com, wobei "Bucketname" der Name des S3-Buckets ist, auf den Sie verweisen möchten, und "Regionscode" ist der Code für die Region, in der sich der Bucket befindet. Beispiel: https://my-s3-bucket.s3.us-west-2.amazonaws.com

subpath

string

Gibt einen Zielordner oder Unterordner innerhalb des S3-Buckets an.

AzureBlobStorage

Ein Objekt, das die Eigenschaften der Azure Blob Storage-Zieldatenquelle enthält.

Name Typ Beschreibung
connectionId

string (uuid)

Eine Zeichenfolge, die die Verbindung darstellt, die an die Verknüpfung gebunden ist. Die connectionId ist ein eindeutiger Bezeichner, der zum Herstellen einer Verbindung zwischen der Verknüpfung und der Zieldatenquelle verwendet wird. Um diese Verbindungs-ID zu finden, erstellen Sie zuerst eine Cloudverbindung , die von der Verknüpfung beim Herstellen einer Verbindung mit dem Azure Blob Storage-Datenspeicherort verwendet werden soll. Öffnen Sie die Einstellungsansicht der Cloudverbindung, und kopieren Sie die GUID, die die Verbindungs-ID ist.

location

string (uri)

Gibt den Speicherort des Azure Blob Storage-Zielcontainers an. Der URI muss im Format https://[account-name].blob.core.windows.net vorliegen, in dem [account-name] der Name des Azure Blob Storage-Zielkontos angegeben ist.

subpath

string

Gibt den Container und unterordner innerhalb des Azure Blob Storage-Kontos an, in dem sich der Zielordner befindet. Muss das Format [container]/[Unterordner] aufweisen. [Container] ist der Name des Containers, der die Dateien und Ordner enthält. [Unterordner] ist der Name des Unterordners innerhalb des Containers und optional. Beispiel: /mycontainer/mysubfolder

CsvToDeltaTransform

CSV-zu-Delta-Transformation.

Name Typ Beschreibung
properties

CsvToDeltaTransformProperties

CSV-zu Delta-Transformationseigenschaften.

type string:

csvToDelta

Der Typ der Transformation. Zusätzliche Transformationstypen können im Laufe der Zeit hinzugefügt werden.

CsvToDeltaTransformProperties

Eigenschaften für die CSV-zu-Delta-Transformation.

Name Typ Standardwert Beschreibung
delimiter

string

,

Gibt das Zeichen an, das zum Trennen von Werten innerhalb einer Zeile in der CSV-Datei verwendet wird, und muss genau einen der unterstützten Werte angeben: ,, , , , \t|, , . &; Der Standardwert ist ,.

skipFilesWithErrors

boolean

True

Gibt an, ob Dateien mit Fehlern übersprungen werden sollen. True - Überspringen Sie Dateien mit Fehlern, False - Überspringen Sie Keine Dateien mit Fehlern. Der Standardwert ist TRUE.

useFirstRowAsHeader

boolean

True

Gibt an, ob die erste Zeile der CSV-Datei als Header verwendet werden soll. True – Verwenden Sie die erste Zeile als Kopfzeile. False – Verwenden Sie nicht die erste Zeile als Kopfzeile. Der Standardwert ist TRUE.

Dataverse

Ein Objekt, das die Eigenschaften der Dataverse-Zieldatenquelle enthält.

Name Typ Beschreibung
connectionId

string (uuid)

Eine Zeichenfolge, die die Verbindung darstellt, die an die Verknüpfung gebunden ist. Die connectionId ist ein eindeutiger Bezeichner, der zum Herstellen einer Verbindung zwischen der Verknüpfung und der Zieldatenquelle verwendet wird. Um diese Verbindungs-ID zu finden, erstellen Sie zuerst eine Cloudverbindung , die von der Verknüpfung beim Herstellen einer Verbindung mit dem Dataverse-Datenspeicherort verwendet werden soll. Öffnen Sie die Ansicht "Einstellungen" der Cloudverbindung, und kopieren Sie die Verbindungs-ID. Dies ist eine GUID.

deltaLakeFolder

string

Gibt den DeltaLake-Ordnerpfad an, in dem die Zieldaten gespeichert werden.

environmentDomain

string (uri)

URI, der den Domänennamen der Dataverse-Zielumgebung angibt. Der URI sollte als "https://[orgname].crm[xx].dynamics.com" formatiert werden, wobei [orgname] der Name Ihrer Dataverse-Organisation steht.

tableName

string

Gibt den Namen der Zieltabelle in Dataverse an.

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.

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

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.

ExternalDataShareTarget

Ein Objekt, das die Eigenschaften der externen Zieldatenfreigabe enthält.

Name Typ Beschreibung
connectionId

string (uuid)

Eine Zeichenfolge, die die Verbindung darstellt, die an die Verknüpfung gebunden ist. Die connectionId ist ein eindeutiger Bezeichner, der zum Herstellen einer Verbindung zwischen der Verknüpfung und der Zieldatenquelle verwendet wird.

GoogleCloudStorage

Ein Objekt, das die Eigenschaften der Google Cloud Storage-Zieldatenquelle enthält.

Name Typ Beschreibung
connectionId

string (uuid)

Eine Zeichenfolge, die die Verbindung darstellt, die an die Verknüpfung gebunden ist. Die connectionId ist ein eindeutiger Bezeichner, der zum Herstellen einer Verbindung zwischen der Verknüpfung und der Zieldatenquelle verwendet wird.

location

string (uri)

HTTP-URL, die auf den Ziel-Bucket in GCS verweist. Die URL sollte im Format https://[Bucketname].storage.googleapis.com sein, wobei [Bucketname] der Name des Buckets ist, auf den Sie verweisen möchten. Beispiel: https://my-gcs-bucket.storage.googleapis.com

subpath

string

Gibt einen Zielordner oder Unterordner innerhalb des GCS-Buckets an. Beispiel: /folder

OneLake

Ein Objekt, das die Eigenschaften der OneLake-Zieldatenquelle enthält.

Name Typ Beschreibung
connectionId

string (uuid)

Eine Zeichenfolge, die die Verbindung darstellt, die an die Verknüpfung gebunden ist. Die connectionId ist ein eindeutiger Bezeichner, der zum Herstellen einer Verbindung zwischen der Verknüpfung und der Zieldatenquelle verwendet wird. Um diese Verbindungs-ID zu finden, erstellen Sie zuerst eine Cloudverbindung , die von der Verknüpfung beim Herstellen einer Verbindung mit dem Amazon S3-Datenspeicherort verwendet werden soll. Öffnen Sie die Ansicht "Einstellungen" der Cloudverbindung, und kopieren Sie die Verbindungs-ID. Dies ist eine GUID.

itemId

string (uuid)

Die ID des Ziels in OneLake. Das Ziel kann ein Element von Lakehouse, KQLDatabase oder Warehouse sein.

path

string

Eine Zeichenfolge, die den vollständigen Pfad zum Zielordner innerhalb des Elements darstellt. Dieser Pfad sollte relativ zum Stamm der OneLake-Verzeichnisstruktur sein. Beispiel: "Tables/myTablesFolder/someTableSubFolder".

workspaceId

string (uuid)

Die ID des Zielarbeitsbereichs.

S3Compatible

Ein Objekt, das die Eigenschaften der mit S3 kompatiblen Zieldatenquelle enthält.

Name Typ Beschreibung
bucket

string

Gibt den Ziel-Bucket innerhalb des S3-kompatiblen Speicherorts an.

connectionId

string (uuid)

Eine Zeichenfolge, die die Verbindung darstellt, die an die Verknüpfung gebunden ist. Die connectionId ist ein eindeutiger Bezeichner, der zum Herstellen einer Verbindung zwischen der Verknüpfung und der Zieldatenquelle verwendet wird.

location

string (uri)

HTTP-URL des S3-kompatiblen Endpunkts. Dieser Endpunkt muss in der Lage sein, ListBuckets S3-API-Aufrufe zu empfangen. Die URL muss im nicht bucketspezifischen Format vorliegen; hier sollte kein Bucket angegeben werden. Beispiel: https://s3endpoint.contoso.com

subpath

string

Gibt einen Zielordner oder Unterordner innerhalb des S3-kompatiblen Buckets an. Beispiel: /folder

Shortcut

Ein Objekt, das einen Verweis darstellt, der auf andere Speicherorte verweist, die intern oder extern zu OneLake sein können. Die Verknüpfung wird anhand des Namens definiert, pfad, in dem die Verknüpfung erstellt wird, und das Ziel, das den Zielspeicherort angibt.

Name Typ Beschreibung
name

string

Name der Verknüpfung.

path

string

Eine Zeichenfolge, die den vollständigen Pfad darstellt, in dem die Verknüpfung erstellt wird, einschließlich "Dateien" oder "Tabellen".

target

Target

Ein Objekt, das die Zieldatenquelle enthält und genau eines der unterstützten Ziele angeben muss.

transform Transform:

CsvToDeltaTransform

Ein Objekt, das den Transformationsnamen und die entsprechenden Eigenschaften enthält, die auf Zieldaten angewendet werden sollen, und muss genau eine der unterstützten Transformationen angeben.

Target

Ein Objekt, das die Zieldatenquelle enthält, und muss genau eines der unterstützten Ziele angeben, wie in der folgenden Tabelle beschrieben.

Name Typ Beschreibung
adlsGen2

AdlsGen2

Ein Objekt, das die Eigenschaften der ADLS Gen2-Zieldatenquelle enthält.

amazonS3

AmazonS3

Ein Objekt, das die Eigenschaften der Amazon S3-Zieldatenquelle enthält.

azureBlobStorage

AzureBlobStorage

Ein Objekt, das die Eigenschaften der Azure Blob Storage-Zieldatenquelle enthält.

dataverse

Dataverse

Ein Objekt, das die Eigenschaften der Dataverse-Zieldatenquelle enthält.

externalDataShare

ExternalDataShareTarget

Ein Objekt, das die Eigenschaften der externen Zieldatenfreigabe enthält.

googleCloudStorage

GoogleCloudStorage

Ein Objekt, das die Eigenschaften der Google Cloud Storage-Zieldatenquelle enthält.

oneLake

OneLake

Ein Objekt, das die Eigenschaften der OneLake-Zieldatenquelle enthält.

s3Compatible

S3Compatible

Ein Objekt, das die Eigenschaften der mit S3 kompatiblen Zieldatenquelle enthält.

type

Type

Das Typobjekt enthält Eigenschaften wie den Zielverknüpfungskontotyp. Zusätzliche Typen können im Laufe der Zeit hinzugefügt werden.

Type

Das Typobjekt enthält Eigenschaften wie den Zielverknüpfungskontotyp. Zusätzliche Typen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
OneLake

OneLake

AmazonS3

AmazonS3

AdlsGen2

AdlsGen2

GoogleCloudStorage

GoogleCloudStorage

S3Compatible

S3Compatible

Dataverse

Dataverse

ExternalDataShare

ExternalDataShare

AzureBlobStorage

AzureBlobStorage