OneLake Shortcuts - Get Shortcut

サービス:: Core

API バージョン:: v1

ショートカットプロパティを返します。

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

OneLake.Read.All または OneLake.ReadWrite.All

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

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

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

インターフェイス

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/shortcuts/{shortcutPath}/{shortcutName}

URI パラメーター

名前	/	必須	型	説明
itemId	path	True	string (uuid)	データ項目の ID。
shortcutName	path	True	string	ショートカットの名前。詳細については、「ディレクトリ名とファイル名」を参照してください。
shortcutPath	path	True	string	ショートカットの作成パス。詳細については、「ディレクトリ名とファイル名」を参照してください。
workspaceId	path	True	string (uuid)	ワークスペースの ID。

応答

名前	型	説明
200 OK	Shortcut	要求は正常に完了しました。
Other Status Codes	ErrorResponse	一般的なエラーコード: ItemNotFound - サーバーは要求された項目を見つけることができません。 UnknownError - エラーが発生しました。

名前

型

説明

200 OK

Shortcut

要求は正常に完了しました。

Other Status Codes

ErrorResponse

一般的なエラーコード:

ItemNotFound - サーバーは要求された項目を見つけることができません。
UnknownError - エラーが発生しました。

例

Get shortcut AzureBlobStorage target example

Get shortcut ExternalDataShare target example

Get shortcut Google Cloud Storage target example

Get shortcut One Lake target example

Get shortcut S3 Compatible target example

Get shortcut transform with One Lake target example

Get shortcut AzureBlobStorage target example

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

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

Get shortcut ExternalDataShare target example

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

{
  "path": "Files/blafolder/folder3",
  "name": "MyExternalDataShareShortcut",
  "target": {
    "type": "ExternalDataShare",
    "externalDataShare": {
      "connectionId": "3c976446-0bda-472e-8800-f1d6e4f162dc"
    }
  }
}

Get shortcut Google Cloud Storage target example

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

{
  "path": "Files/blafolder/folder3",
  "name": "MyGCSShortcut",
  "target": {
    "type": "GoogleCloudStorage",
    "googleCloudStorage": {
      "connectionId": "3c976446-0bda-472e-8800-f1d6e4f162dc",
      "location": "https://gcs-contosoBucket.storage.googleapis.com",
      "subpath": "gcsDirectory"
    }
  }
}

Get shortcut One Lake target example

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

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

Get shortcut S3 Compatible target example

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

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

Get shortcut transform with One Lake target example

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

{
  "path": "Files/blafolder/folder3",
  "name": "MyOneLakeShortcutTransform",
  "target": {
    "type": "OneLake",
    "oneLake": {
      "workspaceId": "acafbeb1-8037-4d0c-896e-a46fb27ff256",
      "itemId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
      "path": "Tables/myTablesFolder/someTableSubFolder"
    }
  },
  "transform": {
    "type": "csvToDelta",
    "properties": {
      "useFirstRowAsHeader": false,
      "delimiter": ",",
      "skipFilesWithErrors": true
    }
  }
}

定義

名前	説明
AdlsGen2	ターゲット ADLS Gen2 データソースのプロパティを含むオブジェクト。
AmazonS3	ターゲット Amazon S3 データソースのプロパティを含むオブジェクト。
AzureBlobStorage	ターゲットの Azure Blob Storage データソースのプロパティを含むオブジェクト。
CsvToDeltaTransform	CSV から Delta への変換。
CsvToDeltaTransformProperties	CSV から Delta への変換のプロパティ。
Dataverse	ターゲットの Dataverse データソースのプロパティを含むオブジェクト。
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。
ExternalDataShareTarget	ターゲット外部データ共有のプロパティを含むオブジェクト。
GoogleCloudStorage	ターゲットの Google Cloud Storage データソースのプロパティを含むオブジェクト。
OneLake	ターゲットの OneLake データソースのプロパティを含むオブジェクト。
S3Compatible	ターゲット S3 互換データソースのプロパティを含むオブジェクト。
Shortcut	OneLake の内部または外部の他のストレージの場所を指す参照を表すオブジェクト。ショートカットは、名前、ショートカットが作成されるパス、およびターゲットストレージの場所を指定するターゲットによって定義されます。
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

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

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 つを正確に指定する必要があります。

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 データソースのプロパティを含むオブジェクト。
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

次の方法で共有

OneLake Shortcuts - Get Shortcut

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

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

インターフェイス

URI パラメーター

応答

例

Get shortcut AzureBlobStorage target example

要求のサンプル

応答のサンプル

Get shortcut ExternalDataShare target example

要求のサンプル

応答のサンプル

Get shortcut Google Cloud Storage target example

要求のサンプル

応答のサンプル

Get shortcut One Lake target example

要求のサンプル

応答のサンプル

Get shortcut S3 Compatible target example

要求のサンプル

応答のサンプル

Get shortcut transform with One Lake target example

要求のサンプル

応答のサンプル

定義

AdlsGen2

AmazonS3

AzureBlobStorage

CsvToDeltaTransform

CsvToDeltaTransformProperties

Dataverse

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ExternalDataShareTarget

GoogleCloudStorage

OneLake

S3Compatible

Shortcut

Target

Type