External Data Shares Provider - List External Data Shares In Item

Referentie

Service:: Core

API-versie:: v1

Retourneert een lijst met de externe gegevensshares die voor het opgegeven item bestaan.
Deze API ondersteunt paginering.

Machtigingen

De beller moet lees - en deelmachtigingen voor het item hebben.

Vereiste gedelegeerde bereiken

Item-API's kunnen een van deze bereiken in hun token hebben:

Algemeen bereik: Item.ExternalDataShare.All
Specifiek bereik: itemType. ExternalDataShare.All, bijvoorbeeld: Lakehouse.ExternalDataShare.All

Zie het artikel bereikenvoor meer informatie over bereiken.

Vereiste tenantinstellingen

Als u deze API wilt gebruiken, schakelt u de beheeroptie voor het delen van externe gegevens in voor de aanroepende principal.

Beperkingen

Maximaal 10 aanvragen per minuut.

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft-identiteiten die in deze sectie worden vermeld.

Identiteit	Ondersteuning
Gebruiker	Ja
serviceprincipal en beheerde identiteiten	Ja

gebruikersinterface

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
itemId	path	True	string (uuid)	De item-id.
workspaceId	path	True	string (uuid)	De werkruimte-ID.
continuationToken	query		string	Een token voor het ophalen van de volgende pagina met resultaten.

Antwoorden

Name	Type	Description
200 OK	ExternalDataShares	De aanvraag is voltooid.
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: UnknownError: er is een fout opgetreden.

Name

Type

Description

200 OK

ExternalDataShares

De aanvraag is voltooid.

Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

UnknownError: er is een fout opgetreden.

Voorbeelden

List external data shares of an item example

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 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"
    }
  ]
}

Definities

Name	Description
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	Het foutbericht.
ErrorResponseDetails	De details van het foutbericht.
ExternalDataShare	Een extern gegevensshareobject.
ExternalDataShareRecipient	Een weergave van de ontvanger van de externe gegevensshare.
ExternalDataShares	Een lijst met externe gegevensshares met een vervolgtoken.
ExternalDataShareStatus	De status van een bepaalde externe gegevensshare. Er kunnen in de loop van de tijd extra `ExternalDataShareStatus` typen worden toegevoegd.
GroupDetails	Groepsspecifieke details. Van toepassing wanneer het principal-type is `Group`.
GroupType	Het type groep. Er kunnen in de loop van de tijd extra groepstypen worden toegevoegd.
Principal	Vertegenwoordigt een identiteit of een Microsoft Entra-groep.
PrincipalType	Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.
ServicePrincipalDetails	Specifieke details van de service-principal. Van toepassing wanneer het principal-type is `ServicePrincipal`.
ServicePrincipalProfileDetails	Details van service-principalprofiel. Van toepassing wanneer het principal-type is `ServicePrincipalProfile`.
UserDetails	Specifieke details van gebruikersprincipaal. Van toepassing wanneer het principal-type is `User`.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name	Type	Description
resourceId	string	De resource-id die betrokken is bij de fout.
resourceType	string	Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
moreDetails	ErrorResponseDetails[]	Lijst met aanvullende foutdetails.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.
requestId	string	Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.

ExternalDataShare

Object

Een extern gegevensshareobject.

Name	Type	Description
acceptedByTenantId	string (uuid)	De tenant-id waarin de externe gegevensshare is geaccepteerd.
creatorPrincipal	Principal	De principal die de externe gegevensshare heeft gemaakt.
expirationTimeUtc	string (date-time)	De vervaldatum en -tijd (UTC) van de uitnodiging voor de externe gegevensshare.
id	string (uuid)	De id van de externe gegevensshare.
invitationUrl	string (uri)	De URL voor het accepteren van de uitnodiging voor de externe gegevensshare.
itemId	string (uuid)	De item-id.
paths	string[]	Het pad of de lijst met paden die extern worden gedeeld.
recipient	ExternalDataShareRecipient	De ontvanger die is uitgenodigd om de externe gegevensshare te accepteren.
status	ExternalDataShareStatus	De status van de externe gegevensshare.
workspaceId	string (uuid)	De werkruimte-ID.

ExternalDataShareRecipient

Object

Een weergave van de ontvanger van de externe gegevensshare.

Name	Type	Description
tenantId	string (uuid)	De tenant-id van de ontvanger.
userPrincipalName	string maxLength: 256	Het e-mailadres van de geadresseerde.

ExternalDataShares

Object

Een lijst met externe gegevensshares met een vervolgtoken.

Name	Type	Description
continuationToken	string	Het token voor de volgende batch met resultatensets. Als er geen records meer zijn, wordt deze verwijderd uit het antwoord.
continuationUri	string	De URI van de volgende batch met resultatensets. Als er geen records meer zijn, wordt deze verwijderd uit het antwoord.
value	ExternalDataShare[]	Een lijst met externe gegevensshares.

ExternalDataShareStatus

Inventarisatie

De status van een bepaalde externe gegevensshare. Er kunnen in de loop van de tijd extra ExternalDataShareStatus typen worden toegevoegd.

Waarde	Description
Active	De uitnodiging is geaccepteerd door de ontvanger en de externe gegevensshare is actief.
InvitationExpired	De uitnodiging is verlopen en kan niet meer worden geaccepteerd door de ontvanger.
Pending	Er is een uitnodiging gemaakt en is nu in afwachting van acceptatie door de ontvanger.
Revoked	De externe gegevensshare is ingetrokken.

GroupDetails

Object

Groepsspecifieke details. Van toepassing wanneer het principal-type is Group.

Name	Type	Description
groupType	GroupType	Het type groep. Er kunnen in de loop van de tijd extra groepstypen worden toegevoegd.

GroupType

Inventarisatie

Het type groep. Er kunnen in de loop van de tijd extra groepstypen worden toegevoegd.

Waarde	Description
DistributionList	Principal is een distributielijst.
SecurityGroup	Principal is een beveiligingsgroep.
Unknown	Het type Principal-groep is onbekend.

Principal

Object

Vertegenwoordigt een identiteit of een Microsoft Entra-groep.

Name	Type	Description
displayName	string	De weergavenaam van de principal.
groupDetails	GroupDetails	Groepsspecifieke details. Van toepassing wanneer het principal-type is `Group`.
id	string (uuid)	De id van de principal.
servicePrincipalDetails	ServicePrincipalDetails	Specifieke details van de service-principal. Van toepassing wanneer het principal-type is `ServicePrincipal`.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Details van service-principalprofiel. Van toepassing wanneer het principal-type is `ServicePrincipalProfile`.
type	PrincipalType	Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.
userDetails	UserDetails	Specifieke details van gebruikersprincipaal. Van toepassing wanneer het principal-type is `User`.

PrincipalType

Inventarisatie

Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.

Waarde	Description
Group	Principal is een beveiligingsgroep.
ServicePrincipal	Principal is een Microsoft Entra-service-principal.
ServicePrincipalProfile	Principal is een service-principalprofiel.
User	Principal is een Microsoft Entra-gebruikersprincipaal.

ServicePrincipalDetails

Object

Specifieke details van de service-principal. Van toepassing wanneer het principal-type is ServicePrincipal.

Name	Type	Description
aadAppId	string (uuid)	De Microsoft Entra AppId van de service-principal.

ServicePrincipalProfileDetails

Object

Details van service-principalprofiel. Van toepassing wanneer het principal-type is ServicePrincipalProfile.

Name	Type	Description
parentPrincipal	Principal	De bovenliggende principal van het service-principalprofiel.

UserDetails

Object

Specifieke details van gebruikersprincipaal. Van toepassing wanneer het principal-type is User.

Name	Type	Description
userPrincipalName	string	De gebruikersprincipe-naam (UPN).

Delen via

External Data Shares Provider - List External Data Shares In Item

Machtigingen

Vereiste gedelegeerde bereiken

Vereiste tenantinstellingen

Beperkingen

Door Microsoft Entra ondersteunde identiteiten

gebruikersinterface

URI-parameters

Antwoorden

Voorbeelden

List external data shares of an item example

Voorbeeldaanvraag

Voorbeeldrespons

Definities

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ExternalDataShare

ExternalDataShareRecipient

ExternalDataShares

ExternalDataShareStatus

GroupDetails

GroupType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails