OneLake Shortcuts - Creates Shortcuts In Bulk
一括ショートカットを作成します。
Note
この API はプレビュー リリースの一部であり、評価と開発のみを目的として提供されます。 フィードバックに基づいて変更される可能性があり、運用環境での使用はお勧めしません。
この API は、実行時間の長い操作 (LRO)をサポートします。
必要な委任されたスコープ
OneLake.ReadWrite.All
Microsoft Entra でサポートされている ID
この API では、このセクションに記載されている Microsoft ID がサポートされています。
| Identity | Support |
|---|---|
| User | Yes |
| サービス プリンシパルとマネージド ID | 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 パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
item
|
path | True |
string (uuid) |
データ項目の ID。 |
|
workspace
|
path | True |
string (uuid) |
ワークスペースの ID。 |
|
shortcut
|
query |
指定すると、同じ名前とパスを持つショートカットが既に存在する場合に実行するアクションが定義されます。 既定のアクションは 'Abort' です。 追加の ShortcutConflictPolicy 型は、時間の経過と同時に追加される場合があります。 |
要求本文
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| createShortcutRequests | True |
ショートカット作成要求の一覧。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
要求は正常に完了しました。 |
|
| 202 Accepted |
要求は受け入れ済み。 ショートカットの作成が進行中です。 ヘッダー
|
|
| Other Status Codes |
一般的なエラー コード:
|
例
Create bulk shortcut example
要求のサンプル
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"
}
}
}
]
}
応答のサンプル
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
{
"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"
}
]
}
定義
| 名前 | 説明 |
|---|---|
|
Adls |
ターゲット ADLS Gen2 データ ソースのプロパティを含むオブジェクト。 |
| AmazonS3 |
ターゲット Amazon S3 データ ソースのプロパティを含むオブジェクト。 |
|
Azure |
ターゲットの Azure Blob Storage データ ソースのプロパティを含むオブジェクト。 |
|
Bulk |
要求されたショートカット作成要求に対応する CreateShortcutResponse のコレクション。 |
|
Bulk |
ショートカットの作成要求の一覧。 |
|
Creatable |
ターゲット データソースを含むオブジェクト。次の表に示すように、サポートされている変換先の 1 つを正確に指定する必要があります。 |
|
Create |
元のショートカット要求、実際のショートカット作成メタデータ、ショートカット作成の状態、および関連するエラーがある場合を含むオブジェクト。 |
|
Create |
別の保存場所への参照を表すオブジェクトを含むショートカット作成要求。 |
|
Csv |
CSV から Delta への変換。 |
|
Csv |
CSV から Delta への変換のプロパティ。 |
| Dataverse |
ターゲットの Dataverse データ ソースのプロパティを含むオブジェクト。 |
|
Error |
エラー関連のリソース詳細オブジェクト。 |
|
Error |
エラー応答。 |
|
Error |
エラー応答の詳細。 |
|
External |
ターゲット外部データ共有のプロパティを含むオブジェクト。 |
|
Google |
ターゲットの Google Cloud Storage データ ソースのプロパティを含むオブジェクト。 |
|
One |
ターゲットの OneLake データ ソースのプロパティを含むオブジェクト。 |
| Request |
元のショートカット名とパスを含むオブジェクト |
| S3Compatible |
ターゲット S3 互換データ ソースのプロパティを含むオブジェクト。 |
| Shortcut |
OneLake の内部または外部の他のストレージの場所を指す参照を表すオブジェクト。 ショートカットは、名前、ショートカットが作成されるパス、およびターゲットストレージの場所を指定するターゲットによって定義されます。 |
|
Shortcut |
指定すると、同じ名前とパスを持つショートカットが既に存在する場合に実行するアクションが定義されます。 既定のアクションは 'Abort' です。 追加の ShortcutConflictPolicy 型は、時間の経過と同時に追加される場合があります。 |
| Status |
ショートカットの作成の状態。 追加の状態は、時間の経過と同時に追加される場合があります。 |
| Target |
ターゲット データソースを含むオブジェクト。次の表に示すように、サポートされている変換先の 1 つを正確に指定する必要があります。 |
| Type |
type オブジェクトには、ターゲット ショートカット アカウントの種類などのプロパティが含まれています。 追加の型は、時間の経過と同時に追加される場合があります。 |
AdlsGen2
ターゲット 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]/[サブフォルダー] の形式である必要があります。ここで、[container] はファイルとフォルダーを保持するコンテナーの名前です。[サブフォルダー] は、コンテナー内のサブフォルダーの名前です (省略可能)。 例: /mycontainer/mysubfolder |
AmazonS3
ターゲット 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
ターゲットの Azure Blob Storage データ ソースのプロパティを含むオブジェクト。
| 名前 | 型 | 説明 |
|---|---|---|
| connectionId |
string (uuid) |
ショートカットにバインドされている接続を表す文字列。 connectionId は、ショートカットとターゲット データソースの間の接続を確立するために使用される一意の識別子です。 この接続 ID を見つけるには、まず、Azure Blob Storage データの場所に接続するときに、ショートカットによって使用される クラウド接続を作成 します。 クラウド接続の設定ビューを開き、接続 ID である GUID をコピーします。 |
| location |
string (uri) |
ターゲットの Azure Blob Storage コンテナーの場所を指定します。 URI は |
| subpath |
string |
ターゲット フォルダーが配置されている Azure Blob Storage アカウント内のコンテナーとサブフォルダーを指定します。 [container]/[subfolder]の形式である必要があります。 [コンテナー] は、ファイルとフォルダーを保持するコンテナーの名前です。 [サブフォルダー] はコンテナー内のサブフォルダーの名前であり、省略可能です。 例: /mycontainer/mysubfolder |
BulkCreateShortcutResponse
要求されたショートカット作成要求に対応する CreateShortcutResponse のコレクション。
| 名前 | 型 | 説明 |
|---|---|---|
| value |
ショートカットの作成応答の一覧。 |
BulkCreateShortcutsRequest
ショートカットの作成要求の一覧。
| 名前 | 型 | 説明 |
|---|---|---|
| createShortcutRequests |
ショートカット作成要求の一覧。 |
CreatableShortcutTarget
ターゲット データソースを含むオブジェクト。次の表に示すように、サポートされている変換先の 1 つを正確に指定する必要があります。
| 名前 | 型 | 説明 |
|---|---|---|
| adlsGen2 |
ターゲット ADLS Gen2 データ ソースのプロパティを含むオブジェクト。 |
|
| amazonS3 |
ターゲット Amazon S3 データ ソースのプロパティを含むオブジェクト。 |
|
| azureBlobStorage |
ターゲットの Azure Blob Storage データ ソースのプロパティを含むオブジェクト。 |
|
| dataverse |
ターゲットの Dataverse データ ソースのプロパティを含むオブジェクト。 |
|
| googleCloudStorage |
ターゲットの Google Cloud Storage データ ソースのプロパティを含むオブジェクト。 |
|
| oneLake |
ターゲットの OneLake データ ソースのプロパティを含むオブジェクト。 |
|
| s3Compatible |
ターゲット S3 互換データ ソースのプロパティを含むオブジェクト。 |
CreateShortcutResponse
元のショートカット要求、実際のショートカット作成メタデータ、ショートカット作成の状態、および関連するエラーがある場合を含むオブジェクト。
| 名前 | 型 | 説明 |
|---|---|---|
| error |
操作が失敗状態の場合のエラーの詳細 |
|
| request |
元のショートカット名とパスを含むオブジェクト |
|
| result |
ショートカット プロパティと作成されたショートカット名を含むオブジェクト。 |
|
| status |
ショートカットの作成の状態。 追加の状態は、時間の経過と同時に追加される場合があります。 |
CreateShortcutWithTransformRequest
別の保存場所への参照を表すオブジェクトを含むショートカット作成要求。
| 名前 | 型 | 説明 |
|---|---|---|
| name |
string |
ショートカットの名前。 |
| path |
string |
ショートカットが作成される完全なパスを表す文字列 ("Files" または "Tables" を含む)。 |
| target |
ターゲット データソースを含むオブジェクト。サポートされている宛先の 1 つ (OneLake、Amazon S3、ADLS Gen2、Google Cloud Storage、S3 互換、Dataverse、または Azure Blob Storage) を正確に指定する必要があります。 |
|
| transform | Transform: |
ターゲット データに適用する変換名とそれに対応するプロパティを含むオブジェクト。サポートされている変換の 1 つだけを指定する必要があります: CsvToDelta |
CsvToDeltaTransform
CSV から Delta への変換。
| 名前 | 型 | 説明 |
|---|---|---|
| properties |
CSV から Delta への変換プロパティ。 |
|
| type |
string:
csv |
変換の種類。 変換の種類は、時間の経過と同時に追加される場合があります。 |
CsvToDeltaTransformProperties
CSV から Delta への変換のプロパティ。
| 名前 | 型 | 規定値 | 説明 |
|---|---|---|---|
| delimiter |
string |
, |
CSV ファイル内の行内の値を区切るために使用する文字を指定し、サポートされている値の 1 つ ( |
| skipFilesWithErrors |
boolean |
True |
エラーのあるファイルをスキップするかどうか。 True - エラーのあるファイルをスキップします。False - エラーのあるファイルをスキップしないでください。 既定値は True です。 |
| useFirstRowAsHeader |
boolean |
True |
CSV ファイルの最初の行をヘッダーとして使用するかどうかを指定します。 True - 先頭行をヘッダーとして使用します。 False - 先頭行をヘッダーとして使用しないでください。 既定値は True です。 |
Dataverse
ターゲットの Dataverse データ ソースのプロパティを含むオブジェクト。
| 名前 | 型 | 説明 |
|---|---|---|
| connectionId |
string (uuid) |
ショートカットにバインドされている接続を表す文字列。 connectionId は、ショートカットとターゲット データソースの間の接続を確立するために使用される一意の識別子です。 この接続 ID を見つけるには、まず、Dataverse データの場所に接続するときに、ショートカットによって使用される クラウド接続を作成 します。 クラウド接続の [設定] ビューを開き、接続 ID をコピーします。これは GUID です。 |
| deltaLakeFolder |
string |
ターゲット データが格納される DeltaLake フォルダー パスを指定します。 |
| environmentDomain |
string (uri) |
Dataverse ターゲット環境のドメイン名を示す URI。 URI は "https://[orgname].crm[xx].dynamics.com" として書式設定する必要があります。ここで、 |
| tableName |
string |
Dataverse のターゲット テーブルの名前を指定します。 |
ErrorRelatedResource
エラー関連のリソース詳細オブジェクト。
| 名前 | 型 | 説明 |
|---|---|---|
| resourceId |
string |
エラーに関係するリソース ID。 |
| resourceType |
string |
エラーに関係するリソースの種類。 |
ErrorResponse
エラー応答。
| 名前 | 型 | 説明 |
|---|---|---|
| errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
| message |
string |
エラーの人間が判読できる表現。 |
| moreDetails |
その他のエラーの詳細の一覧。 |
|
| relatedResource |
エラー関連のリソースの詳細。 |
|
| requestId |
string |
エラーに関連付けられている要求の ID。 |
ErrorResponseDetails
エラー応答の詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
| message |
string |
エラーの人間が判読できる表現。 |
| relatedResource |
エラー関連のリソースの詳細。 |
ExternalDataShareTarget
ターゲット外部データ共有のプロパティを含むオブジェクト。
| 名前 | 型 | 説明 |
|---|---|---|
| connectionId |
string (uuid) |
ショートカットにバインドされている接続を表す文字列。 connectionId は、ショートカットとターゲット データソースの間の接続を確立するために使用される一意の識別子です。 |
GoogleCloudStorage
ターゲットの 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
ターゲットの 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
元のショートカット名とパスを含むオブジェクト
| 名前 | 型 | 説明 |
|---|---|---|
| name |
string |
ショートカットの名前。 |
| path |
string |
ショートカットが作成される完全なパスを表す文字列 ("Files" または "Tables" を含む)。 |
S3Compatible
ターゲット S3 互換データ ソースのプロパティを含むオブジェクト。
| 名前 | 型 | 説明 |
|---|---|---|
| bucket |
string |
S3 互換の場所内のターゲット バケットを指定します。 |
| connectionId |
string (uuid) |
ショートカットにバインドされている接続を表す文字列。 connectionId は、ショートカットとターゲット データソースの間の接続を確立するために使用される一意の識別子です。 |
| location |
string (uri) |
S3 互換エンドポイントの HTTP URL。 このエンドポイントは、ListBuckets S3 API 呼び出しを受信できる必要があります。 URL は、バケット固有以外の形式である必要があります。ここではバケットを指定しないでください。 例: |
| subpath |
string |
S3 互換バケット内のターゲット フォルダーまたはサブフォルダーを指定します。 例: /folder |
Shortcut
OneLake の内部または外部の他のストレージの場所を指す参照を表すオブジェクト。 ショートカットは、名前、ショートカットが作成されるパス、およびターゲットストレージの場所を指定するターゲットによって定義されます。
| 名前 | 型 | 説明 |
|---|---|---|
| name |
string |
ショートカットの名前。 |
| path |
string |
ショートカットが作成される完全なパスを表す文字列 ("Files" または "Tables" を含む)。 |
| target |
ターゲット データソースを含み、サポートされている変換先の 1 つを正確に指定する必要があるオブジェクト。 |
|
| transform | Transform: |
ターゲット データに適用する変換名とそれに対応するプロパティを含むオブジェクト。サポートされている変換の 1 つを正確に指定する必要があります。 |
ShortcutConflictPolicy
指定すると、同じ名前とパスを持つショートカットが既に存在する場合に実行するアクションが定義されます。 既定のアクションは 'Abort' です。 追加の ShortcutConflictPolicy 型は、時間の経過と同時に追加される場合があります。
| 値 | 説明 |
|---|---|
| Abort |
同じ名前とパスを持つショートカットが既に存在する場合、ショートカットの作成は取り消されます。 |
| GenerateUniqueName |
同じ名前とパスを持つショートカットが既に存在する場合、ショートカットの作成は新しい一意のショートカット名で続行されます。 |
| CreateOrOverwrite |
同じ名前とパスのショートカットが既に存在する場合、ショートカットの作成によって既存のショートカットが上書きされます。 ショートカットが存在しない場合は作成します。 |
| OverwriteOnly |
同じ名前とパスのショートカットが既に存在する場合、ショートカットの作成によって既存のショートカットが上書きされます。 |
Status
ショートカットの作成の状態。 追加の状態は、時間の経過と同時に追加される場合があります。
| 値 | 説明 |
|---|---|
| Succeeded |
操作は正常に完了しました。 |
| Failed |
操作が失敗しました。 |
Target
ターゲット データソースを含むオブジェクト。次の表に示すように、サポートされている変換先の 1 つを正確に指定する必要があります。
| 名前 | 型 | 説明 |
|---|---|---|
| adlsGen2 |
ターゲット ADLS Gen2 データ ソースのプロパティを含むオブジェクト。 |
|
| amazonS3 |
ターゲット Amazon S3 データ ソースのプロパティを含むオブジェクト。 |
|
| azureBlobStorage |
ターゲットの Azure Blob Storage データ ソースのプロパティを含むオブジェクト。 |
|
| dataverse |
ターゲットの Dataverse データ ソースのプロパティを含むオブジェクト。 |
|
| externalDataShare |
ターゲット外部データ共有のプロパティを含むオブジェクト。 |
|
| googleCloudStorage |
ターゲットの Google Cloud Storage データ ソースのプロパティを含むオブジェクト。 |
|
| oneLake |
ターゲットの OneLake データ ソースのプロパティを含むオブジェクト。 |
|
| s3Compatible |
ターゲット S3 互換データ ソースのプロパティを含むオブジェクト。 |
|
| type |
type オブジェクトには、ターゲット ショートカット アカウントの種類などのプロパティが含まれています。 追加の型は、時間の経過と同時に追加される場合があります。 |
Type
type オブジェクトには、ターゲット ショートカット アカウントの種類などのプロパティが含まれています。 追加の型は、時間の経過と同時に追加される場合があります。
| 値 | 説明 |
|---|---|
| OneLake |
OneLake |
| AmazonS3 |
AmazonS3 |
| AdlsGen2 |
AdlsGen2 |
| GoogleCloudStorage |
GoogleCloudStorage |
| S3Compatible |
S3Compatible |
| Dataverse |
Dataverse |
| ExternalDataShare |
ExternalDataShare |
| AzureBlobStorage |
AzureBlobStorage |