External Data Shares Provider - List External Data Shares In Item

Referencia

Služba:: Core

Verzia rozhrania API:: v1

Vráti zoznam zdieľania externých údajov, ktoré existujú pre zadanú položku.
Toto rozhranie API podporuje stránkovanie.

Povolenia

Volajúci musí mať pre položku povolenia na čítanie a opätovné zdieľanie .

Povinné delegované rozsahy

Rozhrania API položiek môžu mať jeden z týchto rozsahov vo svojom tokene:

Všeobecný rozsah: Item.ExternalDataShare.All
Konkrétny rozsah: itemType. ExternalDataShare.All, napríklad: Lakehouse.ExternalDataShare.All

Ďalšie informácie o rozsahoch nájdete v článku o rozsahoch.

Požadované nastavenia nájomníka

Ak chcete použiť toto rozhranie API, povoľte prepínač Správca externého zdieľania údajov pre volajúci objekt.

Obmedzenia

Maximálne 10 žiadostí za minútu.

Podporované identity v aplikácii Microsoft Entra

Toto rozhranie API podporuje identity Microsoft uvedené v tejto časti.

Identita	Podpora
Používateľ	Áno
Objekt služby a spravované identity	Áno

Rozhranie

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

S voliteľnými parametrami:

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

Parametre URI

Name	V	Povinné	Typ	Description
itemId	path	True	string (uuid)	ID položky.
workspaceId	path	True	string (uuid)	ID pracovného priestoru.
continuationToken	query		string	Token na načítanie ďalšej stránky výsledkov.

Odpovede

Name	Typ	Description
200 OK	ExternalDataShares	Požiadavka sa úspešne dokončila.
Other Status Codes	ErrorResponse	Bežné kódy chýb: UnknownError – vyskytla sa chyba.

Name

Typ

Description

200 OK

ExternalDataShares

Požiadavka sa úspešne dokončila.

Other Status Codes

ErrorResponse

Bežné kódy chýb:

UnknownError – vyskytla sa chyba.

Príklady

List external data shares of an item example

Vzorová požiadavka

HTTP

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

Vzorová odpoveď

Kód stavu:: 200

{
  "value": [
    {
      "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"
    },
    {
      "id": "96c21561-65b8-4b23-bb9a-ee8cef945c45",
      "paths": [
        "Files/Sales/Contoso_Sales_2023"
      ],
      "creatorPrincipal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "type": "User"
      },
      "recipient": {
        "userPrincipalName": "lisa@fabrikam.com"
      },
      "status": "Active",
      "expirationTimeUtc": "2024-08-31T00: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=96c21561-65b8-4b23-bb9a-ee8cef945c45",
      "acceptedByTenantId": "c51dc03f-268a-4da0-a879-25f24947ab8b"
    },
    {
      "id": "0f40aeca-8f78-4a6f-a552-e5c45faadc60",
      "paths": [
        "Files/Sales/Contoso_Sales_2023"
      ],
      "creatorPrincipal": {
        "id": "81fac5e1-2a81-421b-a168-110b1c72fa11",
        "type": "User"
      },
      "recipient": {
        "userPrincipalName": "lisa@fabrikam.com"
      },
      "status": "InvitationExpired",
      "expirationTimeUtc": "2024-01-01T00: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=0f40aeca-8f78-4a6f-a552-e5c45faadc60"
    },
    {
      "id": "89e82a82-0140-4837-8eee-9c919e3e5952",
      "paths": [
        "Files/Sales/Contoso_Sales_2023"
      ],
      "creatorPrincipal": {
        "id": "81fac5e1-2a81-421b-a168-110b1c72fa11",
        "type": "User"
      },
      "recipient": {
        "userPrincipalName": "lisa@fabrikam.com"
      },
      "status": "Revoked",
      "expirationTimeUtc": "2024-12-01T00: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=89e82a82-0140-4837-8eee-9c919e3e5952",
      "acceptedByTenantId": "c51dc03f-268a-4da0-a879-25f24947ab8b"
    }
  ]
}

Definície

Name	Description
ErrorRelatedResource	Objekt s podrobnosťami o zdroji súvisiacej s chybou.
ErrorResponse	Odpoveď na chybu.
ErrorResponseDetails	Podrobnosti o chybovej odpovedi.
ExternalDataShare	Externý objekt zdieľania údajov.
ExternalDataShareRecipient	Vyjadrenie príjemcu externého zdieľania údajov.
ExternalDataShares	Zoznam externých zdieľania údajov s pokračovým tokenom.
ExternalDataShareStatus	Stav daného externého zdieľania údajov. V priebehu času je možné pridať ďalšie typy #D0.
GroupDetails	Podrobnosti špecifické pre skupinu. Platí, ak je `Group`typ objektu .
GroupType	Typ skupiny. V priebehu času je možné pridať ďalšie typy skupín.
Principal	Predstavuje identitu alebo skupinu Microsoft Entra.
PrincipalType	Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.
ServicePrincipalDetails	Konkrétne podrobnosti objektu služby. Platí, ak je `ServicePrincipal`typ objektu .
ServicePrincipalProfileDetails	Podrobnosti o profile objektu služby. Platí, ak je `ServicePrincipalProfile`typ objektu .
UserDetails	Konkrétne podrobnosti o objekte používateľa. Platí, ak je `User`typ objektu .

ErrorRelatedResource

Object

Objekt s podrobnosťami o zdroji súvisiacej s chybou.

Name	Typ	Description
resourceId	string	ID prostriedku, ktoré je súčasťou chyby.
resourceType	string	Typ prostriedku, ktorý je zapojený do chyby.

ErrorResponse

Object

Odpoveď na chybu.

Name	Typ	Description
errorCode	string	Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
message	string	Zobrazenie chyby čitateľné ľuďmi.
moreDetails	ErrorResponseDetails[]	Zoznam ďalších podrobností o chybe.
relatedResource	ErrorRelatedResource	Podrobnosti o zdrojoch súvisiacich s chybou.
requestId	string	ID požiadavky súvisiacej s chybou.

ErrorResponseDetails

Object

Podrobnosti o chybovej odpovedi.

Name	Typ	Description
errorCode	string	Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
message	string	Zobrazenie chyby čitateľné ľuďmi.
relatedResource	ErrorRelatedResource	Podrobnosti o zdrojoch súvisiacich s chybou.

ExternalDataShare

Object

Externý objekt zdieľania údajov.

Name	Typ	Description
acceptedByTenantId	string (uuid)	ID nájomníka, v ktorom bolo prijaté externé zdieľanie údajov.
creatorPrincipal	Principal	Objekt, ktorý vytvoril externé zdieľanie údajov.
expirationTimeUtc	string (date-time)	Dátum a čas uplynutia platnosti (UTC) pozvánky na zdieľanie externých údajov.
id	string (uuid)	Id externého zdieľania údajov.
invitationUrl	string (uri)	URL adresa na prijatie pozvánky na zdieľanie externých údajov.
itemId	string (uuid)	ID položky.
paths	string[]	Cesta alebo zoznam ciest, ktoré sa externe zdieľajú.
recipient	ExternalDataShareRecipient	Príjemca, ktorý bol vyzvaný, aby prijal zdieľanie externých údajov.
status	ExternalDataShareStatus	Stav externého zdieľania údajov.
workspaceId	string (uuid)	ID pracovného priestoru.

ExternalDataShareRecipient

Object

Vyjadrenie príjemcu externého zdieľania údajov.

Name	Typ	Description
tenantId	string (uuid)	ID nájomníka príjemcu.
userPrincipalName	string maxLength: 256	E-mailová adresa príjemcu.

ExternalDataShares

Object

Zoznam externých zdieľania údajov s pokračovým tokenom.

Name	Typ	Description
continuationToken	string	Token pre ďalšiu dávku množiny výsledkov. Ak už žiadne záznamy neexistujú, odstráni sa z odpovede.
continuationUri	string	Identifikátor URI ďalšej série množiny výsledkov. Ak už žiadne záznamy neexistujú, odstráni sa z odpovede.
value	ExternalDataShare[]	Zoznam externých zdieľania údajov.

ExternalDataShareStatus

Enumerácia

Stav daného externého zdieľania údajov. V priebehu času je možné pridať ďalšie typy #D0.

Hodnota	Description
Active	Príjemca prijal pozvánku a externé zdieľanie údajov je aktívne.
InvitationExpired	Platnosť pozvánky uplynula a príjemca ho už nemôže prijať.
Pending	Vytvorilo sa pozvanie, ktoré čaká na prijatie príjemcom.
Revoked	Externý podiel údajov bol zrušený.

GroupDetails

Object

Podrobnosti špecifické pre skupinu. Platí, ak je Grouptyp objektu .

Name	Typ	Description
groupType	GroupType	Typ skupiny. V priebehu času je možné pridať ďalšie typy skupín.

GroupType

Enumerácia

Typ skupiny. V priebehu času je možné pridať ďalšie typy skupín.

Hodnota	Description
DistributionList	Principal je distribučný zoznam.
SecurityGroup	Principal je skupina zabezpečenia.
Unknown	Typ hlavnej skupiny nie je známy.

Principal

Object

Predstavuje identitu alebo skupinu Microsoft Entra.

Name	Typ	Description
displayName	string	Zobrazovaný názov objektu.
groupDetails	GroupDetails	Podrobnosti špecifické pre skupinu. Platí, ak je `Group`typ objektu .
id	string (uuid)	ID objektu.
servicePrincipalDetails	ServicePrincipalDetails	Konkrétne podrobnosti objektu služby. Platí, ak je `ServicePrincipal`typ objektu .
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Podrobnosti o profile objektu služby. Platí, ak je `ServicePrincipalProfile`typ objektu .
type	PrincipalType	Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.
userDetails	UserDetails	Konkrétne podrobnosti o objekte používateľa. Platí, ak je `User`typ objektu .

PrincipalType

Enumerácia

Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.

Hodnota	Description
Group	Principal je skupina zabezpečenia.
ServicePrincipal	Principal je objekt služby Microsoft Entra.
ServicePrincipalProfile	Principal je profil objektu služby.
User	Principal je objekt používateľa služby Microsoft Entra.

ServicePrincipalDetails

Object

Konkrétne podrobnosti objektu služby. Platí, ak je ServicePrincipaltyp objektu .

Name	Typ	Description
aadAppId	string (uuid)	Microsoft Entra AppId objektu služby.

ServicePrincipalProfileDetails

Object

Podrobnosti o profile objektu služby. Platí, ak je ServicePrincipalProfiletyp objektu .

Name	Typ	Description
parentPrincipal	Principal	Nadradený objekt profilu služby.

UserDetails

Object

Konkrétne podrobnosti o objekte používateľa. Platí, ak je Usertyp objektu .

Name	Typ	Description
userPrincipalName	string	Hlavné meno používateľa.

Zdieľať cez

External Data Shares Provider - List External Data Shares In Item

Povolenia

Povinné delegované rozsahy

Požadované nastavenia nájomníka

Obmedzenia

Podporované identity v aplikácii Microsoft Entra

Rozhranie

Parametre URI

Odpovede

Príklady

List external data shares of an item example

Vzorová požiadavka

Vzorová odpoveď

Definície

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ExternalDataShare

ExternalDataShareRecipient

ExternalDataShares

ExternalDataShareStatus

GroupDetails

GroupType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails