OneLake Shortcuts - List Shortcuts

Служба:: Core

Версия API:: v1

Возвращает список ярлыков для элемента, включая все вложенные папки.

Обязательные делегированные области

OneLake.Read.All или OneLake.ReadWrite.All

Идентификаторы, поддерживаемые Microsoft Entra

Этот API поддерживает идентичности Microsoft, перечисленные в этом разделе.

Идентичность	Поддержка
Пользователь	Да
Представитель службы и управляемые удостоверения	Да

Интерфейс

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}

Параметры URI

Имя	В	Обязательно	Тип	Описание
itemId	path	True	string (uuid)	Идентификатор элемента.
workspaceId	path	True	string (uuid)	Идентификатор рабочей области.
continuationToken	query		string	Маркер получения следующей страницы результатов.
parentPath	query		string	Начальный путь, из которого извлекаются сочетания клавиш

Ответы

Имя	Тип	Описание
200 OK	Shortcuts	Запрос успешно завершен.
Other Status Codes	ErrorResponse	Распространенные коды ошибок: ItemNotFound — сервер не может найти запрошенный элемент. UnknownError — произошла ошибка.

Имя

Тип

Описание

200 OK

Shortcuts

Запрос успешно завершен.

Other Status Codes

ErrorResponse

Распространенные коды ошибок:

ItemNotFound — сервер не может найти запрошенный элемент.
UnknownError — произошла ошибка.

Примеры

List shortcuts example

List shortcuts with continuation example

List shortcuts with shortcut transforms example

List shortcuts example

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 200

{
  "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

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 200

{
  "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

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 200

{
  "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
    }
  ]
}

Определения

Имя	Описание
AdlsGen2	Объект, содержащий свойства целевого источника данных ADLS 2-го поколения.
AmazonS3	Объект, содержащий свойства целевого источника данных Amazon S3.
AzureBlobStorage	Объект, содержащий свойства целевого источника данных хранилища BLOB-объектов Azure.
CsvToDeltaTransform	Преобразование CSV в Delta.
CsvToDeltaTransformProperties	Свойства преобразования CSV в Delta.
Dataverse	Объект, содержащий свойства целевого источника данных Dataverse.
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
ExternalDataShareTarget	Объект, содержащий свойства целевого внешнего ресурса данных.
GoogleCloudStorage	Объект, содержащий свойства целевого источника данных Google Cloud Storage.
OneLake	Объект, содержащий свойства целевого источника данных OneLake.
S3Compatible	Объект, содержащий свойства целевого источника данных, совместимого с S3.
Shortcuts
ShortcutTransformFlagged	Объект, представляющий ссылку, указывающую на другие расположения хранилища, которые могут быть внутренними или внешними для OneLake. Ярлык определяется по имени, пути, в котором создается ярлык и целевой объект, указывающий расположение целевого хранилища.
Target	Объект, содержащий целевой источник данных, и должен указывать именно один из поддерживаемых назначений, как описано в таблице ниже.
Type	Объект типа содержит свойства, такие как тип учетной записи целевого ярлыка. С течением времени могут добавляться дополнительные типы.

AdlsGen2

Object

Объект, содержащий свойства целевого источника данных ADLS 2-го поколения.

Имя	Тип	Описание
connectionId	string (uuid)	Строка, представляющая соединение, связанное с ярлыком. ConnectionId — это уникальный идентификатор, используемый для установления соединения между ярлыком и целевым источником данных. Чтобы найти этот идентификатор подключения, сначала создайте облачное подключение , которое будет использоваться ярлыком при подключении к расположению данных ADLS. Откройте представление параметров облачного подключения и скопируйте идентификатор подключения; это GUID.
location	string (uri)	Указывает расположение целевого контейнера ADLS. URI должен быть в формате https://[имя учетной записи].dfs.core.windows.net, где [имя учетной записи] — это имя целевой учетной записи ADLS.
subpath	string	Указывает контейнер и вложенную папку в учетной записи ADLS, в которой находится целевая папка. Должен иметь формат [контейнер]/[вложенная папка], где [контейнер] — это имя контейнера, в котором хранятся файлы и папки; [вложенная папка] — это имя вложенной папки в контейнере (необязательно). Например: /mycontainer/mysubfolder

AmazonS3

Object

Объект, содержащий свойства целевого источника данных Amazon S3.

Имя	Тип	Описание
connectionId	string (uuid)	Строка, представляющая соединение, связанное с ярлыком. ConnectionId — это уникальный идентификатор, используемый для установления соединения между ярлыком и целевым источником данных. Чтобы найти этот идентификатор подключения, сначала создайте облачное подключение , которое будет использоваться ярлыком при подключении к расположению данных Amazon S3. Откройте представление параметров облачного подключения и скопируйте идентификатор подключения; это GUID.
location	string (uri)	URL-адрес HTTP, указывающий на целевой контейнер в S3. URL-адрес должен быть в формате https://[имя контейнера].s3. [код региона].amazonaws.com, где "имя контейнера" — это имя контейнера S3, на который нужно указать, и "регион-код" — код для региона, на котором находится контейнер. Например: https://my-s3-bucket.s3.us-west-2.amazonaws.com
subpath	string	Указывает целевую папку или вложенную папку в контейнере S3.

AzureBlobStorage

Object

Объект, содержащий свойства целевого источника данных хранилища BLOB-объектов Azure.

Имя	Тип	Описание
connectionId	string (uuid)	Строка, представляющая соединение, связанное с ярлыком. ConnectionId — это уникальный идентификатор, используемый для установления соединения между ярлыком и целевым источником данных. Чтобы найти этот идентификатор подключения, сначала создайте облачное подключение , которое будет использоваться ярлыком при подключении к расположению данных хранилища BLOB-объектов Azure. Откройте представление параметров облачного подключения и скопируйте идентификатор GUID, который является идентификатором подключения.
location	string (uri)	Указывает расположение целевого контейнера хранилища BLOB-объектов Azure. Универсальный код ресурса (URI) должен находиться в формате `https://[account-name].blob.core.windows.net` , где `[account-name]` имя целевой учетной записи хранения BLOB-объектов Azure.
subpath	string	Указывает контейнер и вложенную папку в учетной записи хранения BLOB-объектов Azure, в которой находится целевая папка. Должен иметь формат [контейнер]/[вложенная папка]. [Контейнер] — это имя контейнера, в котором хранятся файлы и папки. [Вложенная папка] — это имя вложенной папки в контейнере и является необязательным. Например: /mycontainer/mysubfolder

CsvToDeltaTransform

Object

Преобразование CSV в Delta.

Имя	Тип	Описание
properties	CsvToDeltaTransformProperties	Свойства преобразования CSV в Delta.
type	string: csvToDelta	Тип преобразования. С течением времени могут добавляться дополнительные типы преобразований.

CsvToDeltaTransformProperties

Object

Свойства преобразования CSV в Delta.

Имя	Тип	Default value	Описание
delimiter	string	,	Указывает символ, используемый для разделения значений в строке в CSV-файле, и он должен указывать именно одно из поддерживаемых значений: `,`, , `\t`, `\|`, . `;&` Значение по умолчанию: `,`.
skipFilesWithErrors	boolean	True	Следует ли пропускать файлы с ошибками. True— пропускать файлы с ошибками, false — не пропускать файлы с ошибками. Значение по умолчанию — True.
useFirstRowAsHeader	boolean	True	Следует ли использовать первую строку CSV-файла в качестве заголовка. True. Используйте первую строку в качестве заголовка. False. Не используйте первую строку в качестве заголовка. Значение по умолчанию — True.

Dataverse

Object

Объект, содержащий свойства целевого источника данных Dataverse.

Имя	Тип	Описание
connectionId	string (uuid)	Строка, представляющая соединение, связанное с ярлыком. ConnectionId — это уникальный идентификатор, используемый для установления соединения между ярлыком и целевым источником данных. Чтобы найти этот идентификатор подключения, сначала создайте облачное подключение , которое будет использоваться ярлыком при подключении к расположению данных Dataverse. Откройте представление параметров облачного подключения и скопируйте идентификатор подключения; это GUID.
deltaLakeFolder	string	Указывает путь к папке DeltaLake, в которой хранятся целевые данные.
environmentDomain	string (uri)	URI, указывающий доменное имя целевой среды Dataverse. URI должен быть отформатирован как "https://[orgname].crm[xx].dynamics.com", где `[orgname]` представляет имя организации Dataverse.
tableName	string	Указывает имя целевой таблицы в Dataverse

ErrorRelatedResource

Object

Объект сведений об ошибках, связанных с ресурсом.

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса, участвующий в ошибке.
resourceType	string	Тип ресурса, который участвует в ошибке.

ErrorResponse

Object

Ответ на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
moreDetails	ErrorResponseDetails[]	Список дополнительных сведений об ошибке.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.
requestId	string	Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Object

Сведения об ответе на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.

ExternalDataShareTarget

Object

Объект, содержащий свойства целевого внешнего ресурса данных.

Имя	Тип	Описание
connectionId	string (uuid)	Строка, представляющая соединение, связанное с ярлыком. ConnectionId — это уникальный идентификатор, используемый для установления соединения между ярлыком и целевым источником данных.

GoogleCloudStorage

Object

Объект, содержащий свойства целевого источника данных Google Cloud Storage.

Имя	Тип	Описание
connectionId	string (uuid)	Строка, представляющая соединение, связанное с ярлыком. ConnectionId — это уникальный идентификатор, используемый для установления соединения между ярлыком и целевым источником данных.
location	string (uri)	URL-адрес HTTP, указывающий на целевой контейнер в GCS. URL-адрес должен находиться в формате https://[имя контейнера].storage.googleapis.com, где [имя контейнера] — это имя контейнера, на который нужно указать. Например: https://my-gcs-bucket.storage.googleapis.com
subpath	string	Указывает целевую папку или вложенную папку в контейнере GCS. Например: /folder

OneLake

Object

Объект, содержащий свойства целевого источника данных OneLake.

Имя	Тип	Описание
connectionId	string (uuid)	Строка, представляющая соединение, связанное с ярлыком. ConnectionId — это уникальный идентификатор, используемый для установления соединения между ярлыком и целевым источником данных. Чтобы найти этот идентификатор подключения, сначала создайте облачное подключение , которое будет использоваться ярлыком при подключении к расположению данных Amazon S3. Откройте представление параметров облачного подключения и скопируйте идентификатор подключения; это GUID.
itemId	string (uuid)	Идентификатор целевого объекта в OneLake. Целевой объект может быть элементом Lakehouse, KQLDatabase или Warehouse.
path	string	Строка, представляющая полный путь к целевой папке в элементе. Этот путь должен быть относительно корня структуры каталогов OneLake. Например: Tables/myTablesFolder/someTableSubFolder.
workspaceId	string (uuid)	Идентификатор целевой рабочей области.

S3Compatible

Object

Объект, содержащий свойства целевого источника данных, совместимого с S3.

Имя	Тип	Описание
bucket	string	Указывает целевой контейнер в расположении, совместимом с S3.
connectionId	string (uuid)	Строка, представляющая соединение, связанное с ярлыком. ConnectionId — это уникальный идентификатор, используемый для установления соединения между ярлыком и целевым источником данных.
location	string (uri)	HTTP-адрес совместимой конечной точки S3. Эта конечная точка должна иметь возможность получать вызовы API ListBuckets S3. URL-адрес должен находиться в формате, отличном от контейнера; здесь не следует указывать контейнер. Например: `https://s3endpoint.contoso.com`
subpath	string	Указывает целевую папку или вложенную папку в контейнере, совместимом с S3. Например: /folder

Shortcuts

Object

Имя	Тип	Описание
continuationToken	string	Маркер для следующего пакета результирующих наборов. Если больше записей нет, он удаляется из ответа.
continuationUri	string	Универсальный код ресурса (URI) следующего пакета результирующих наборов. Если больше записей нет, он удаляется из ответа.
value	ShortcutTransformFlagged[]	Список сочетаний клавиш.

ShortcutTransformFlagged

Object

Объект, представляющий ссылку, указывающую на другие расположения хранилища, которые могут быть внутренними или внешними для OneLake. Ярлык определяется по имени, пути, в котором создается ярлык и целевой объект, указывающий расположение целевого хранилища.

Имя	Тип	Описание
isShortcutTransform	boolean	Определяет, является ли этот ярлык ярлыком преобразования. True — преобразование ярлыка, false — обычный ярлык. Свойства преобразования ярлыка можно получить с помощью сочетания клавиш Get.
name	string	Имя ярлыка.
path	string	Строка, представляющая полный путь, в котором создается ярлык, включая "Файлы" или "Таблицы".
target	Target	Объект, содержащий целевой источник данных, и должен указывать именно один из поддерживаемых назначений.
transform	Transform: CsvToDeltaTransform	Объект, содержащий имя преобразования и соответствующие свойства, применяемые к целевым данным, и должен указывать именно один из поддерживаемых преобразований.

Target

Object

Объект, содержащий целевой источник данных, и должен указывать именно один из поддерживаемых назначений, как описано в таблице ниже.

Имя	Тип	Описание
adlsGen2	AdlsGen2	Объект, содержащий свойства целевого источника данных ADLS 2-го поколения.
amazonS3	AmazonS3	Объект, содержащий свойства целевого источника данных Amazon S3.
azureBlobStorage	AzureBlobStorage	Объект, содержащий свойства целевого источника данных хранилища BLOB-объектов Azure.
dataverse	Dataverse	Объект, содержащий свойства целевого источника данных Dataverse.
externalDataShare	ExternalDataShareTarget	Объект, содержащий свойства целевого внешнего ресурса данных.
googleCloudStorage	GoogleCloudStorage	Объект, содержащий свойства целевого источника данных Google Cloud Storage.
oneLake	OneLake	Объект, содержащий свойства целевого источника данных OneLake.
s3Compatible	S3Compatible	Объект, содержащий свойства целевого источника данных, совместимого с S3.
type	Type	Объект типа содержит свойства, такие как тип учетной записи целевого ярлыка. С течением времени могут добавляться дополнительные типы.

Type

Перечисление

Объект типа содержит свойства, такие как тип учетной записи целевого ярлыка. С течением времени могут добавляться дополнительные типы.

Значение	Описание
OneLake	OneLake
AmazonS3	AmazonS3
AdlsGen2	AdlsGen2
GoogleCloudStorage	GoogleCloudStorage
S3Compatible	S3Compatible
Dataverse	Dataverse
ExternalDataShare	ExternalDataShare
AzureBlobStorage	AzureBlobStorage

Поделиться через

OneLake Shortcuts - List Shortcuts

Обязательные делегированные области

Идентификаторы, поддерживаемые Microsoft Entra

Интерфейс

Параметры URI

Ответы

Примеры

List shortcuts example

Образец запроса

Пример ответа

List shortcuts with continuation example

Образец запроса

Пример ответа

List shortcuts with shortcut transforms example

Образец запроса

Пример ответа

Определения

AdlsGen2

AmazonS3

AzureBlobStorage

CsvToDeltaTransform

CsvToDeltaTransformProperties

Dataverse

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ExternalDataShareTarget

GoogleCloudStorage

OneLake

S3Compatible

Shortcuts

ShortcutTransformFlagged

Target

Type