External Data Shares Recipient - Get External Data Share Invitation Details

サービス:

Core

API バージョン:

v1

外部データ共有の招待に関する情報を返します。

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

ExternalDataShare.Accept.All

必要なテナント設定

この API を使用するには、ユーザーが呼び出し元プリンシパルの 外部データ共有管理者スイッチを受け入れることができるようにします 。

制限事項

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

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

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

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

インターフェイス

GET https://api.fabric.microsoft.com/v1/externalDataShares/invitations/{invitationId}?providerTenantId={providerTenantId}

URI パラメーター

名前	/	必須	型	説明
invitationId	path	True	string (uuid)	外部データ共有の招待 ID。
providerTenantId	query	True	string (uuid)	外部データ共有プロバイダーのテナント ID。

応答

名前	型	説明
200 OK	ExternalDataShareInvitationDetails	要求は正常に完了しました。
Other Status Codes	ErrorResponse	一般的なエラー コード: ExternalDataShareCannotBeAcceptedInTheSameTenant - 同じテナントで外部データ共有を受け入れることはできません

例

Get external data share invitation details example

要求のサンプル

HTTP

GET https://api.fabric.microsoft.com/v1/externalDataShares/invitations/dccc162f-7a41-4720-83c3-5c7e81187959?providerTenantId=34f92457-fe9d-4c36-92a8-499fdfaf0f8f

応答のサンプル

状態コード:

200

{
  "providerTenantDetails": {
    "tenantId": "34f92457-fe9d-4c36-92a8-499fdfaf0f8f",
    "displayName": "Contoso, Ltd",
    "verifiedDomainName": "contoso.com"
  },
  "pathsDetails": [
    {
      "pathId": "5c95314c-ef86-4663-9f1e-dee186f38715",
      "type": "Folder",
      "name": "Contoso_Sales_2023"
    },
    {
      "pathId": "6c95314c-ef86-4663-9f1e-dee186f38716",
      "type": "Folder",
      "name": "Contoso_Sales_2024"
    }
  ]
}

定義

名前	説明
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。
ExternalDataShareInvitationDetails	外部データ共有の招待の詳細。
ExternalDataSharePathDetails	外部データ共有の一部として共有されたパスの詳細。
ExternalDataSharePathType	外部データ共有内のパスの型。 追加の ExternalDataSharePathType 型は、時間の経過と同時に追加される場合があります。
ExternalDataShareProviderTenantDetails	外部データ共有のプロバイダー テナントの詳細。

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

ExternalDataShareInvitationDetails

Object

外部データ共有の招待の詳細。

名前	型	説明
pathsDetails	ExternalDataSharePathDetails[]	外部データ共有に含まれるパスに関する情報。
providerTenantDetails	ExternalDataShareProviderTenantDetails	外部データ共有のプロバイダー テナントに関する情報。

ExternalDataSharePathDetails

Object

外部データ共有の一部として共有されたパスの詳細。

名前	型	説明
name	string	共有されたコンテンツの名前。
pathId	string (uuid)	パスの一意識別子。
type	ExternalDataSharePathType	外部データ共有の種類。

ExternalDataSharePathType

列挙

外部データ共有内のパスの型。 追加の ExternalDataSharePathType 型は、時間の経過と同時に追加される場合があります。

値	説明
Folder	外部データ共有パスの種類: フォルダー
Table	外部データ共有パスの種類: Table

ExternalDataShareProviderTenantDetails

Object

外部データ共有のプロバイダー テナントの詳細。

名前	型	説明
displayName	string	プロバイダー テナントの表示名。
tenantId	string (uuid)	プロバイダー テナント ID。
verifiedDomainName	string	プロバイダー テナント検証済みドメイン名 (Entra ID)。