Udostępnij przez


OneLake Shortcuts - List Shortcuts

Zwraca listę skrótów dla elementu, w tym wszystkie podfoldery wyczerpująco.

Wymagane zakresy delegowane

OneLake.Read.All lub OneLake.ReadWrite.All

Tożsamości obsługiwane przez Microsoft Entra

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Tożsamość Wsparcie
Użytkownik Tak
Główne usługi i Tożsamości zarządzane Tak

Interfejs

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/shortcuts
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/shortcuts?parentPath={parentPath}&continuationToken={continuationToken}

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
itemId
path True

string (uuid)

Identyfikator elementu.

workspaceId
path True

string (uuid)

Identyfikator przestrzeni roboczej.

continuationToken
query

string

Token do pobierania następnej strony wyników.

parentPath
query

string

Ścieżka początkowa, z której mają być pobierane skróty

Odpowiedzi

Nazwa Typ Opis
200 OK

Shortcuts

Żądanie zostało ukończone pomyślnie.

Other Status Codes

ErrorResponse

Typowe kody błędów:

  • ItemNotFound — serwer nie może odnaleźć żądanego elementu.

  • UnknownError — wystąpił błąd.

Przykłady

List shortcuts example
List shortcuts with continuation example
List shortcuts with shortcut transforms example

List shortcuts example

Przykładowe żądanie

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/56bac802-080d-4f73-8a42-1b406eb1fcac/shortcuts

Przykładowa odpowiedź

{
  "value": [
    {
      "path": "Files/blafolder/folder3",
      "name": "MyOneLakeShortcut",
      "target": {
        "type": "OneLake",
        "oneLake": {
          "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
          "itemId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
          "path": "Tables/myTablesFolder/someTableSubFolder"
        }
      }
    },
    {
      "path": "Files/noaccess",
      "name": "MyS3Shortcut",
      "target": {
        "type": "AmazonS3"
      }
    },
    {
      "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"
        }
      }
    },
    {
      "path": "Files/blafolder/folder3",
      "name": "MyGCSShortcut",
      "target": {
        "type": "GoogleCloudStorage",
        "googleCloudStorage": {
          "connectionId": "5b218778-e7a5-4d73-8187-f10824047715",
          "location": "https://gcs-contosoBucket.storage.googleapis.com",
          "subpath": "gcsDirectory"
        }
      }
    },
    {
      "path": "Files/blafolder/folder3",
      "name": "MyExternalDataShareShortcut",
      "target": {
        "type": "ExternalDataShare",
        "externalDataShare": {
          "connectionId": "af196b7b-0bf8-4430-b383-ad48d14f4edf"
        }
      }
    },
    {
      "path": "Files/bla1folder/folder4",
      "name": "MyDataShareShortcutWithREAD",
      "target": {
        "type": "ExternalDataShare"
      }
    }
  ]
}

List shortcuts with continuation example

Przykładowe żądanie

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/56bac802-080d-4f73-8a42-1b406eb1fcac/shortcuts

Przykładowa odpowiedź

{
  "value": [
    {
      "path": "Files/blafolder/folder3",
      "name": "MyOneLakeShortcut",
      "target": {
        "type": "OneLake",
        "oneLake": {
          "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
          "itemId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
          "path": "Tables/myTablesFolder/someTableSubFolder"
        }
      }
    },
    {
      "path": "Files/noaccess",
      "name": "MyS3Shortcut",
      "target": {
        "type": "AmazonS3"
      }
    },
    {
      "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"
        }
      }
    },
    {
      "path": "Files/blafolder/folder3",
      "name": "MyGCSShortcut",
      "target": {
        "type": "GoogleCloudStorage",
        "googleCloudStorage": {
          "connectionId": "5b218778-e7a5-4d73-8187-f10824047715",
          "location": "https://gcs-contosoBucket.storage.googleapis.com",
          "subpath": "gcsDirectory"
        }
      }
    },
    {
      "path": "Files/blafolder/folder3",
      "name": "MyExternalDataShareShortcut",
      "target": {
        "type": "ExternalDataShare",
        "externalDataShare": {
          "connectionId": "af196b7b-0bf8-4430-b383-ad48d14f4edf"
        }
      }
    },
    {
      "path": "Files/bla1folder/folder4",
      "name": "MyDataShareShortcutWithREAD",
      "target": {
        "type": "ExternalDataShare"
      }
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/56bac802-080d-4f73-8a42-1b406eb1fcac/shortcuts?continuationToken=LDEsMTAwMDAwLDA%3D"
}

List shortcuts with shortcut transforms example

Przykładowe żądanie

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/56bac802-080d-4f73-8a42-1b406eb1fcac/shortcuts

Przykładowa odpowiedź

{
  "value": [
    {
      "path": "Files/blafolder/folder3",
      "name": "MyOneLakeShortcut",
      "target": {
        "type": "OneLake",
        "oneLake": {
          "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
          "itemId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
          "path": "Tables/myTablesFolder/someTableSubFolder"
        }
      },
      "isShortcutTransform": true
    },
    {
      "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"
        }
      },
      "isShortcutTransform": true
    }
  ]
}

Definicje

Nazwa Opis
AdlsGen2

Obiekt zawierający właściwości docelowego źródła danych usługi ADLS Gen2.

AmazonS3

Obiekt zawierający właściwości docelowego źródła danych Amazon S3.

AzureBlobStorage

Obiekt zawierający właściwości docelowego źródła danych usługi Azure Blob Storage.

CsvToDeltaTransform

Przekształcanie woluminów CSV do funkcji delta.

CsvToDeltaTransformProperties

Właściwości przekształcenia csv na delta.

Dataverse

Obiekt zawierający właściwości docelowego źródła danych Dataverse.

ErrorRelatedResource

Obiekt szczegółów zasobu powiązanego z błędem.

ErrorResponse

Odpowiedź na błąd.

ErrorResponseDetails

Szczegóły odpowiedzi na błąd.

ExternalDataShareTarget

Obiekt zawierający właściwości docelowego udziału danych zewnętrznych.

GoogleCloudStorage

Obiekt zawierający właściwości docelowego źródła danych usługi Google Cloud Storage.

OneDriveSharePoint

Obiekt zawierający właściwości docelowego źródła danych usługi OneDrive dla Firm lub SharePoint Online.

OneLake

Obiekt zawierający właściwości docelowego źródła danych OneLake.

S3Compatible

Obiekt zawierający właściwości docelowego źródła danych zgodnego z usługą S3.

Shortcuts
ShortcutTransformFlagged

Obiekt reprezentujący odwołanie wskazujące inne lokalizacje magazynu, które mogą być wewnętrzne lub zewnętrzne dla usługi OneLake. Skrót jest definiowany przez nazwę, ścieżkę, w której jest tworzony skrót i element docelowy określający docelową lokalizację magazynu.

Target

Obiekt zawierający docelowe źródło danych i musi określić dokładnie jedno z obsługiwanych miejsc docelowych zgodnie z opisem w poniższej tabeli.

Type

Obiekt type zawiera właściwości, takie jak typ konta skrótu docelowego. Dodatkowe typy mogą być dodawane w czasie.

AdlsGen2

Obiekt zawierający właściwości docelowego źródła danych usługi ADLS Gen2.

Nazwa Typ Opis
connectionId

string (uuid)

Parametry reprezentujące połączenie powiązane ze skrótem. ConnectionId to unikatowy identyfikator używany do nawiązywania połączenia między skrótem a docelowym źródłem danych. Aby znaleźć ten identyfikator połączenia, najpierw utwórz połączenie w chmurze , które ma być używane przez skrót podczas nawiązywania połączenia z lokalizacją danych usługi ADLS. Otwórz widok Ustawienia połączenia w chmurze i skopiuj identyfikator połączenia; jest to identyfikator GUID.

location

string (uri)

Określa lokalizację docelowego kontenera usługi ADLS. Identyfikator URI musi być w formacie https://[nazwa-konta].dfs.core.windows.net, gdzie [account-name] jest nazwą docelowego konta usługi ADLS.

subpath

string

Określa kontener i podfolder w ramach konta usługi ADLS, w którym znajduje się folder docelowy. Musi mieć format [kontener]/[podfolder], gdzie [kontener] jest nazwą kontenera, który przechowuje pliki i foldery; [podfolder] to nazwa podfolderu w kontenerze (opcjonalnie). Na przykład: /mycontainer/mysubfolder

AmazonS3

Obiekt zawierający właściwości docelowego źródła danych Amazon S3.

Nazwa Typ Opis
connectionId

string (uuid)

Parametry reprezentujące połączenie powiązane ze skrótem. ConnectionId to unikatowy identyfikator używany do nawiązywania połączenia między skrótem a docelowym źródłem danych. Aby znaleźć ten identyfikator połączenia, najpierw utwórz połączenie w chmurze , które ma być używane przez skrót podczas nawiązywania połączenia z lokalizacją danych amazon S3. Otwórz widok Ustawienia połączenia w chmurze i skopiuj identyfikator połączenia; jest to identyfikator GUID.

location

string (uri)

Adres URL HTTP wskazujący zasobnik docelowy w usłudze S3. Adres URL powinien mieć format https://[nazwa-zasobnika].s3. [region-code].amazonaws.com, gdzie "bucket-name" jest nazwą zasobnika S3, do którego chcesz wskazać, a "region-code" to kod regionu, w którym znajduje się zasobnik. Przykład: https://my-s3-bucket.s3.us-west-2.amazonaws.com

subpath

string

Określa folder docelowy lub podfolder w zasobniku S3.

AzureBlobStorage

Obiekt zawierający właściwości docelowego źródła danych usługi Azure Blob Storage.

Nazwa Typ Opis
connectionId

string (uuid)

Parametry reprezentujące połączenie powiązane ze skrótem. ConnectionId to unikatowy identyfikator używany do nawiązywania połączenia między skrótem a docelowym źródłem danych. Aby znaleźć ten identyfikator połączenia, najpierw utwórz połączenie w chmurze , które ma być używane przez skrót podczas nawiązywania połączenia z lokalizacją danych usługi Azure Blob Storage. Otwórz widok ustawień połączenia w chmurze i skopiuj identyfikator GUID, który jest identyfikatorem połączenia.

location

string (uri)

Określa lokalizację docelowego kontenera usługi Azure Blob Storage. Identyfikator URI musi być w formacie https://[account-name].blob.core.windows.net , w którym [account-name] jest nazwą docelowego konta usługi Azure Blob Storage.

subpath

string

Określa kontener i podfolder na koncie usługi Azure Blob Storage, w którym znajduje się folder docelowy. Musi mieć format [kontener]/[podfolder]. [Kontener] to nazwa kontenera, który przechowuje pliki i foldery. [Podfolder] to nazwa podfolderu w kontenerze i jest opcjonalna. Na przykład: /mycontainer/mysubfolder

CsvToDeltaTransform

Przekształcanie woluminów CSV do funkcji delta.

Nazwa Typ Opis
properties

CsvToDeltaTransformProperties

Właściwości przekształcenia csv do funkcji delta.

type string:

csvToDelta

Typ przekształcenia. Dodatkowe typy przekształceń można dodawać w czasie.

CsvToDeltaTransformProperties

Właściwości przekształcenia csv na delta.

Nazwa Typ Domyślna wartość Opis
delimiter

string

,

Określa znak używany do oddzielania wartości w wierszu w pliku CSV i musi określić dokładnie jedną z obsługiwanych wartości: ,, , \t, |, &;. Wartość domyślna to ,.

skipFilesWithErrors

boolean

True

Czy pominąć pliki z błędami. True — pomijanie plików z błędami, Fałsz — nie pomijaj plików z błędami. Domyślna wartość to Prawda.

useFirstRowAsHeader

boolean

True

Czy pierwszy wiersz pliku CSV powinien być używany jako nagłówek. True — użyj pierwszego wiersza jako nagłówka. Fałsz — nie używaj pierwszego wiersza jako nagłówka. Domyślna wartość to Prawda.

Dataverse

Obiekt zawierający właściwości docelowego źródła danych Dataverse.

Nazwa Typ Opis
connectionId

string (uuid)

Parametry reprezentujące połączenie powiązane ze skrótem. ConnectionId to unikatowy identyfikator używany do nawiązywania połączenia między skrótem a docelowym źródłem danych. Aby znaleźć ten identyfikator połączenia, najpierw utwórz połączenie w chmurze , które ma być używane przez skrót podczas nawiązywania połączenia z lokalizacją danych usługi Dataverse. Otwórz widok Ustawienia połączenia w chmurze i skopiuj identyfikator połączenia; jest to identyfikator GUID.

deltaLakeFolder

string

Określa ścieżkę folderu DeltaLake, w której są przechowywane dane docelowe.

environmentDomain

string (uri)

Identyfikator URI wskazujący nazwę domeny środowiska docelowego usługi Dataverse. Identyfikator URI powinien być sformatowany jako "https://[nazwa organizacji].crm[xx].dynamics.com", gdzie [orgname] reprezentuje nazwę organizacji usługi Dataverse.

tableName

string

Określa nazwę tabeli docelowej w usłudze Dataverse

ErrorRelatedResource

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa Typ Opis
resourceId

string

Identyfikator zasobu, który jest zaangażowany w błąd.

resourceType

string

Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Odpowiedź na błąd.

Nazwa Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.

message

string

Czytelna reprezentacja błędu przez człowieka.

moreDetails

ErrorResponseDetails[]

Lista dodatkowych szczegółów błędu.

relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.

requestId

string

Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Szczegóły odpowiedzi na błąd.

Nazwa Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.

message

string

Czytelna reprezentacja błędu przez człowieka.

relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.

ExternalDataShareTarget

Obiekt zawierający właściwości docelowego udziału danych zewnętrznych.

Nazwa Typ Opis
connectionId

string (uuid)

Parametry reprezentujące połączenie powiązane ze skrótem. ConnectionId to unikatowy identyfikator używany do nawiązywania połączenia między skrótem a docelowym źródłem danych.

GoogleCloudStorage

Obiekt zawierający właściwości docelowego źródła danych usługi Google Cloud Storage.

Nazwa Typ Opis
connectionId

string (uuid)

Parametry reprezentujące połączenie powiązane ze skrótem. ConnectionId to unikatowy identyfikator używany do nawiązywania połączenia między skrótem a docelowym źródłem danych.

location

string (uri)

Adres URL HTTP wskazujący zasobnik docelowy w usłudze GCS. Adres URL powinien mieć format https://[nazwa-zasobnika].storage.googleapis.com, gdzie [nazwa-zasobnika] jest nazwą zasobnika, który chcesz wskazać. Przykład: https://my-gcs-bucket.storage.googleapis.com

subpath

string

Określa folder docelowy lub podfolder w zasobniku GCS. Na przykład: /folder

OneDriveSharePoint

Obiekt zawierający właściwości docelowego źródła danych usługi OneDrive dla Firm lub SharePoint Online.

Nazwa Typ Opis
connectionId

string (uuid)

Parametry reprezentujące połączenie powiązane ze skrótem. ConnectionId to unikatowy identyfikator używany do nawiązywania połączenia między skrótem a docelowym źródłem danych. Aby znaleźć ten identyfikator połączenia, najpierw utwórz połączenie w chmurze , które ma być używane przez skrót podczas nawiązywania połączenia z lokalizacją danych programu SharePoint w usłudze OneDrive. Otwórz widok ustawień połączenia w chmurze i skopiuj identyfikator GUID, który jest identyfikatorem połączenia.

location

string (uri)

Określa lokalizację docelowego kontenera programu SharePoint w usłudze OneDrive. Identyfikator URI musi być w formacie https://microsoft.sharepoint.com , który jest ścieżką docelowego konta programu SharePoint w usłudze OneDrive.

subpath

string

Określa kontener i podfolder w ramach konta programu SharePoint usługi OneDrive, w którym znajduje się folder docelowy. Musi mieć format [kontener]/[podfolder]. [Kontener] to nazwa kontenera, który przechowuje pliki i foldery. [Podfolder] to nazwa podfolderu w kontenerze i jest opcjonalna. Na przykład: /mycontainer/mysubfolder

OneLake

Obiekt zawierający właściwości docelowego źródła danych OneLake.

Nazwa Typ Opis
connectionId

string (uuid)

Parametry reprezentujące połączenie powiązane ze skrótem. ConnectionId to unikatowy identyfikator używany do nawiązywania połączenia między skrótem a docelowym źródłem danych. Aby znaleźć ten identyfikator połączenia, najpierw utwórz połączenie w chmurze , które ma być używane przez skrót podczas nawiązywania połączenia z lokalizacją danych amazon S3. Otwórz widok Ustawienia połączenia w chmurze i skopiuj identyfikator połączenia; jest to identyfikator GUID.

itemId

string (uuid)

Identyfikator obiektu docelowego w usłudze OneLake. Obiektem docelowym może być element Lakehouse, KQLDatabase lub Warehouse.

path

string

Ciąg reprezentujący pełną ścieżkę do folderu docelowego w elemencie Item. Ta ścieżka powinna być względna względem katalogu głównego struktury katalogów OneLake. Na przykład: "Tables/myTablesFolder/someTableSubFolder".

workspaceId

string (uuid)

Identyfikator docelowego obszaru roboczego.

S3Compatible

Obiekt zawierający właściwości docelowego źródła danych zgodnego z usługą S3.

Nazwa Typ Opis
bucket

string

Określa zasobnik docelowy w lokalizacji zgodnej z usługą S3.

connectionId

string (uuid)

Parametry reprezentujące połączenie powiązane ze skrótem. ConnectionId to unikatowy identyfikator używany do nawiązywania połączenia między skrótem a docelowym źródłem danych.

location

string (uri)

Adres URL HTTP punktu końcowego zgodnego z usługą S3. Ten punkt końcowy musi mieć możliwość odbierania wywołań interfejsu API ListBuckets S3. Adres URL musi być w formacie specyficznym dla zasobnika; w tym miejscu nie należy określać zasobnika. Przykład: https://s3endpoint.contoso.com

subpath

string

Określa folder docelowy lub podfolder w zasobniku zgodnym z usługą S3. Na przykład: /folder

Shortcuts

Nazwa Typ Opis
continuationToken

string

Token dla następnej partii zestawu wyników. Jeśli nie ma więcej rekordów, zostanie on usunięty z odpowiedzi.

continuationUri

string

Identyfikator URI następnego zestawu wyników wsadowy. Jeśli nie ma więcej rekordów, zostanie on usunięty z odpowiedzi.

value

ShortcutTransformFlagged[]

Lista skrótów.

ShortcutTransformFlagged

Obiekt reprezentujący odwołanie wskazujące inne lokalizacje magazynu, które mogą być wewnętrzne lub zewnętrzne dla usługi OneLake. Skrót jest definiowany przez nazwę, ścieżkę, w której jest tworzony skrót i element docelowy określający docelową lokalizację magazynu.

Nazwa Typ Opis
isShortcutTransform

boolean

Określa, czy ten skrót jest skrótem przekształcania. True — przekształcenie skrótu, Fałsz — zwykły skrót. Właściwości przekształcania skrótów można uzyskać przy użyciu polecenia Pobierz skrót.

name

string

Nazwa skrótu.

path

string

Ciąg reprezentujący pełną ścieżkę, w której jest tworzony skrót, w tym "Pliki" lub "Tabele".

target

Target

Obiekt zawierający docelowe źródło danych i musi określić dokładnie jedno z obsługiwanych miejsc docelowych.

transform Transform:

CsvToDeltaTransform

Obiekt, który zawiera nazwę przekształcenia i odpowiadające jej właściwości, które mają być stosowane do danych docelowych, i musi określić dokładnie jedną z obsługiwanych przekształceń.

Target

Obiekt zawierający docelowe źródło danych i musi określić dokładnie jedno z obsługiwanych miejsc docelowych zgodnie z opisem w poniższej tabeli.

Nazwa Typ Opis
adlsGen2

AdlsGen2

Obiekt zawierający właściwości docelowego źródła danych usługi ADLS Gen2.

amazonS3

AmazonS3

Obiekt zawierający właściwości docelowego źródła danych Amazon S3.

azureBlobStorage

AzureBlobStorage

Obiekt zawierający właściwości docelowego źródła danych usługi Azure Blob Storage.

dataverse

Dataverse

Obiekt zawierający właściwości docelowego źródła danych Dataverse.

externalDataShare

ExternalDataShareTarget

Obiekt zawierający właściwości docelowego udziału danych zewnętrznych.

googleCloudStorage

GoogleCloudStorage

Obiekt zawierający właściwości docelowego źródła danych usługi Google Cloud Storage.

oneDriveSharePoint

OneDriveSharePoint

Obiekt zawierający właściwości docelowego źródła danych usługi OneDrive dla Firm i sharePoint Online.

oneLake

OneLake

Obiekt zawierający właściwości docelowego źródła danych OneLake.

s3Compatible

S3Compatible

Obiekt zawierający właściwości docelowego źródła danych zgodnego z usługą S3.

type

Type

Obiekt type zawiera właściwości, takie jak typ konta skrótu docelowego. Dodatkowe typy mogą być dodawane w czasie.

Type

Obiekt type zawiera właściwości, takie jak typ konta skrótu docelowego. Dodatkowe typy mogą być dodawane w czasie.

Wartość Opis
OneLake

OneLake

AmazonS3

AmazonS3

AdlsGen2

AdlsGen2

GoogleCloudStorage

GoogleCloudStorage

S3Compatible

Niezgodne S3

Dataverse

Dataverse

ExternalDataShare

ExternalDataShare

AzureBlobStorage

AzureBlobStorage

OneDriveSharePoint

OneDriveSharePoint