OneLake Shortcuts - Creates Shortcuts In Bulk

服务:: Core

API 版本:: v1

创建批量快捷方式。

Note

此 API 是预览版的一部分，仅用于评估和开发目的。它可能会根据反馈进行更改，不建议将其用于生产。

此 API 支持长时间运行的作（LRO）。

所需的委派范围

OneLake.ReadWrite.All

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识。

Identity	Support
User	Yes
服务主体和托管标识	Yes

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/shortcuts/bulkCreate

具有可选参数:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/shortcuts/bulkCreate?shortcutConflictPolicy={shortcutConflictPolicy}

URI 参数

名称	在	必需	类型	说明
itemId	path	True	string (uuid)	数据项的 ID。
workspaceId	path	True	string (uuid)	工作区 ID。
shortcutConflictPolicy	query		ShortcutConflictPolicy	提供时，它定义在具有相同名称和路径的快捷方式已存在时要执行的作。默认作为“中止”。可能会随着时间的推移添加其他 ShortcutConflictPolicy 类型。

请求正文

名称	必需	类型	说明
createShortcutRequests	True	CreateShortcutWithTransformRequest[]	快捷方式创建请求的列表。

响应

名称	类型	说明
200 OK	BulkCreateShortcutResponse	请求成功完成。
202 Accepted		请求已接受。快捷方式创建正在进行中。标头 Location: string Retry-After: integer x-ms-operation-id: string
Other Status Codes	ErrorResponse	常见错误代码： ItemNotFound - 服务器找不到请求的项目。 UnknownError - 发生错误。

名称

类型

说明

200 OK

BulkCreateShortcutResponse

请求成功完成。

202 Accepted

请求已接受。快捷方式创建正在进行中。

标头

Location: string
Retry-After: integer
x-ms-operation-id: string

Other Status Codes

ErrorResponse

常见错误代码：

ItemNotFound - 服务器找不到请求的项目。
UnknownError - 发生错误。

示例

Create bulk shortcut example

示例请求

HTTP

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

{
  "createShortcutRequests": [
    {
      "path": "Files/blafolder/folder1",
      "name": "OneLakeShortcut1",
      "target": {
        "oneLake": {
          "workspaceId": "acafbeb1-8037-4d0c-896e-a46fb27ff256",
          "itemId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
          "path": "Tables/myTablesFolder/someTableSubFolder",
          "connectionId": "4c868756-f7ce-4df1-8198-b1e5225b668f"
        }
      },
      "transform": {
        "type": "csvToDelta",
        "properties": {
          "delimiter": ",",
          "skipFilesWithErrors": true,
          "useFirstRowAsHeader": true
        }
      }
    },
    {
      "path": "Files/blafolder/folder2",
      "name": "OneLakeShortcut2",
      "target": {
        "oneLake": {
          "workspaceId": "acafbeb1-8037-4d0c-896e-a46fb27ff256",
          "itemId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
          "path": "Tables/myTablesFolder/someTableSubFolder",
          "connectionId": "4c868756-f7ce-4df1-8198-b1e5225b668f"
        }
      },
      "transform": {
        "type": "csvToDelta",
        "properties": {
          "delimiter": ",",
          "skipFilesWithErrors": true,
          "useFirstRowAsHeader": true
        }
      }
    },
    {
      "path": "Files/blafolder/folder3",
      "name": "OneLakeShortcut3",
      "target": {
        "oneLake": {
          "workspaceId": "acafbeb1-8037-4d0c-896e-a46fb27ff256",
          "itemId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
          "path": "Tables/myTablesFolder/someTableSubFolder"
        }
      }
    }
  ]
}

示例响应

状态代码:: 202

Location: https://api.fabric.microsoft.com/v1/operations/c424214a-4417-4ada-a9d8-9c2eae0ed0c3
x-ms-operation-id: c424214a-4417-4ada-a9d8-9c2eae0ed0c3
Retry-After: 1

状态代码:: 200

{
  "value": [
    {
      "request": {
        "path": "Files/blafolder/folder1",
        "name": "OneLakeShortcut1"
      },
      "result": {
        "path": "Files/blafolder/folder3",
        "name": "OneLakeShortcut1",
        "target": {
          "type": "OneLake",
          "oneLake": {
            "workspaceId": "acafbeb1-8037-4d0c-896e-a46fb27ff256",
            "itemId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
            "path": "Tables/myTablesFolder/someTableSubFolder",
            "connectionId": "4c868756-f7ce-4df1-8198-b1e5225b668f"
          }
        },
        "transform": {
          "type": "csvToDelta",
          "properties": {
            "delimiter": ",",
            "skipFilesWithErrors": true,
            "useFirstRowAsHeader": true
          }
        }
      },
      "status": "Succeeded"
    },
    {
      "request": {
        "path": "Files/blafolder/folder2",
        "name": "OneLakeShortcut3"
      },
      "error": {
        "errorCode": "ShorcutsOperationNotAllowed",
        "message": "Shortcut operation set to abort and shortcut with same name already exists."
      },
      "transform": {
        "type": "csvToDelta",
        "properties": {
          "delimiter": ",",
          "skipFilesWithErrors": true,
          "useFirstRowAsHeader": true
        }
      },
      "status": "Failed"
    },
    {
      "request": {
        "path": "Files/blafolder/folder3",
        "name": "OneLakeShortcut3"
      },
      "result": {
        "path": "Files/blafolder/folder3",
        "name": "OneLakeShortcut3",
        "target": {
          "type": "OneLake",
          "oneLake": {
            "workspaceId": "acafbeb1-8037-4d0c-896e-a46fb27ff256",
            "itemId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
            "path": "Tables/myTablesFolder/someTableSubFolder"
          }
        }
      },
      "status": "Succeeded"
    }
  ]
}

定义

名称	说明
AdlsGen2	包含目标 ADLS Gen2 数据源的属性的对象。
AmazonS3	包含目标 Amazon S3 数据源的属性的对象。
AzureBlobStorage	包含目标 Azure Blob 存储数据源的属性的对象。
BulkCreateShortcutResponse	与所请求的快捷方式创建请求相对应的 CreateShortcutResponse 集合。
BulkCreateShortcutsRequest	创建快捷方式请求的列表。
CreatableShortcutTarget	一个包含目标数据源的对象，必须指定一个受支持的目标，如下表所述。
CreateShortcutResponse	一个对象，其中包含原始快捷请求、实际快捷方式创建元数据、快捷方式创建状态以及是否存在任何关联的错误。
CreateShortcutWithTransformRequest	一个快捷方式创建请求，该请求的对象表示对另一个存储位置的引用。
CsvToDeltaTransform	CSV 到增量转换。
CsvToDeltaTransformProperties	CSV 到增量转换的属性。
Dataverse	包含目标 Dataverse 数据源的属性的对象。
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
ExternalDataShareTarget	包含目标外部数据共享的属性的对象。
GoogleCloudStorage	包含目标 Google Cloud Storage 数据源的属性的对象。
OneLake	包含目标 OneLake 数据源的属性的对象。
Request	包含原始快捷方式名称和路径的对象
S3Compatible	包含目标 S3 兼容数据源的属性的对象。
Shortcut	表示指向其他存储位置（可以是 OneLake 内部或外部）的引用的对象。快捷方式由名称、创建快捷方式的路径以及指定目标存储位置的目标定义。
ShortcutConflictPolicy	提供时，它定义在具有相同名称和路径的快捷方式已存在时要执行的作。默认作为“中止”。可能会随着时间的推移添加其他 ShortcutConflictPolicy 类型。
Status	创建快捷方式的状态。可能会随着时间的推移添加其他状态。
Target	一个包含目标数据源的对象，必须指定一个受支持的目标，如下表所述。
Type	类型对象包含目标快捷方式帐户类型等属性。可能会随着时间的推移添加其他类型。

AdlsGen2

Object

包含目标 ADLS Gen2 数据源的属性的对象。

名称	类型	说明
connectionId	string (uuid)	一个字符串，表示与快捷方式绑定的连接。 connectionId 是用于在快捷方式与目标数据源之间建立连接的唯一标识符。若要查找此连接 ID，请先创建一个云连接，以在连接到 ADLS 数据位置时由快捷方式使用。打开云连接的“设置”视图并复制连接 ID;这是 GUID。
location	string (uri)	指定目标 ADLS 容器的位置。 URI 的格式必须为 https://[account-name].dfs.core.windows.net，其中 [account-name] 是目标 ADLS 帐户的名称。
subpath	string	指定目标文件夹所在的 ADLS 帐户中的容器和子文件夹。必须是格式 [container]/[subfolder]，其中 [container] 是保存文件和文件夹的容器的名称;[子文件夹] 是容器中子文件夹的名称（可选）。例如：/mycontainer/mysubfolder

AmazonS3

Object

包含目标 Amazon S3 数据源的属性的对象。

名称	类型	说明
connectionId	string (uuid)	一个字符串，表示与快捷方式绑定的连接。 connectionId 是用于在快捷方式与目标数据源之间建立连接的唯一标识符。若要查找此连接 ID，请先创建一个云连接，以在连接到 Amazon S3 数据位置时由快捷方式使用。打开云连接的“设置”视图并复制连接 ID;这是 GUID。
location	string (uri)	指向 S3 中目标存储桶的 HTTP URL。 URL 的格式应为 https://[bucket-name].s3。[region-code].amazonaws.com，其中“bucket-name”是要指向的 S3 存储桶的名称，“region-code”是存储桶所在的区域的代码。例如：https://my-s3-bucket.s3.us-west-2.amazonaws.com
subpath	string	指定 S3 存储桶中的目标文件夹或子文件夹。

AzureBlobStorage

Object

包含目标 Azure Blob 存储数据源的属性的对象。

名称	类型	说明
connectionId	string (uuid)	一个字符串，表示与快捷方式绑定的连接。 connectionId 是用于在快捷方式与目标数据源之间建立连接的唯一标识符。若要查找此连接 ID，请先创建一个云连接，以在连接到 Azure Blob 存储数据位置时由快捷方式使用。打开云连接的设置视图，并复制连接 ID 的 GUID。
location	string (uri)	指定目标 Azure Blob 存储容器的位置。 URI 必须采用目标 `https://[account-name].blob.core.windows.net` Azure Blob 存储帐户的名称的格式`[account-name]`。
subpath	string	指定目标文件夹所在的 Azure Blob 存储帐户中的容器和子文件夹。格式必须为 [container]/[subfolder]。 [容器] 是保存文件和文件夹的容器的名称。 [子文件夹] 是容器中子文件夹的名称，是可选的。例如：/mycontainer/mysubfolder

BulkCreateShortcutResponse

Object

与所请求的快捷方式创建请求相对应的 CreateShortcutResponse 集合。

名称	类型	说明
value	CreateShortcutResponse[]	创建快捷方式响应的列表。

BulkCreateShortcutsRequest

Object

创建快捷方式请求的列表。

名称	类型	说明
createShortcutRequests	CreateShortcutWithTransformRequest[]	快捷方式创建请求的列表。

CreatableShortcutTarget

Object

一个包含目标数据源的对象，必须指定一个受支持的目标，如下表所述。

名称	类型	说明
adlsGen2	AdlsGen2	包含目标 ADLS Gen2 数据源的属性的对象。
amazonS3	AmazonS3	包含目标 Amazon S3 数据源的属性的对象。
azureBlobStorage	AzureBlobStorage	包含目标 Azure Blob 存储数据源的属性的对象。
dataverse	Dataverse	包含目标 Dataverse 数据源的属性的对象。
googleCloudStorage	GoogleCloudStorage	包含目标 Google Cloud Storage 数据源的属性的对象。
oneLake	OneLake	包含目标 OneLake 数据源的属性的对象。
s3Compatible	S3Compatible	包含目标 S3 兼容数据源的属性的对象。

CreateShortcutResponse

Object

一个对象，其中包含原始快捷请求、实际快捷方式创建元数据、快捷方式创建状态以及是否存在任何关联的错误。

名称	类型	说明
error	ErrorResponse	作处于失败状态时的错误详细信息
request	Request	包含原始快捷方式名称和路径的对象
result	Shortcut	包含快捷方式属性和创建快捷方式名称的对象。
status	Status	创建快捷方式的状态。可能会随着时间的推移添加其他状态。

CreateShortcutWithTransformRequest

Object

一个快捷方式创建请求，该请求的对象表示对另一个存储位置的引用。

名称	类型	说明
name	string	快捷方式的名称。
path	string	一个字符串，表示在其中创建快捷方式的完整路径，包括“文件”或“表”。
target	CreatableShortcutTarget	一个包含目标数据源的对象，它必须准确指定一个受支持的目标：OneLake、Amazon S3、ADLS Gen2、Google Cloud Storage、S3 兼容、Dataverse 或 Azure Blob 存储。
transform	Transform: CsvToDeltaTransform	一个对象，该对象包含要应用于目标数据的转换名称及其相应的属性，并且必须指定支持的转换之一：CsvToDelta

CsvToDeltaTransform

Object

CSV 到增量转换。

名称	类型	说明
properties	CsvToDeltaTransformProperties	CSV 到 Delta 转换属性。
type	string: csvToDelta	转换的类型。可能会随着时间的推移添加其他转换类型。

CsvToDeltaTransformProperties

Object

CSV 到增量转换的属性。

名称	类型	默认值	说明
delimiter	string	,	指定用于分隔 CSV 文件中某行中的值的字符，并且它必须指定受支持的值之一：`,`、、、 `\t`、`\|`、。 `&;` 默认值为 `,`。
skipFilesWithErrors	boolean	True	是否跳过出现错误的文件。 True - 跳过包含错误的文件，False - 不要跳过包含错误的文件。默认值为 True。
useFirstRowAsHeader	boolean	True	CSV 文件的第一行是否应用作标头。 True - 使用第一行作为标题。 False - 请勿将第一行用作标题。默认值为 True。

Dataverse

Object

包含目标 Dataverse 数据源的属性的对象。

名称	类型	说明
connectionId	string (uuid)	一个字符串，表示与快捷方式绑定的连接。 connectionId 是用于在快捷方式与目标数据源之间建立连接的唯一标识符。若要查找此连接 ID，请先创建一个云连接，以在连接到 Dataverse 数据位置时由快捷方式使用。打开云连接的“设置”视图并复制连接 ID;这是 GUID。
deltaLakeFolder	string	指定存储目标数据的 DeltaLake 文件夹路径。
environmentDomain	string (uri)	指示 Dataverse 目标环境的域名的 URI。 URI 的格式应为“https://[orgname].crm[xx].dynamics.com”，其中 `[orgname]` 表示 Dataverse 组织的名称。
tableName	string	指定 Dataverse 中目标表的名称

ErrorRelatedResource

Object

与错误相关的资源详细信息对象。

名称	类型	说明
resourceId	string	错误中涉及的资源 ID。
resourceType	string	错误中涉及的资源的类型。

ErrorResponse

Object

错误响应。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
moreDetails	ErrorResponseDetails[]	其他错误详细信息的列表。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。
requestId	string	与错误关联的请求的 ID。

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)	指向 GCS 中目标存储桶的 HTTP URL。 URL 的格式应为 https://[bucket-name].storage.googleapis.com，其中 [bucket-name] 是要指向的存储桶的名称。例如：https://my-gcs-bucket.storage.googleapis.com
subpath	string	指定 GCS 存储桶中的目标文件夹或子文件夹。例如：/folder

OneLake

Object

包含目标 OneLake 数据源的属性的对象。

名称	类型	说明
connectionId	string (uuid)	一个字符串，表示与快捷方式绑定的连接。 connectionId 是用于在快捷方式与目标数据源之间建立连接的唯一标识符。若要查找此连接 ID，请先创建一个云连接，以在连接到 Amazon S3 数据位置时由快捷方式使用。打开云连接的“设置”视图并复制连接 ID;这是 GUID。
itemId	string (uuid)	OneLake 中目标的 ID。目标可以是 Lakehouse、KQLDatabase 或 Warehouse 的项。
path	string	一个字符串，表示项中目标文件夹的完整路径。此路径应相对于 OneLake 目录结构的根目录。例如：“Tables/myTablesFolder/someTableSubFolder”。
workspaceId	string (uuid)	目标工作区的 ID。

Request

Object

包含原始快捷方式名称和路径的对象

名称	类型	说明
name	string	快捷方式的名称。
path	string	一个字符串，表示在其中创建快捷方式的完整路径，包括“文件”或“表”。

S3Compatible

Object

包含目标 S3 兼容数据源的属性的对象。

名称	类型	说明
bucket	string	指定 S3 兼容位置中的目标存储桶。
connectionId	string (uuid)	一个字符串，表示与快捷方式绑定的连接。 connectionId 是用于在快捷方式与目标数据源之间建立连接的唯一标识符。
location	string (uri)	S3 兼容终结点的 HTTP URL。此终结点必须能够接收 ListBuckets S3 API 调用。 URL 必须采用非存储桶特定格式;此处不应指定存储桶。例如：`https://s3endpoint.contoso.com`
subpath	string	指定 S3 兼容存储桶中的目标文件夹或子文件夹。例如：/folder

Shortcut

Object

表示指向其他存储位置（可以是 OneLake 内部或外部）的引用的对象。快捷方式由名称、创建快捷方式的路径以及指定目标存储位置的目标定义。

名称	类型	说明
name	string	快捷方式的名称。
path	string	一个字符串，表示在其中创建快捷方式的完整路径，包括“文件”或“表”。
target	Target	一个包含目标数据源的对象，必须完全指定一个受支持的目标。
transform	Transform: CsvToDeltaTransform	一个对象，该对象包含要应用于目标数据的转换名称及其相应的属性，并且必须指定支持的转换之一。

ShortcutConflictPolicy

枚举

提供时，它定义在具有相同名称和路径的快捷方式已存在时要执行的作。默认作为“中止”。可能会随着时间的推移添加其他 ShortcutConflictPolicy 类型。

值	说明
Abort	如果已存在同名和路径的快捷方式，将取消快捷方式创建。
GenerateUniqueName	当具有相同名称和路径的快捷方式已经存在时，快捷方式创建将继续使用新的唯一快捷方式名称。
CreateOrOverwrite	当具有相同名称和路径的快捷方式已经存在时，快捷方式创建将覆盖现有快捷方式。创建快捷方式（如果不存在）。
OverwriteOnly	当具有相同名称和路径的快捷方式已经存在时，快捷方式创建将覆盖现有快捷方式。

Status

枚举

创建快捷方式的状态。可能会随着时间的推移添加其他状态。

值	说明
Succeeded	作已成功完成。
Failed	作失败。

Target

Object

一个包含目标数据源的对象，必须指定一个受支持的目标，如下表所述。

名称	类型	说明
adlsGen2	AdlsGen2	包含目标 ADLS Gen2 数据源的属性的对象。
amazonS3	AmazonS3	包含目标 Amazon S3 数据源的属性的对象。
azureBlobStorage	AzureBlobStorage	包含目标 Azure Blob 存储数据源的属性的对象。
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 - Creates Shortcuts In Bulk

所需的委派范围

Microsoft Entra 支持的标识

Interface

URI 参数

请求正文

响应

示例

Create bulk shortcut example

示例请求

示例响应

定义

AdlsGen2

AmazonS3

AzureBlobStorage

BulkCreateShortcutResponse

BulkCreateShortcutsRequest

CreatableShortcutTarget

CreateShortcutResponse

CreateShortcutWithTransformRequest

CsvToDeltaTransform

CsvToDeltaTransformProperties

Dataverse

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ExternalDataShareTarget

GoogleCloudStorage

OneLake

Request

S3Compatible

Shortcut

ShortcutConflictPolicy

Status

Target

Type