External Data Shares Provider - Get External Data Share

Dienst:: Core

API-Version:: v1

Gibt die Details der angegebenen externen Datenfreigabe zurück.

Erlaubnisse

Der Aufrufer muss über Lese - und Freigabeberechtigungen für das Element verfügen.

Erforderliche delegierte Bereiche

Element-APIs können einen der folgenden Bereiche in ihrem Token enthalten:

Allgemeiner Bereich: Item.ExternalDataShare.All
Bestimmter Bereich: itemType. ExternalDataShare.All, z. B.: Lakehouse.ExternalDataShare.All

Weitere Informationen zu Bereichen finden Sie in Bereichsartikel.

Erforderliche Mandanteneinstellungen

Um diese API zu verwenden, aktivieren Sie den Administratorwechsel für die externe Datenfreigabe für den Aufrufprinzipal.

Einschränkungen

Maximal 10 Anforderungen pro Minute.

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identität	Unterstützung
Benutzer	Ja
Service Principal und Verwaltete Identitäten	Ja

Schnittstelle

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
externalDataShareId	path	True	string (uuid)	Die ID der externen Datenfreigabe.
itemId	path	True	string (uuid)	Die Element-ID.
workspaceId	path	True	string (uuid)	Die Arbeitsbereichs-ID.

Antworten

Name	Typ	Beschreibung
200 OK	ExternalDataShare	Die Anforderung wurde erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Häufige Fehlercodes: UnknownError – Ein Fehler ist aufgetreten.

Name

Typ

Beschreibung

200 OK

ExternalDataShare

Die Anforderung wurde erfolgreich abgeschlossen.

Other Status Codes

ErrorResponse

Häufige Fehlercodes:

UnknownError – Ein Fehler ist aufgetreten.

Beispiele

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
ErrorRelatedResource	Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
ExternalDataShare	Ein externes Datenfreigabeobjekt.
ExternalDataShareRecipient	Eine Darstellung des Empfängers der externen Datenfreigabe.
ExternalDataShareStatus	Der Status einer bestimmten externen Datenfreigabe. Zusätzliche `ExternalDataShareStatus` Typen können im Laufe der Zeit hinzugefügt werden.
GroupDetails	Gruppieren Sie bestimmte Details. Gilt, wenn der Prinzipaltyp `Group`ist.
GroupType	Der Typ der Gruppe. Weitere Gruppentypen können im Laufe der Zeit hinzugefügt werden.
Principal	Stellt eine Identität oder eine Microsoft Entra-Gruppe dar.
PrincipalType	Der Typ des Prinzipals. Im Laufe der Zeit können zusätzliche Prinzipaltypen hinzugefügt werden.
ServicePrincipalDetails	Spezifische Details des Dienstprinzipals. Gilt, wenn der Prinzipaltyp `ServicePrincipal`ist.
ServicePrincipalProfileDetails	Dienstprinzipalprofildetails. Gilt, wenn der Prinzipaltyp `ServicePrincipalProfile`ist.
UserDetails	Spezifische Details des Benutzerprinzipals. Gilt, wenn der Prinzipaltyp `User`ist.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name	Typ	Beschreibung
resourceId	string	Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType	string	Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine lesbare Darstellung des Fehlers.
moreDetails	ErrorResponseDetails[]	Liste der zusätzlichen Fehlerdetails.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.
requestId	string	ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine lesbare Darstellung des Fehlers.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.

ExternalDataShare

Objekt

Ein externes Datenfreigabeobjekt.

Name	Typ	Beschreibung
acceptedByTenantId	string (uuid)	Die Mandanten-ID, in der die externe Datenfreigabe akzeptiert wurde.
creatorPrincipal	Principal	Der Prinzipal, der die externe Datenfreigabe erstellt hat.
expirationTimeUtc	string (date-time)	Das Ablaufdatum und die Uhrzeit (UTC) der Einladung zur externen Datenfreigabe.
id	string (uuid)	Die ID der externen Datenfreigabe.
invitationUrl	string (uri)	Die URL zum Annehmen der Einladung zur externen Datenfreigabe.
itemId	string (uuid)	Die Element-ID.
paths	string[]	Der Pfad oder die Liste der Pfade, die extern freigegeben werden.
recipient	ExternalDataShareRecipient	Der Empfänger, der eingeladen wurde, die externe Datenfreigabe anzunehmen.
status	ExternalDataShareStatus	Der Status der externen Datenfreigabe.
workspaceId	string (uuid)	Die Arbeitsbereichs-ID.

ExternalDataShareRecipient

Objekt

Eine Darstellung des Empfängers der externen Datenfreigabe.

Name	Typ	Beschreibung
tenantId	string (uuid)	Die Mandanten-ID des Empfängers.
userPrincipalName	string maxLength: 256	Die E-Mail-Adresse des Empfängers.

ExternalDataShareStatus

Enumeration

Der Status einer bestimmten externen Datenfreigabe. Zusätzliche ExternalDataShareStatus Typen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Pending	Eine Einladung wurde erstellt und steht nun für die Annahme durch den Empfänger aus.
Active	Die Einladung wurde vom Empfänger akzeptiert, und die externe Datenfreigabe ist aktiv.
Revoked	Die externe Datenfreigabe wurde widerrufen.
InvitationExpired	Die Einladung ist abgelaufen und kann vom Empfänger nicht mehr akzeptiert werden.

GroupDetails

Objekt

Gruppieren Sie bestimmte Details. Gilt, wenn der Prinzipaltyp Groupist.

Name	Typ	Beschreibung
groupType	GroupType	Der Typ der Gruppe. Weitere Gruppentypen können im Laufe der Zeit hinzugefügt werden.

GroupType

Enumeration

Der Typ der Gruppe. Weitere Gruppentypen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Unknown	Der Prinzipalgruppentyp ist unbekannt.
SecurityGroup	Prinzipal ist eine Sicherheitsgruppe.
DistributionList	Prinzipal ist eine Verteilerliste.

Principal

Objekt

Stellt eine Identität oder eine Microsoft Entra-Gruppe dar.

Name	Typ	Beschreibung
displayName	string	Der Anzeigename des Prinzipals.
groupDetails	GroupDetails	Gruppieren Sie bestimmte Details. Gilt, wenn der Prinzipaltyp `Group`ist.
id	string (uuid)	Die ID des Prinzipals.
servicePrincipalDetails	ServicePrincipalDetails	Spezifische Details des Dienstprinzipals. Gilt, wenn der Prinzipaltyp `ServicePrincipal`ist.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Dienstprinzipalprofildetails. Gilt, wenn der Prinzipaltyp `ServicePrincipalProfile`ist.
type	PrincipalType	Der Typ des Prinzipals. Im Laufe der Zeit können zusätzliche Prinzipaltypen hinzugefügt werden.
userDetails	UserDetails	Spezifische Details des Benutzerprinzipals. Gilt, wenn der Prinzipaltyp `User`ist.

PrincipalType

Enumeration

Der Typ des Prinzipals. Im Laufe der Zeit können zusätzliche Prinzipaltypen hinzugefügt werden.

Wert	Beschreibung
User	Prinzipal ist ein Microsoft Entra-Benutzerprinzipal.
ServicePrincipal	Prinzipal ist ein Microsoft Entra-Dienstprinzipal.
Group	Prinzipal ist eine Sicherheitsgruppe.
ServicePrincipalProfile	Prinzipal ist ein Dienstprinzipalprofil.
EntireTenant	Prinzipal stellt alle Mandantenbenutzer dar.

ServicePrincipalDetails

Objekt

Spezifische Details des Dienstprinzipals. Gilt, wenn der Prinzipaltyp ServicePrincipalist.

Name	Typ	Beschreibung
aadAppId	string (uuid)	Die Microsoft Entra AppId des Dienstprinzipals.

ServicePrincipalProfileDetails

Objekt

Dienstprinzipalprofildetails. Gilt, wenn der Prinzipaltyp ServicePrincipalProfileist.

Name	Typ	Beschreibung
parentPrincipal	Principal	Der übergeordnete Prinzipal des Dienstprinzipals.

UserDetails

Objekt

Spezifische Details des Benutzerprinzipals. Gilt, wenn der Prinzipaltyp Userist.

Name	Typ	Beschreibung
userPrincipalName	string	Der Benutzerprinzipalname.

Freigeben über

External Data Shares Provider - Get External Data Share

Erlaubnisse

Erforderliche delegierte Bereiche

Erforderliche Mandanteneinstellungen

Einschränkungen

Von Microsoft Entra unterstützte Identitäten

Schnittstelle

URI-Parameter

Antworten

Beispiele

Get external data share example

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ExternalDataShare

ExternalDataShareRecipient

ExternalDataShareStatus

GroupDetails

GroupType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails