External Data Shares - Create External Data Share

Referencia

Szolgáltatás:: Core

API-verzió:: v1

Külső adatmegosztást hoz létre egy adott elérési úthoz vagy elérési utak listájához a megadott elemben.

Engedélyek

A hívónak olvasási és újramegosztási engedélyekkel kell rendelkeznie az elemen.

Kötelező delegált hatókörök

Elem API-k esetén a jogkivonatban a két hatókörtípus egyike szerepelhet:

Általános hatókör: Item.ExternalDataShare.All
Konkrét hatókör: itemType. ExternalDataShare.All (például: Lakehouse.ExternalDataShare.All)

További információ a hatókörökről: hatókörökről szóló cikk.

Szükséges bérlői beállítások

Az API használatához engedélyezze a "Külső adatmegosztás" rendszergazdai kapcsolót a hívó tag számára.

Korlátozások

Legfeljebb 10 kérés percenként.

Támogatott elemtípusok: Lásd: Külső adatmegosztás a Microsoft Fabricben – Támogatott elemtípusok.

Microsoft Entra által támogatott identitások

Ez az API támogatja az ebben a szakaszban felsorolt Microsoft identitásokat.

Azonosság	Támogat
Felhasználó	Igen
szolgáltatásnév és felügyelt identitások	Igen

Interfész

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
itemId	path	True	string uuid	Az elem azonosítója.
workspaceId	path	True	string uuid	A munkaterület azonosítója.

Kérelem törzse

Name	Kötelező	Típus	Description
paths	True	string[]	A külsőleg megosztandó útvonalak elérési útja vagy listája. Minden megosztásban legfeljebb 100 elérési utat oszthat meg. Egy külső adatmegosztás érvényes elérési útjának a "Fájlok/" vagy a "Táblák/" szöveggel kell kezdődnie. Magát a gyökérmappát (fájlokat vagy táblákat) nem oszthatja meg. Például ezek az elérési utak érvényesek: "Fájlok/MyFolder1" "Táblák/MyTable1"
recipient	True	ExternalDataShareRecipient	A külső adatmegosztás elfogadására meghívott címzett.

Name

Kötelező

Típus

Description

paths

True

string[]

A külsőleg megosztandó útvonalak elérési útja vagy listája. Minden megosztásban legfeljebb 100 elérési utat oszthat meg. Egy külső adatmegosztás érvényes elérési útjának a "Fájlok/" vagy a "Táblák/" szöveggel kell kezdődnie. Magát a gyökérmappát (fájlokat vagy táblákat) nem oszthatja meg.

Például ezek az elérési utak érvényesek:
"Fájlok/MyFolder1"
"Táblák/MyTable1"

recipient

True

ExternalDataShareRecipient

A külső adatmegosztás elfogadására meghívott címzett.

Válaszok

Name	Típus	Description
201 Created	ExternalDataShare	Sikeresen létrejött. Fejlécek Location: string
Other Status Codes	ErrorResponse	Gyakori hibakódok: UnknownError – Hiba történt.

Name

Típus

Description

201 Created

ExternalDataShare

Sikeresen létrejött.

Fejlécek

Location: string

Other Status Codes

ErrorResponse

Gyakori hibakódok:

UnknownError – Hiba történt.

Példák

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

Mintakérelem

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

Mintaválasz

Állapotkód:: 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?si=VyT5NJ3%2bNkySqEmf368Pjw-dccc162f-7a41-4720-83c3-5c7e81187959"
}

Mintakérelem

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

Mintaválasz

Állapotkód:: 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?si=VyT5NJ3%2bNkySqEmf368Pjw-dccc162f-7a41-4720-83c3-5c7e81187959"
}

Mintakérelem

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

Mintaválasz

Állapotkód:: 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?si=VyT5NJ3%2bNkySqEmf368Pjw-dccc162f-7a41-4720-83c3-5c7e81187959"
}

Definíciók

Name	Description
CreateExternalDataShareRequest	A külső adatmegosztás létrehozásához szükséges hasznos adatok kérése.
ErrorRelatedResource	A hibával kapcsolatos erőforrás-részletek objektum.
ErrorResponse	A hibaválasz.
ErrorResponseDetails	A hibaválasz részletei.
ExternalDataShare	Külső adatmegosztási objektum.
ExternalDataShareRecipient	A külső adatmegosztás címzettjének ábrázolása.
ExternalDataShareStatus	Egy adott külső adatmegosztás állapota. Idővel további `ExternalDataShareStatus` típusok is hozzáadhatók.
GroupDetails	Csoportosítsa a részleteket. Akkor alkalmazható, ha az egyszerű típus `Group`.
GroupType	A csoport típusa. Idővel további csoporttípusok is hozzáadhatók.
Principal	Identitást vagy Microsoft Entra-csoportot jelöl.
PrincipalType	A rendszernév típusa. Idővel további egyszerű típusok is hozzáadhatók.
ServicePrincipalDetails	A szolgáltatásnév konkrét részletei. Akkor alkalmazható, ha az egyszerű típus `ServicePrincipal`.
ServicePrincipalProfileDetails	A szolgáltatásnév profiladatai. Akkor alkalmazható, ha az egyszerű típus `ServicePrincipalProfile`.
UserDetails	A felhasználó egyszerű adatai. Akkor alkalmazható, ha az egyszerű típus `User`.

CreateExternalDataShareRequest

Objektum

A külső adatmegosztás létrehozásához szükséges hasznos adatok kérése.

Name	Típus	Description
paths	string[]	A külsőleg megosztandó útvonalak elérési útja vagy listája. Minden megosztásban legfeljebb 100 elérési utat oszthat meg. Egy külső adatmegosztás érvényes elérési útjának a "Fájlok/" vagy a "Táblák/" szöveggel kell kezdődnie. Magát a gyökérmappát (fájlokat vagy táblákat) nem oszthatja meg. Például ezek az elérési utak érvényesek: "Fájlok/MyFolder1" "Táblák/MyTable1"
recipient	ExternalDataShareRecipient	A külső adatmegosztás elfogadására meghívott címzett.

Name

Típus

Description

paths

string[]

Például ezek az elérési utak érvényesek:
"Fájlok/MyFolder1"
"Táblák/MyTable1"

recipient

ExternalDataShareRecipient

A külső adatmegosztás elfogadására meghívott címzett.

ErrorRelatedResource

Objektum

A hibával kapcsolatos erőforrás-részletek objektum.

Name	Típus	Description
resourceId	string	A hibában érintett erőforrás-azonosító.
resourceType	string	A hibában érintett erőforrás típusa.

ErrorResponse

Objektum

A hibaválasz.

Name	Típus	Description
errorCode	string	Egy adott azonosító, amely információt nyújt egy hibafeltételről, amely lehetővé teszi a szolgáltatás és a felhasználók közötti szabványosított kommunikációt.
message	string	A hiba emberi olvasható ábrázolása.
moreDetails	ErrorResponseDetails[]	További hibaadatok listája.
relatedResource	ErrorRelatedResource	A hibával kapcsolatos erőforrásadatok.
requestId	string	A hibához társított kérés azonosítója.

ErrorResponseDetails

Objektum

A hibaválasz részletei.

Name	Típus	Description
errorCode	string	Egy adott azonosító, amely információt nyújt egy hibafeltételről, amely lehetővé teszi a szolgáltatás és a felhasználók közötti szabványosított kommunikációt.
message	string	A hiba emberi olvasható ábrázolása.
relatedResource	ErrorRelatedResource	A hibával kapcsolatos erőforrásadatok.

ExternalDataShare

Objektum

Külső adatmegosztási objektum.

Name	Típus	Description
acceptedByTenantId	string uuid	Az a bérlőazonosító, amelyben a külső adatmegosztást elfogadták.
creatorPrincipal	Principal	A külső adatmegosztást létrehozó tag.
expirationTimeUtc	string date-time	A külső adatmegosztásra való meghívás lejárati dátuma és időpontja (UTC).
id	string uuid	A külső adatmegosztás azonosítója.
invitationUrl	string uri	A külső adatmegosztásra vonatkozó meghívás elfogadásának URL-címe.
itemId	string uuid	Az elem azonosítója.
paths	string[]	A külsőleg megosztott útvonalak elérési útja vagy listája.
recipient	ExternalDataShareRecipient	A külső adatmegosztás elfogadására meghívott címzett.
status	ExternalDataShareStatus	A külső adatmegosztás állapota.
workspaceId	string uuid	A munkaterület azonosítója.

ExternalDataShareRecipient

Objektum

A külső adatmegosztás címzettjének ábrázolása.

Name	Típus	Description
tenantId	string uuid	A címzett bérlőazonosítója.
userPrincipalName	string	A címzett e-mail-címe.

ExternalDataShareStatus

Enumerálás

Egy adott külső adatmegosztás állapota. Idővel további ExternalDataShareStatus típusok is hozzáadhatók.

Érték	Description
Active	A meghívást a címzett elfogadta, és a külső adatmegosztás aktív.
InvitationExpired	A meghívás lejárt, és a címzett már nem tudja elfogadni.
Pending	Létre lett hozva egy meghívás, és a címzett jelenleg elfogadásra vár.
Revoked	A külső adatmegosztást visszavonták.

GroupDetails

Objektum

Csoportosítsa a részleteket. Akkor alkalmazható, ha az egyszerű típus Group.

Name	Típus	Description
groupType	GroupType	A csoport típusa. Idővel további csoporttípusok is hozzáadhatók.

GroupType

Enumerálás

A csoport típusa. Idővel további csoporttípusok is hozzáadhatók.

Érték	Description
DistributionList	Az egyszerű egy terjesztési lista.
SecurityGroup	Az egyszerű egy biztonsági csoport.
Unknown	Az egyszerű csoport típusa ismeretlen.

Principal

Objektum

Identitást vagy Microsoft Entra-csoportot jelöl.

Name	Típus	Description
displayName	string	Az egyszerű megjelenítendő neve.
groupDetails	GroupDetails	Csoportosítsa a részleteket. Akkor alkalmazható, ha az egyszerű típus `Group`.
id	string uuid	Az igazgató azonosítója.
servicePrincipalDetails	ServicePrincipalDetails	A szolgáltatásnév konkrét részletei. Akkor alkalmazható, ha az egyszerű típus `ServicePrincipal`.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	A szolgáltatásnév profiladatai. Akkor alkalmazható, ha az egyszerű típus `ServicePrincipalProfile`.
type	PrincipalType	A rendszernév típusa. Idővel további egyszerű típusok is hozzáadhatók.
userDetails	UserDetails	A felhasználó egyszerű adatai. Akkor alkalmazható, ha az egyszerű típus `User`.

PrincipalType

Enumerálás

A rendszernév típusa. Idővel további egyszerű típusok is hozzáadhatók.

Érték	Description
Group	Az egyszerű egy biztonsági csoport.
ServicePrincipal	Az egyszerű szolgáltatásnév a Microsoft Entra szolgáltatásnév.
ServicePrincipalProfile	Az egyszerű szolgáltatásnév egy szolgáltatásnév-profil.
User	Az egyszerű felhasználó a Microsoft Entra egyik egyszerű felhasználója.

ServicePrincipalDetails

Objektum

A szolgáltatásnév konkrét részletei. Akkor alkalmazható, ha az egyszerű típus ServicePrincipal.

Name	Típus	Description
aadAppId	string uuid	A szolgáltatásnév Microsoft Entra AppId azonosítója.

ServicePrincipalProfileDetails

Objektum

A szolgáltatásnév profiladatai. Akkor alkalmazható, ha az egyszerű típus ServicePrincipalProfile.

Name	Típus	Description
parentPrincipal	Principal	A szolgáltatásnév-profil szülőnevét.

UserDetails

Objektum

A felhasználó egyszerű adatai. Akkor alkalmazható, ha az egyszerű típus User.

Name	Típus	Description
userPrincipalName	string	A felhasználónév.

Megosztás a következőn keresztül:

External Data Shares - Create External Data Share

Engedélyek

Kötelező delegált hatókörök

Szükséges bérlői beállítások

Korlátozások

Microsoft Entra által támogatott identitások

Interfész

URI-paraméterek

Kérelem törzse

Válaszok

Példák

Mintakérelem

Mintaválasz

Mintakérelem

Mintaválasz

Mintakérelem

Mintaválasz

Definíciók

CreateExternalDataShareRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ExternalDataShare

ExternalDataShareRecipient

ExternalDataShareStatus

GroupDetails

GroupType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails

További források