次の方法で共有

OneLake Shortcuts - Create Shortcut

サービス:
Core
API バージョン:
v1

新しいショートカットを作成するか、既存のショートカットを更新します。

必要な委任されたスコープ

OneLake.ReadWrite.All

Microsoft Entra でサポートされている ID

この API では、このセクションに記載されている Microsoft ID がサポートされています。

アイデンティティ 支援
ユーザー イエス
サービス プリンシパルとマネージド ID イエス

インターフェイス

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 パラメーター

名前 / 必須 型 説明
itemId
 path True

string (uuid)

データ項目の ID。
workspaceId
 path True

string (uuid)

ワークスペースの ID。
shortcutConflictPolicy
 query

ShortcutConflictPolicy

指定すると、同じ名前とパスを持つショートカットが既に存在する場合に実行するアクションが定義されます。 既定のアクションは 'Abort' です。 追加の ShortcutConflictPolicy 型は、時間の経過と同時に追加される場合があります。

要求本文

名前 必須 型 説明
name True

string

ショートカットの名前。
path True

string

ショートカットが作成される完全なパスを表す文字列 ("Files" または "Tables" を含む)。
target True

CreatableShortcutTarget

ターゲット データソースを含むオブジェクト。サポートされている宛先の 1 つ (OneLake、Amazon S3、ADLS Gen2、Google Cloud Storage、S3 互換、Dataverse、Azure Blob Storage、OneDrive SharePoint) を正確に指定する必要があります。

応答

名前 型 説明
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"
    }
  }
}

定義

名前 説明
AdlsGen2

ターゲット ADLS Gen2 データ ソースのプロパティを含むオブジェクト。
AmazonS3

ターゲット Amazon S3 データ ソースのプロパティを含むオブジェクト。
AzureBlobStorage

ターゲットの Azure Blob Storage データ ソースのプロパティを含むオブジェクト。
CreatableShortcutTarget

ターゲット データソースを含むオブジェクト。次の表に示すように、サポートされている変換先の 1 つを正確に指定する必要があります。
CreateShortcutRequest

別の保存場所への参照を表すオブジェクトを含むショートカット作成要求。
CsvToDeltaTransform

CSV から Delta への変換。
CsvToDeltaTransformProperties

CSV から Delta への変換のプロパティ。
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

ターゲット データソースを含むオブジェクト。次の表に示すように、サポートされている変換先の 1 つを正確に指定する必要があります。
Type

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]/[サブフォルダー] の形式である必要があります。ここで、[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 Storage データ ソースのプロパティを含むオブジェクト。

名前 型 説明
connectionId

string (uuid)

ショートカットにバインドされている接続を表す文字列。 connectionId は、ショートカットとターゲット データソースの間の接続を確立するために使用される一意の識別子です。 この接続 ID を見つけるには、まず、Azure Blob Storage データの場所に接続するときに、ショートカットによって使用される クラウド接続を作成 します。 クラウド接続の設定ビューを開き、接続 ID である GUID をコピーします。
location

string (uri)

ターゲットの Azure Blob Storage コンテナーの場所を指定します。 URI は https://[account-name].blob.core.windows.net 形式である必要があります。ここで、 [account-name] はターゲットの Azure Blob Storage アカウントの名前です。
subpath

string

ターゲット フォルダーが配置されている Azure Blob Storage アカウント内のコンテナーとサブフォルダーを指定します。 [container]/[subfolder]の形式である必要があります。 [コンテナー] は、ファイルとフォルダーを保持するコンテナーの名前です。 [サブフォルダー] はコンテナー内のサブフォルダーの名前であり、省略可能です。 例: /mycontainer/mysubfolder

CreatableShortcutTarget

Object

ターゲット データソースを含むオブジェクト。次の表に示すように、サポートされている変換先の 1 つを正確に指定する必要があります。

名前 型 説明
adlsGen2

AdlsGen2

ターゲット ADLS Gen2 データ ソースのプロパティを含むオブジェクト。
amazonS3

AmazonS3

ターゲット Amazon S3 データ ソースのプロパティを含むオブジェクト。
azureBlobStorage

AzureBlobStorage

ターゲットの Azure Blob Storage データ ソースのプロパティを含むオブジェクト。
dataverse

Dataverse

ターゲットの Dataverse データ ソースのプロパティを含むオブジェクト。
googleCloudStorage

GoogleCloudStorage

ターゲットの Google Cloud Storage データ ソースのプロパティを含むオブジェクト。
oneDriveSharePoint

OneDriveSharePoint

ターゲットの OneDrive for Business および SharePoint Online データ ソースのプロパティを含むオブジェクト。
oneLake

OneLake

ターゲットの OneLake データ ソースのプロパティを含むオブジェクト。
s3Compatible

S3Compatible

ターゲット S3 互換データ ソースのプロパティを含むオブジェクト。

CreateShortcutRequest

Object

別の保存場所への参照を表すオブジェクトを含むショートカット作成要求。

名前 型 説明
name

string

ショートカットの名前。
path

string

ショートカットが作成される完全なパスを表す文字列 ("Files" または "Tables" を含む)。
target

CreatableShortcutTarget

ターゲット データソースを含むオブジェクト。サポートされている宛先の 1 つ (OneLake、Amazon S3、ADLS Gen2、Google Cloud Storage、S3 互換、Dataverse、Azure Blob Storage、OneDrive SharePoint) を正確に指定する必要があります。

CsvToDeltaTransform

Object

CSV から Delta への変換。

名前 型 説明
properties

CsvToDeltaTransformProperties

CSV から Delta への変換プロパティ。
type string:

csvToDelta

変換の種類。 変換の種類は、時間の経過と同時に追加される場合があります。

CsvToDeltaTransformProperties

Object

CSV から Delta への変換のプロパティ。

名前 型 規定値 説明
delimiter

string

,

CSV ファイル内の行内の値を区切るために使用する文字を指定し、サポートされている値の 1 つ ( ,、 、 \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

OneDriveSharePoint

Object

ターゲットの OneDrive for Business または SharePoint Online データ ソースのプロパティを含むオブジェクト。

名前 型 説明
connectionId

string (uuid)

ショートカットにバインドされている接続を表す文字列。 connectionId は、ショートカットとターゲット データソースの間の接続を確立するために使用される一意の識別子です。 この接続 ID を見つけるには、まず、OneDrive SharePoint データの場所に接続するときに、ショートカットによって使用される クラウド接続を作成 します。 クラウド接続の設定ビューを開き、接続 ID である GUID をコピーします。
location

string (uri)

ターゲットの OneDrive SharePoint コンテナーの場所を指定します。 URI は、ターゲットの OneDrive SharePoint アカウントのパスである https://microsoft.sharepoint.com 形式である必要があります。
subpath

string

ターゲット フォルダーが配置されている OneDrive SharePoint アカウント内のコンテナーとサブフォルダーを指定します。 [container]/[subfolder]の形式である必要があります。 [コンテナー] は、ファイルとフォルダーを保持するコンテナーの名前です。 [サブフォルダー] はコンテナー内のサブフォルダーの名前であり、省略可能です。 例: /mycontainer/mysubfolder

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。

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

ショートカットが作成される完全なパスを表す文字列 ("Files" または "Tables" を含む)。
target

Target

ターゲット データソースを含み、サポートされている変換先の 1 つを正確に指定する必要があるオブジェクト。
transform Transform:

CsvToDeltaTransform

ターゲット データに適用する変換名とそれに対応するプロパティを含むオブジェクト。サポートされている変換の 1 つを正確に指定する必要があります。

ShortcutConflictPolicy

列挙

指定すると、同じ名前とパスを持つショートカットが既に存在する場合に実行するアクションが定義されます。 既定のアクションは 'Abort' です。 追加の ShortcutConflictPolicy 型は、時間の経過と同時に追加される場合があります。

値 説明
Abort

同じ名前とパスを持つショートカットが既に存在する場合、ショートカットの作成は取り消されます。
GenerateUniqueName

同じ名前とパスを持つショートカットが既に存在する場合、ショートカットの作成は新しい一意のショートカット名で続行されます。
CreateOrOverwrite

同じ名前とパスのショートカットが既に存在する場合、ショートカットの作成によって既存のショートカットが上書きされます。 ショートカットが存在しない場合は作成します。
OverwriteOnly

同じ名前とパスのショートカットが既に存在する場合、ショートカットの作成によって既存のショートカットが上書きされます。

Target

Object

ターゲット データソースを含むオブジェクト。次の表に示すように、サポートされている変換先の 1 つを正確に指定する必要があります。

名前 型 説明
adlsGen2

AdlsGen2

ターゲット ADLS Gen2 データ ソースのプロパティを含むオブジェクト。
amazonS3

AmazonS3

ターゲット Amazon S3 データ ソースのプロパティを含むオブジェクト。
azureBlobStorage

AzureBlobStorage

ターゲットの Azure Blob Storage データ ソースのプロパティを含むオブジェクト。
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 オブジェクトには、ターゲット ショートカット アカウントの種類などのプロパティが含まれています。 追加の型は、時間の経過と同時に追加される場合があります。

Type

列挙

type オブジェクトには、ターゲット ショートカット アカウントの種類などのプロパティが含まれています。 追加の型は、時間の経過と同時に追加される場合があります。

値 説明
OneLake

OneLake
AmazonS3

AmazonS3
AdlsGen2

AdlsGen2
GoogleCloudStorage

GoogleCloudStorage
S3Compatible

S3Compatible
Dataverse

Dataverse
ExternalDataShare

ExternalDataShare
AzureBlobStorage

AzureBlobStorage
OneDriveSharePoint

OneDriveSharePoint