次の方法で共有

External Data Shares Provider - Get External Data Share

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

指定した外部データ共有の詳細を返します。

権限

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

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

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

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

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

必要なテナント設定

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

制限事項

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

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

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

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

インターフェイス

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

URI パラメーター

名前 / 必須 型 説明
externalDataShareId
 path True

string (uuid)

外部データ共有 ID。
itemId
 path True

string (uuid)

アイテム ID。
workspaceId
 path True

string (uuid)

ワークスペース ID。

応答

名前 型 説明
200 OK

ExternalDataShare

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

ErrorResponse

一般的なエラー コード:

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

例

Get external data share example

要求のサンプル

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

応答のサンプル

状態コード:
200 
{
  "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"
}

定義

名前 説明
ErrorRelatedResource

エラー関連のリソース詳細オブジェクト。
ErrorResponse

エラー応答。
ErrorResponseDetails

エラー応答の詳細。
ExternalDataShare

外部データ共有オブジェクト。
ExternalDataShareRecipient

外部データ共有の受信者の表現。
ExternalDataShareStatus

特定の外部データ共有の状態。 追加の ExternalDataShareStatus 型は、時間の経過と同時に追加される場合があります。
GroupDetails

グループ固有の詳細。 プリンシパルの種類が Group場合に適用されます。
GroupType

グループの種類。 グループの種類は、時間の経過と同時に追加される場合があります。
Principal

ID または Microsoft Entra グループを表します。
PrincipalType

プリンシパルの型。 プリンシパルの種類は、時間の経過と同時に追加される場合があります。
ServicePrincipalDetails

サービス プリンシパル固有の詳細。 プリンシパルの種類が ServicePrincipal場合に適用されます。
ServicePrincipalProfileDetails

サービス プリンシパル プロファイルの詳細。 プリンシパルの種類が ServicePrincipalProfile場合に適用されます。
UserDetails

ユーザー プリンシパル固有の詳細。 プリンシパルの種類が User場合に適用されます。

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

エラー関連のリソースの詳細。

ExternalDataShare

Object

外部データ共有オブジェクト。

名前 型 説明
acceptedByTenantId

string (uuid)

外部データ共有が受け入れられたテナント ID。
creatorPrincipal

Principal

外部データ共有を作成したプリンシパル。
expirationTimeUtc

string (date-time)

外部データ共有への招待の有効期限の日付と時刻 (UTC)。
id

string (uuid)

外部データ共有 ID。
invitationUrl

string (uri)

外部データ共有への招待を受け入れる URL。
itemId

string (uuid)

アイテム ID。
paths

string[]

外部で共有されるパスのパスまたは一覧。
recipient

ExternalDataShareRecipient

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

ExternalDataShareStatus

外部データ共有の状態。
workspaceId

string (uuid)

ワークスペース ID。

ExternalDataShareRecipient

Object

外部データ共有の受信者の表現。

名前 型 説明
tenantId

string (uuid)

受信者のテナント ID。
userPrincipalName

string

maxLength: 256

受信者のメール アドレス。

ExternalDataShareStatus

列挙

特定の外部データ共有の状態。 追加の ExternalDataShareStatus 型は、時間の経過と同時に追加される場合があります。

値 説明
Pending

招待が作成され、受信者による承諾が保留中になりました。
Active

招待は受信者によって受け入れられ、外部データ共有はアクティブです。
Revoked

外部データ共有が取り消されました。
InvitationExpired

招待の有効期限が切れ、受信者が承諾できなくなりました。

GroupDetails

Object

グループ固有の詳細。 プリンシパルの種類が Group場合に適用されます。

名前 型 説明
groupType

GroupType

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

GroupType

列挙

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

値 説明
Unknown

プリンシパル グループの種類が不明です。
SecurityGroup

プリンシパルはセキュリティ グループです。
DistributionList

プリンシパルは配布リストです。

Principal

Object

ID または Microsoft Entra グループを表します。

名前 型 説明
displayName

string

プリンシパルの表示名。
groupDetails

GroupDetails

グループ固有の詳細。 プリンシパルの種類が Group場合に適用されます。
id

string (uuid)

プリンシパルの ID。
servicePrincipalDetails

ServicePrincipalDetails

サービス プリンシパル固有の詳細。 プリンシパルの種類が ServicePrincipal場合に適用されます。
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

サービス プリンシパル プロファイルの詳細。 プリンシパルの種類が ServicePrincipalProfile場合に適用されます。
type

PrincipalType

プリンシパルの型。 プリンシパルの種類は、時間の経過と同時に追加される場合があります。
userDetails

UserDetails

ユーザー プリンシパル固有の詳細。 プリンシパルの種類が User場合に適用されます。

PrincipalType

列挙

プリンシパルの型。 プリンシパルの種類は、時間の経過と同時に追加される場合があります。

値 説明
User

プリンシパルは Microsoft Entra ユーザー プリンシパルです。
ServicePrincipal

プリンシパルは Microsoft Entra サービス プリンシパルです。
Group

プリンシパルはセキュリティ グループです。
ServicePrincipalProfile

プリンシパルはサービス プリンシパル プロファイルです。
EntireTenant

プリンシパルは、すべてのテナント ユーザーを表します。

ServicePrincipalDetails

Object

サービス プリンシパル固有の詳細。 プリンシパルの種類が ServicePrincipal場合に適用されます。

名前 型 説明
aadAppId

string (uuid)

サービス プリンシパルの Microsoft Entra AppId。

ServicePrincipalProfileDetails

Object

サービス プリンシパル プロファイルの詳細。 プリンシパルの種類が ServicePrincipalProfile場合に適用されます。

名前 型 説明
parentPrincipal

Principal

サービス プリンシパル プロファイルの親プリンシパル。

UserDetails

Object

ユーザー プリンシパル固有の詳細。 プリンシパルの種類が User場合に適用されます。

名前 型 説明
userPrincipalName

string

ユーザー プリンシパル名。