共用方式為

OneLake Shortcuts - Create Shortcut

服務:
Core
API 版本:
v1

建立新的快捷方式或更新現有的快捷方式。

必要的委派範圍

OneLake.ReadWrite.All

Microsoft Entra 支援的身分識別

此 API 支援本節中列出的Microsoft 身分識別。

身份 支援
使用者 是的
服務主體 和 受控識別 是的

介面

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/shortcuts
含選擇性參數: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/shortcuts?shortcutConflictPolicy={shortcutConflictPolicy}

URI 參數

名稱 位於 必要 類型 Description
itemId
 path True

string (uuid)

數據項的標識碼。
workspaceId
 path True

string (uuid)

工作區的 ID。
shortcutConflictPolicy
 query

ShortcutConflictPolicy

提供時，它會定義當具有相同名稱和路徑的快捷方式已經存在時要採取的動作。 默認動作為 『Abort』。 可能會隨著時間新增其他 ShortcutConflictPolicy 類型。

要求本文

名稱 必要 類型 Description
name True

string

快捷方式的名稱。
path True

string

字串，表示建立快捷方式的完整路徑，包括「檔案」或「數據表」。
target True

CreatableShortcutTarget

一個包含目標資料來源的物件，且必須精確指定其中一個支援的目的地：OneLake、Amazon S3、ADLS Gen2、Google Cloud Storage、S3 相容性、Dataverse、Azure Blob 儲存或 OneDrive SharePoint。

回應

名稱 類型 Description
200 OK

Shortcut

已成功更新。

標題

Location: string
201 Created

Shortcut

已成功建立。

標題

Location: string
Other Status Codes

ErrorResponse

常見的錯誤碼：

  • ItemNotFound - 伺服器找不到要求的專案。

  • UnknownError - 發生錯誤。

範例

Create or update shortcut target to OneLake
Create shortcut AdlsGen2 target example
Create shortcut AmazonS3 target example
Create shortcut Azure Blob Storage target example
Create shortcut Google Cloud Storage target example
Create shortcut One Lake target example
Create shortcut OneDriveSharePoint or OneDrive for Business or SharePoint Online target example
Create shortcut S3 Compatible target example
Update shortcut target to OneLake

Create or update shortcut target to OneLake

範例要求

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

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

範例回覆

狀態碼:
200 
Location: https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/shortcuts/Files/blafolder/folder3/MyOneLakeShortcut
{
  "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"
    }
  }
}

Create shortcut AdlsGen2 target example

範例要求

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

{
  "path": "Files/landingZone",
  "name": "PartnerProducts",
  "target": {
    "adlsGen2": {
      "location": "https://contosoadlsaccount.dfs.core.windows.net",
      "subpath": "/mycontainer/data/ContosoProducts",
      "connectionId": "91324db9-8dc4-4730-a1e5-bafabf1fb91e"
    }
  }
}

範例回覆

狀態碼:
201 
Location: https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/shortcuts/Files/landingZone/PartnerProducts
{
  "path": "Files/landingZone",
  "name": "PartnerProducts",
  "target": {
    "type": "AdlsGen2",
    "adlsGen2": {
      "location": "https://contosoadlsaccount.dfs.core.windows.net",
      "subpath": "/mycontainer/data/ContosoProducts",
      "connectionId": "91324db9-8dc4-4730-a1e5-bafabf1fb91e"
    }
  }
}

Create shortcut AmazonS3 target example

範例要求

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

{
  "path": "Files/landingZone",
  "name": "PartnerEmployees",
  "target": {
    "amazonS3": {
      "location": "https://my-s3-bucket.s3.us-west-2.amazonaws.com",
      "subpath": "/data/ContosoEmployees",
      "connectionId": "cf480513-2c1c-46b2-958a-42556ee584c3"
    }
  }
}

範例回覆

狀態碼:
201 
Location: https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/shortcuts/Files/landingZone/PartnerEmployees
{
  "path": "Files/landingZone",
  "name": "PartnerEmployees",
  "target": {
    "type": "AmazonS3",
    "amazonS3": {
      "location": "https://my-s3-bucket.s3.us-west-2.amazonaws.com",
      "subpath": "/data/ContosoEmployees",
      "connectionId": "cf480513-2c1c-46b2-958a-42556ee584c3"
    }
  }
}

Create shortcut Azure Blob Storage target example

範例要求

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

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

範例回覆

狀態碼:
201 
Location: https://api.fabric.microsoft.com/v1/workspaces/bf94607f-3ba1-4a95-8259-27649ccd7755/items/884e71cd-f5b4-45f9-8e00-b71355f7ea5d/shortcuts/Files/MyAzureBlobStorage
{
  "path": "Files",
  "name": "MyAzureBlobStorage",
  "target": {
    "type": "AzureBlobStorage",
    "azureBlobStorage": {
      "location": "https://azureblobstoragetesting.blob.core.windows.net",
      "subpath": "/tables",
      "connectionId": "97e33458-1353-4911-96b1-6f4f4bbfd335"
    }
  }
}

Create shortcut Google Cloud Storage target example

範例要求

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

{
  "path": "Files/landingZone",
  "name": "MyGCSShortcut1",
  "target": {
    "googleCloudStorage": {
      "location": "https://gcs-contosoBucket.storage.googleapis.com",
      "subpath": "/gcsDirectory/data/ContosoProducts",
      "connectionId": "3c976446-0bda-472e-8800-f1d6e4f162dc"
    }
  }
}

範例回覆

狀態碼:
201 
Location: https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/shortcuts/Files/landingZone/MyGCSShortcut1
{
  "path": "Files/landingZone",
  "name": "MyGCSShortcut1",
  "target": {
    "type": "GoogleCloudStorage",
    "googleCloudStorage": {
      "location": "https://gcs-contosoBucket.storage.googleapis.com",
      "subpath": "/gcsDirectory/data/ContosoProducts",
      "connectionId": "3c976446-0bda-472e-8800-f1d6e4f162dc"
    }
  }
}

Create shortcut One Lake target example

範例要求

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

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

範例回覆

狀態碼:
201 
Location: https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/shortcuts/Files/blafolder/folder3/MyOneLakeShortcut
{
  "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"
    }
  }
}

Create shortcut OneDriveSharePoint or OneDrive for Business or SharePoint Online target example

範例要求

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

{
  "path": "Files",
  "name": "MyOneDriveSharePoint",
  "target": {
    "oneDriveSharePoint": {
      "location": "https://microsoft.sharepoint.com",
      "subpath": "/Shared Documents/Test Folder",
      "connectionId": "97e33458-1353-4911-96b1-6f4f4bbfd335"
    }
  }
}

範例回覆

狀態碼:
201 
Location: https://api.fabric.microsoft.com/v1/workspaces/bf94607f-3ba1-4a95-8259-27649ccd7755/items/884e71cd-f5b4-45f9-8e00-b71355f7ea5d/shortcuts/Files/MyOneDriveSharePoint
{
  "path": "Files",
  "name": "MyOneDriveSharePoint",
  "target": {
    "type": "OneDriveSharePoint",
    "oneDriveSharePoint": {
      "location": "https://microsoft.sharepoint.com",
      "subpath": "/Shared Documents/Test Folder",
      "connectionId": "97e33458-1353-4911-96b1-6f4f4bbfd335"
    }
  }
}

Create shortcut S3 Compatible target example

範例要求

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

{
  "path": "Files/landingZone",
  "name": "MyS3CompatibleShortcut1",
  "target": {
    "s3Compatible": {
      "location": "https://s3endpoint.contoso.com",
      "bucket": "contosoBucket1",
      "subpath": "/s3CompatibleDirectory/data/ContosoProducts",
      "connectionId": "3c976446-0bda-472e-8800-f1d6e4f162dc"
    }
  }
}

範例回覆

狀態碼:
201 
Location: https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/shortcuts/Files/landingZone/MyS3CompatibleShortcut1
{
  "path": "Files/landingZone",
  "name": "MyS3CompatibleShortcut1",
  "target": {
    "type": "S3Compatible",
    "s3Compatible": {
      "location": "https://s3endpoint.contoso.com",
      "bucket": "contosoBucket1",
      "subpath": "/s3CompatibleDirectory/data/ContosoProducts",
      "connectionId": "3c976446-0bda-472e-8800-f1d6e4f162dc"
    }
  }
}

Update shortcut target to OneLake

範例要求

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

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

範例回覆

狀態碼:
200 
Location: https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/shortcuts/Files/blafolder/folder3/MyOneLakeShortcut
{
  "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"
    }
  }
}

定義

名稱 Description
AdlsGen2

物件，包含目標 ADLS Gen2 數據源的屬性。
AmazonS3

物件，包含目標 Amazon S3 數據源的屬性。
AzureBlobStorage

物件，包含目標 Azure Blob 記憶體數據源的屬性。
CreatableShortcutTarget

物件，包含目標數據源，而且必須指定一個支援的目的地，如下表所述。
CreateShortcutRequest

具有物件代表另一個儲存位置參考的快捷方式建立要求。
CsvToDeltaTransform

CSV 到差異轉換。
CsvToDeltaTransformProperties

要進行差異轉換之 CSV 的屬性。
Dataverse

物件，包含目標 Dataverse 數據源的屬性。
ErrorRelatedResource

錯誤相關的資源詳細資料物件。
ErrorResponse

錯誤回應。
ErrorResponseDetails

錯誤回應詳細數據。
ExternalDataShareTarget

物件，包含目標外部數據共享的屬性。
GoogleCloudStorage

物件，包含目標Google Cloud Storage資料源的屬性。
OneDriveSharePoint

包含目標 OneDrive for Business 或 SharePoint Online 資料來源屬性的物件。
OneLake

物件，包含目標 OneLake 數據源的屬性。
S3Compatible

物件，包含目標 S3 相容數據源的屬性。
Shortcut

物件，表示指向 OneLake 內部或外部之其他儲存位置的參考。 快捷方式是由名稱、建立快捷方式的路徑以及指定目標儲存位置的目標所定義。
ShortcutConflictPolicy

提供時，它會定義當具有相同名稱和路徑的快捷方式已經存在時要採取的動作。 默認動作為 『Abort』。 可能會隨著時間新增其他 ShortcutConflictPolicy 類型。
Target

物件，包含目標數據源，而且必須指定一個支援的目的地，如下表所述。
Type

類型物件包含目標快捷方式帳戶類型之類的屬性。 可能會隨著時間新增其他類型。

AdlsGen2

Object

物件，包含目標 ADLS Gen2 數據源的屬性。

名稱 類型 Description
connectionId

string (uuid)

字串，表示與快捷方式系結的連接。 connectionId 是用來建立快捷方式與目標數據源之間連接的唯一標識符。 若要尋找此連線標識碼，請先 建立雲端連線 ，以在連線到 ADLS 資料位置時由快捷方式使用。 開啟雲端連線的 [設定] 檢視，並複製連線標識符;這是 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 數據源的屬性。

名稱 類型 Description
connectionId

string (uuid)

字串，表示與快捷方式系結的連接。 connectionId 是用來建立快捷方式與目標數據源之間連接的唯一標識符。 若要尋找此連線標識碼，請先 建立 連線到 Amazon S3 資料位置時快捷方式要使用的雲端連線。 開啟雲端連線的 [設定] 檢視，並複製連線標識符;這是 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 記憶體數據源的屬性。

名稱 類型 Description
connectionId

string (uuid)

字串，表示與快捷方式系結的連接。 connectionId 是用來建立快捷方式與目標數據源之間連接的唯一標識符。 若要尋找此連線標識碼，請先 建立雲端連線 ，以在連線到 Azure Blob 記憶體資料位置時由快捷方式使用。 開啟雲端連線的設定檢視，並複製 GUID，這是連線標識碼。
location

string (uri)

指定目標 Azure Blob 記憶體容器的位置。 URI 的格式 https://[account-name].blob.core.windows.net 必須是 ，其中 [account-name] 是目標 Azure Blob 記憶體帳戶的名稱。
subpath

string

指定目標資料夾所在 Azure Blob 記憶體帳戶內的容器和子資料夾。 必須是 [container]/[subfolder] 格式。 [容器] 是保存檔案和資料夾的容器名稱。 [子資料夾] 是容器內子資料夾的名稱，是選擇性的。 例如：/mycontainer/mysubfolder

CreatableShortcutTarget

Object

物件，包含目標數據源，而且必須指定一個支援的目的地，如下表所述。

名稱 類型 Description
adlsGen2

AdlsGen2

物件，包含目標 ADLS Gen2 數據源的屬性。
amazonS3

AmazonS3

物件，包含目標 Amazon S3 數據源的屬性。
azureBlobStorage

AzureBlobStorage

物件，包含目標 Azure Blob 記憶體數據源的屬性。
dataverse

Dataverse

物件，包含目標 Dataverse 數據源的屬性。
googleCloudStorage

GoogleCloudStorage

物件，包含目標Google Cloud Storage資料源的屬性。
oneDriveSharePoint

OneDriveSharePoint

一個包含目標 OneDrive for Business 與 SharePoint Online 資料來源屬性的物件。
oneLake

OneLake

物件，包含目標 OneLake 數據源的屬性。
s3Compatible

S3Compatible

物件，包含目標 S3 相容數據源的屬性。

CreateShortcutRequest

Object

具有物件代表另一個儲存位置參考的快捷方式建立要求。

名稱 類型 Description
name

string

快捷方式的名稱。
path

string

字串，表示建立快捷方式的完整路徑，包括「檔案」或「數據表」。
target

CreatableShortcutTarget

一個包含目標資料來源的物件，且必須精確指定其中一個支援的目的地：OneLake、Amazon S3、ADLS Gen2、Google Cloud Storage、S3 相容性、Dataverse、Azure Blob 儲存或 OneDrive SharePoint。

CsvToDeltaTransform

Object

CSV 到差異轉換。

名稱 類型 Description
properties

CsvToDeltaTransformProperties

CSV 到 Delta 轉換屬性。
type string:

csvToDelta

轉換的類型。 可能會隨著時間新增其他轉換類型。

CsvToDeltaTransformProperties

Object

要進行差異轉換之 CSV 的屬性。

名稱 類型 預設值 Description
delimiter

string

,

指定用來分隔 CSV 檔案中資料列內值的字元，而且它必須指定其中一個支援的值：,、、、 \t|、 &;。 預設值為 ,。
skipFilesWithErrors

boolean

True

是否略過發生錯誤的檔案。 True - 略過錯誤檔案，False - 不要略過有錯誤的檔案。 預設值為 True。
useFirstRowAsHeader

boolean

True

CSV 檔案的第一個數據列是否應該當做標頭使用。 True - 使用第一個數據列作為標頭。 False - 請勿使用第一個數據列作為標頭。 預設值為 True。

Dataverse

Object

物件，包含目標 Dataverse 數據源的屬性。

名稱 類型 Description
connectionId

string (uuid)

字串，表示與快捷方式系結的連接。 connectionId 是用來建立快捷方式與目標數據源之間連接的唯一標識符。 若要尋找此連線標識碼，請先 建立 連線到 Dataverse 數據位置時快捷方式要使用的雲端連線。 開啟雲端連線的 [設定] 檢視，並複製連線標識符;這是 GUID。
deltaLakeFolder

string

指定儲存目標數據的 DeltaLake 資料夾路徑。
environmentDomain

string (uri)

表示 Dataverse 目標環境的功能變數名稱的 URI。 URI 的格式應為 「https://[orgname].crm[xx].dynamics.com」。，其中 [orgname] 代表 Dataverse 組織的名稱。
tableName

string

指定 Dataverse 中目標數據表的名稱

ErrorRelatedResource

Object

錯誤相關的資源詳細資料物件。

名稱 類型 Description
resourceId

string

發生錯誤的資源識別碼。
resourceType

string

發生錯誤的資源類型。

ErrorResponse

Object

錯誤回應。

名稱 類型 Description
errorCode

string

提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message

string

錯誤的人類可讀取表示法。
moreDetails

ErrorResponseDetails[]

其他錯誤詳細數據的清單。
relatedResource

ErrorRelatedResource

錯誤相關的資源詳細數據。
requestId

string

與錯誤相關聯的要求標識碼。

ErrorResponseDetails

Object

錯誤回應詳細數據。

名稱 類型 Description
errorCode

string

提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message

string

錯誤的人類可讀取表示法。
relatedResource

ErrorRelatedResource

錯誤相關的資源詳細數據。

ExternalDataShareTarget

Object

物件，包含目標外部數據共享的屬性。

名稱 類型 Description
connectionId

string (uuid)

字串，表示與快捷方式系結的連接。 connectionId 是用來建立快捷方式與目標數據源之間連接的唯一標識符。

GoogleCloudStorage

Object

物件，包含目標Google Cloud Storage資料源的屬性。

名稱 類型 Description
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

OneDriveSharePoint

Object

包含目標 OneDrive for Business 或 SharePoint Online 資料來源屬性的物件。

名稱 類型 Description
connectionId

string (uuid)

字串，表示與快捷方式系結的連接。 connectionId 是用來建立快捷方式與目標數據源之間連接的唯一標識符。 要找到這個連線 ID，首先 建立一個雲端連線 ，讓捷徑在連接 OneDrive SharePoint 資料位置時使用。 開啟雲端連線的設定檢視，並複製 GUID，這是連線標識碼。
location

string (uri)

指定目標 OneDrive SharePoint 容器的位置。 URI 必須是目標 OneDrive SharePoint 帳號的路徑 https://microsoft.sharepoint.com 格式。
subpath

string

指定 OneDrive SharePoint 帳號中目標資料夾所在的容器和子資料夾。 必須是 [container]/[subfolder] 格式。 [容器] 是保存檔案和資料夾的容器名稱。 [子資料夾] 是容器內子資料夾的名稱，是選擇性的。 例如：/mycontainer/mysubfolder

OneLake

Object

物件，包含目標 OneLake 數據源的屬性。

名稱 類型 Description
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 相容數據源的屬性。

名稱 類型 Description
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 內部或外部之其他儲存位置的參考。 快捷方式是由名稱、建立快捷方式的路徑以及指定目標儲存位置的目標所定義。

名稱 類型 Description
name

string

快捷方式的名稱。
path

string

字串，表示建立快捷方式的完整路徑，包括「檔案」或「數據表」。
target

Target

物件，包含目標數據源，而且必須只指定其中一個支援的目的地。
transform Transform:

CsvToDeltaTransform

物件，其中包含要套用至目標數據的轉換名稱及其對應的屬性，而且必須指定其中一個支持的轉換。

ShortcutConflictPolicy

列舉型別

提供時，它會定義當具有相同名稱和路徑的快捷方式已經存在時要採取的動作。 默認動作為 『Abort』。 可能會隨著時間新增其他 ShortcutConflictPolicy 類型。

值 Description
Abort

當具有相同名稱和路徑的快捷方式已經存在時，將會取消快捷方式建立。
GenerateUniqueName

當具有相同名稱和路徑的快捷方式已經存在時，快捷方式建立會繼續以新的唯一快捷方式名稱。
CreateOrOverwrite

當具有相同名稱和路徑的快捷方式已經存在時，快捷方式建立將會覆寫現有的快捷方式。 如果不存在，請建立快捷方式。
OverwriteOnly

當具有相同名稱和路徑的快捷方式已經存在時，快捷方式建立將會覆寫現有的快捷方式。

Target

Object

物件，包含目標數據源，而且必須指定一個支援的目的地，如下表所述。

名稱 類型 Description
adlsGen2

AdlsGen2

物件，包含目標 ADLS Gen2 數據源的屬性。
amazonS3

AmazonS3

物件，包含目標 Amazon S3 數據源的屬性。
azureBlobStorage

AzureBlobStorage

物件，包含目標 Azure Blob 記憶體數據源的屬性。
dataverse

Dataverse

物件，包含目標 Dataverse 數據源的屬性。
externalDataShare

ExternalDataShareTarget

物件，包含目標外部數據共享的屬性。
googleCloudStorage

GoogleCloudStorage

物件，包含目標Google Cloud Storage資料源的屬性。
oneDriveSharePoint

OneDriveSharePoint

一個包含目標 OneDrive for Business 與 SharePoint Online 資料來源屬性的物件。
oneLake

OneLake

物件，包含目標 OneLake 數據源的屬性。
s3Compatible

S3Compatible

物件，包含目標 S3 相容數據源的屬性。
type

Type

類型物件包含目標快捷方式帳戶類型之類的屬性。 可能會隨著時間新增其他類型。

Type

列舉型別

類型物件包含目標快捷方式帳戶類型之類的屬性。 可能會隨著時間新增其他類型。

值 Description
OneLake

OneLake
AmazonS3

AmazonS3
AdlsGen2

AdlsGen2
GoogleCloudStorage

Google雲存儲
S3Compatible

S3Compatible
Dataverse

Dataverse
ExternalDataShare

ExternalDataShare
AzureBlobStorage

AzureBlobStorage
OneDriveSharePoint

OneDriveSharePoint