External Data Shares Provider - Create External Data Share

サービス:: Core

API バージョン:: v1

指定した項目内の特定のパスまたはパスのリストの外部データ共有を作成します。

Permissions

呼び出し元には、アイテムに対する読み取りと再共有のアクセス許可が必要です。

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

アイテム API は、トークンに次のいずれかのスコープを持つことができます。

汎用スコープ: Item.ExternalDataShare.All
特定のスコープ: itemType。ExternalDataShare.All(例: Lakehouse.ExternalDataShare.All)

スコープの詳細については、スコープに関する記事を参照してください。

必要なテナント設定

この API を使用するには、呼び出し元プリンシパルの 外部データ共有 管理者スイッチを有効にします。

Limitations

1 分あたり最大 10 個の要求。

サポートされている項目の種類: Microsoft Fabric 外部データ共有 - サポートされている項目の種類を参照してください。

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

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

Identity	Support
User	Yes
サービスプリンシパルとマネージド ID	Yes

Interface

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

URI パラメーター

名前	/	必須	型	説明
itemId	path	True	string (uuid)	アイテム ID。
workspaceId	path	True	string (uuid)	ワークスペース ID。

要求本文

名前	必須	型	説明
paths	True	string[]	外部共有するパスのパスまたは一覧。各共有で最大 100 個のパスを共有できます。外部データ共有への有効なパスは、"Files/" または "Tables/" で始まる必要があります。ルートフォルダー自体 (ファイルまたはテーブル) を共有することはできません。たとえば、次のパスが有効です。 "Files/MyFolder1" "Tables/MySchema" "Tables/MyTable1"
recipient	True	ExternalDataShareRecipient	外部データ共有を受け入れるように招待された受信者。

名前

必須

型

説明

paths

True

string[]

外部共有するパスのパスまたは一覧。各共有で最大 100 個のパスを共有できます。外部データ共有への有効なパスは、"Files/" または "Tables/" で始まる必要があります。ルートフォルダー自体 (ファイルまたはテーブル) を共有することはできません。

たとえば、次のパスが有効です。

"Files/MyFolder1"
"Tables/MySchema"
"Tables/MyTable1"

recipient

True

ExternalDataShareRecipient

外部データ共有を受け入れるように招待された受信者。

応答

名前	型	説明
201 Created	ExternalDataShare	正常に作成されました。ヘッダー Location: string
Other Status Codes	ErrorResponse	一般的なエラーコード: UnknownError - エラーが発生しました。

名前

型

説明

201 Created

ExternalDataShare

正常に作成されました。

ヘッダー

Location: string

Other Status Codes

ErrorResponse

一般的なエラーコード:

UnknownError - エラーが発生しました。

例

Create an external data share example

Create an external data share with a specific recipient tenant ID example

Create an external data share with multiple paths example

要求のサンプル

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/5b218778-e7a5-4d73-8187-f10824047715/externalDataShares

{
  "paths": [
    "Files/Sales/Contoso_Sales_2023"
  ],
  "recipient": {
    "userPrincipalName": "lisa@fabrikam.com"
  }
}

応答のサンプル

状態コード:: 201

Location: https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/5b218778-e7a5-4d73-8187-f10824047715/externalDataShares/dccc162f-7a41-4720-83c3-5c7e81187959

{
  "id": "dccc162f-7a41-4720-83c3-5c7e81187959",
  "paths": [
    "Files/Sales/Contoso_Sales_2023"
  ],
  "creatorPrincipal": {
    "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
    "type": "User"
  },
  "recipient": {
    "userPrincipalName": "lisa@fabrikam.com"
  },
  "status": "Pending",
  "expirationTimeUtc": "2024-12-13T00:00:00.000Z",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "itemId": "5b218778-e7a5-4d73-8187-f10824047715",
  "invitationUrl": "https://app.fabric.microsoft.com/externaldatasharing/accept?providerTenantId=34f92457-fe9d-4c36-92a8-499fdfaf0f8f&shareId=dccc162f-7a41-4720-83c3-5c7e81187959"
}

要求のサンプル

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/5b218778-e7a5-4d73-8187-f10824047715/externalDataShares

{
  "paths": [
    "Files/Sales/Contoso_Sales_2023"
  ],
  "recipient": {
    "userPrincipalName": "lisa@fabrikam.com",
    "tenantId": "c51dc03f-268a-4da0-a879-25f24947ab8b"
  }
}

応答のサンプル

状態コード:: 201

Location: https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/5b218778-e7a5-4d73-8187-f10824047715/externalDataShares/dccc162f-7a41-4720-83c3-5c7e81187959

{
  "id": "dccc162f-7a41-4720-83c3-5c7e81187959",
  "paths": [
    "Files/Sales/Contoso_Sales_2023"
  ],
  "creatorPrincipal": {
    "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
    "type": "User"
  },
  "recipient": {
    "userPrincipalName": "lisa@fabrikam.com",
    "tenantId": "c51dc03f-268a-4da0-a879-25f24947ab8b"
  },
  "status": "Pending",
  "expirationTimeUtc": "2024-12-13T00:00:00.000Z",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "itemId": "5b218778-e7a5-4d73-8187-f10824047715",
  "invitationUrl": "https://app.fabric.microsoft.com/externaldatasharing/accept?providerTenantId=34f92457-fe9d-4c36-92a8-499fdfaf0f8f&shareId=dccc162f-7a41-4720-83c3-5c7e81187959"
}

要求のサンプル

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/5b218778-e7a5-4d73-8187-f10824047715/externalDataShares

{
  "paths": [
    "Files/Sales/Contoso_Sales_2023",
    "Files/Sales/Contoso_Sales_2024/SubFolder1",
    "Files/Sales/Contoso_Sales_2024/SubFolder2/SubFolder3"
  ],
  "recipient": {
    "userPrincipalName": "lisa@fabrikam.com"
  }
}

応答のサンプル

状態コード:: 201

Location: https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/5b218778-e7a5-4d73-8187-f10824047715/externalDataShares/dccc162f-7a41-4720-83c3-5c7e81187959

{
  "id": "dccc162f-7a41-4720-83c3-5c7e81187959",
  "paths": [
    "Files/Sales/Contoso_Sales_2023",
    "Files/Sales/Contoso_Sales_2024/SubFolder1",
    "Files/Sales/Contoso_Sales_2024/SubFolder2/SubFolder3"
  ],
  "creatorPrincipal": {
    "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
    "type": "User"
  },
  "recipient": {
    "userPrincipalName": "lisa@fabrikam.com"
  },
  "status": "Pending",
  "expirationTimeUtc": "2024-12-13T00:00:00.000Z",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "itemId": "5b218778-e7a5-4d73-8187-f10824047715",
  "invitationUrl": "https://app.fabric.microsoft.com/externaldatasharing/accept?providerTenantId=34f92457-fe9d-4c36-92a8-499fdfaf0f8f&shareId=dccc162f-7a41-4720-83c3-5c7e81187959"
}

定義

名前	説明
CreateExternalDataShareRequest	外部データ共有を作成するための要求ペイロード。
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。
ExternalDataShare	外部データ共有オブジェクト。
ExternalDataShareRecipient	外部データ共有の受信者の表現。
ExternalDataShareStatus	特定の外部データ共有の状態。追加の `ExternalDataShareStatus` 型は、時間の経過と同時に追加される場合があります。
GroupDetails	グループ固有の詳細。プリンシパルの種類が `Group`場合に適用されます。
GroupType	グループの種類。グループの種類は、時間の経過と同時に追加される場合があります。
Principal	ID または Microsoft Entra グループを表します。
PrincipalType	プリンシパルの型。プリンシパルの種類は、時間の経過と同時に追加される場合があります。
ServicePrincipalDetails	サービスプリンシパル固有の詳細。プリンシパルの種類が `ServicePrincipal`場合に適用されます。
ServicePrincipalProfileDetails	サービスプリンシパルプロファイルの詳細。プリンシパルの種類が `ServicePrincipalProfile`場合に適用されます。
UserDetails	ユーザープリンシパル固有の詳細。プリンシパルの種類が `User`場合に適用されます。

CreateExternalDataShareRequest

Object

外部データ共有を作成するための要求ペイロード。

名前	型	説明
paths	string[]	外部共有するパスのパスまたは一覧。各共有で最大 100 個のパスを共有できます。外部データ共有への有効なパスは、"Files/" または "Tables/" で始まる必要があります。ルートフォルダー自体 (ファイルまたはテーブル) を共有することはできません。たとえば、次のパスが有効です。 "Files/MyFolder1" "Tables/MySchema" "Tables/MyTable1"
recipient	ExternalDataShareRecipient	外部データ共有を受け入れるように招待された受信者。

名前

型

説明

paths

string[]

たとえば、次のパスが有効です。

"Files/MyFolder1"
"Tables/MySchema"
"Tables/MyTable1"

recipient

ExternalDataShareRecipient

外部データ共有を受け入れるように招待された受信者。

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	エラー関連のリソースの詳細。