External Data Shares Provider - Get External Data Share

Tjänst:: Core

API-version:: v1

Returnerar information om den angivna externa dataresursen.

Behörigheter

Anroparen måste ha läs- och delningsbehörigheter för objektet.

Obligatoriska delegerade omfång

Objekt-API:er kan ha något av dessa omfång i sin token:

Allmänt omfång: Item.ExternalDataShare.All
Specifikt omfång: itemType. ExternalDataShare.All, till exempel: Lakehouse.ExternalDataShare.All

Mer information om omfång finns i artikeln om omfång.

Nödvändiga klientinställningar

Om du vill använda det här API:et aktiverar du administratörsväxeln extern datadelning för det anropande huvudnamnet.

Begränsningar

Maximalt 10 begäranden per minut.

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet	Stöd
Användare	Ja
Tjänsthuvudnamn och hanterade identiteter	Ja

Gränssnitt

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
externalDataShareId	path	True	string (uuid)	Det externa dataresurs-ID:t.
itemId	path	True	string (uuid)	Objekt-ID:t.
workspaceId	path	True	string (uuid)	Arbetsyte-ID.

Svar

Name Typ Description

200 OK

Name	Typ	Description
200 OK	ExternalDataShare	Begäran har slutförts.
429 Too Many Requests	ErrorResponse	Gränsen för tjänstfrekvens överskreds. Servern returnerar ett `Retry-After` huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas. Sidhuvuden Retry-After: integer
Other Status Codes	ErrorResponse	Vanliga felkoder: UnknownError – Ett fel uppstod.

ExternalDataShare

Begäran har slutförts.

429 Too Many Requests

ErrorResponse

Gränsen för tjänstfrekvens överskreds. Servern returnerar ett Retry-After huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas.

Sidhuvuden

Retry-After: integer

Other Status Codes

ErrorResponse

Vanliga felkoder:

UnknownError – Ett fel uppstod.

Exempel

Exempelbegäran

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

Exempelsvar

Statuskod:: 200

{
  "id": "dccc162f-7a41-4720-83c3-5c7e81187959",
  "paths": [
    "Files/Sales/Contoso_Sales_2023"
  ],
  "creatorPrincipal": {
    "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
    "type": "User"
  },
  "recipient": {
    "type": "User",
    "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"
}

Definitioner

Name	Description
EntireTenantPrincipal	Representerar ett klientorganisationsobjekt
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
ExternalDataShare	Ett externt dataresursobjekt.
ExternalDataShareRecipientType	Typen av mottagare för den externa dataresursen. Standardvärdet är "Användare" om det inte anges. Ytterligare mottagartyper kan läggas till över tid.
ExternalDataShareSPRecipient	En extern dataresursmottagare som är ett huvudnamn för tjänsten, identifierad med huvudnamns-ID och klientorganisations-ID.
ExternalDataShareStatus	Status för en viss extern dataresurs. Ytterligare `ExternalDataShareStatus` typer kan läggas till över tid.
ExternalDataShareUserRecipient	En extern dataresursmottagare som är en användare, identifierad med användarens huvudnamn (e-postadress). Det här är standardmottagarens typ.
GroupDetails	Gruppera specifik information. Gäller när huvudtypen är `Group`.
GroupPrincipal	Representerar en säkerhetsgrupp.
GroupType	Gruppens typ. Ytterligare grupptyper kan läggas till över tid.
PrincipalType	Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.
ServicePrincipalDetails	Specifik information om tjänstens huvudnamn. Gäller när huvudtypen är `ServicePrincipal`.
ServicePrincipalPrincipal	Representerar tjänstens huvudnamn för Microsoft Entra.
ServicePrincipalProfileDetails	Profilinformation för tjänstens huvudnamn. Gäller när huvudtypen är `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Representerar en profil för tjänstens huvudnamn.
UserDetails	Specifik information om användarens huvudnamn. Gäller när huvudtypen är `User`.
UserPrincipal	Representerar ett Microsoft Entra-användarhuvudnamn.

EntireTenantPrincipal

Objekt

Representerar ett klientorganisationsobjekt

Name	Typ	Description
displayName	string	Huvudkontots visningsnamn.
id	string (uuid)	Huvudmannens ID.
type	string: EntireTenant	Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name	Typ	Description
resourceId	string	Det resurs-ID som ingår i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
isRetriable	boolean	När det är sant kan begäran göras på nytt. Använd svarshuvudet `Retry-After` för att fastställa fördröjningen, om den är tillgänglig.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.
requestId	string (uuid)	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.

ExternalDataShare

Objekt

Ett externt dataresursobjekt.

Name	Typ	Description
acceptedByTenantId	string (uuid)	Klientorganisations-ID:t där den externa dataresursen accepterades.
creatorPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Det huvudnamn som skapade den externa dataresursen.
expirationTimeUtc	string (date-time)	Utgångsdatum och tid (UTC) för inbjudan till den externa dataresursen.
id	string (uuid)	Det externa dataresurs-ID:t.
invitationUrl	string (uri)	URL:en för att acceptera inbjudan till den externa dataresursen.
itemId	string (uuid)	Objekt-ID:t.
paths	string[]	Sökvägen eller listan över sökvägar som delas externt.
recipient	BaseExternalDataShareRecipient: ExternalDataShareSPRecipient ExternalDataShareUserRecipient	Mottagaren som har bjudits in att acceptera den externa dataresursen.
status	ExternalDataShareStatus	Status för den externa dataresursen.
workspaceId	string (uuid)	Arbetsyte-ID.

ExternalDataShareRecipientType

Uppräkning

Typen av mottagare för den externa dataresursen. Standardvärdet är "Användare" om det inte anges. Ytterligare mottagartyper kan läggas till över tid.

Värde	Description
ServicePrincipal	Mottagaren är ett huvudnamn för tjänsten som identifieras av objekt-ID och klientorganisations-ID.
User	Mottagaren är en användare som identifieras med användarens huvudnamn (e-postadress). Det här är standardvärdet.

ExternalDataShareSPRecipient

Objekt

En extern dataresursmottagare som är ett huvudnamn för tjänsten, identifierad med huvudnamns-ID och klientorganisations-ID.

Name	Typ	Standardvärde	Description
principalId	string (uuid)		Huvud-ID för tjänstens huvudnamnsmottagare. Detta motsvarar Entra ID objekt-ID.
tenantId	string (uuid)		Klientorganisations-ID för tjänstens huvudnamnsmottagare.
type	string: ServicePrincipal	User	Typen av mottagare för den externa dataresursen. Standardvärdet är "Användare" om det inte anges. Ytterligare mottagartyper kan läggas till över tid.

ExternalDataShareStatus

Uppräkning

Status för en viss extern dataresurs. Ytterligare ExternalDataShareStatus typer kan läggas till över tid.

Värde	Description
Pending	En inbjudan skapades och väntar nu på att godkännas av mottagaren.
Active	Inbjudan har godkänts av mottagaren och den externa dataresursen är aktiv.
Revoked	Den externa dataresursen återkallades.
InvitationExpired	Inbjudan har upphört att gälla och kan inte längre accepteras av mottagaren.

ExternalDataShareUserRecipient

Objekt

En extern dataresursmottagare som är en användare, identifierad med användarens huvudnamn (e-postadress). Det här är standardmottagarens typ.

Name	Typ	Standardvärde	Description
tenantId	string (uuid)		Klientorganisations-ID för användarmottagaren. Valfritt.
type	string: User	User	Typen av mottagare för den externa dataresursen. Standardvärdet är "Användare" om det inte anges. Ytterligare mottagartyper kan läggas till över tid.
userPrincipalName	string maxLength: 256		Mottagarens huvudnamn (e-postadress).

GroupDetails

Objekt

Gruppera specifik information. Gäller när huvudtypen är Group.

Name	Typ	Description
groupType	GroupType	Gruppens typ. Ytterligare grupptyper kan läggas till över tid.

GroupPrincipal

Objekt

Representerar en säkerhetsgrupp.

Name	Typ	Description
displayName	string	Huvudkontots visningsnamn.
groupDetails	GroupDetails	Gruppera specifik information. Gäller när huvudtypen är `Group`.
id	string (uuid)	Huvudmannens ID.
type	string: Group	Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

GroupType

Uppräkning

Gruppens typ. Ytterligare grupptyper kan läggas till över tid.

Värde	Description
Unknown	Huvudgrupptypen är okänd.
SecurityGroup	Huvudnamn är en säkerhetsgrupp.
DistributionList	Huvudnamn är en distributionslista.

PrincipalType

Uppräkning

Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

Värde	Description
User	Principal är ett Microsoft Entra-användarhuvudnamn.
ServicePrincipal	Principal är microsoft entra-tjänstens huvudnamn.
Group	Huvudnamn är en säkerhetsgrupp.
ServicePrincipalProfile	Huvudnamn är en profil för tjänstens huvudnamn.
EntireTenant	Huvudkontot representerar alla klientanvändare.

ServicePrincipalDetails

Objekt

Specifik information om tjänstens huvudnamn. Gäller när huvudtypen är ServicePrincipal.

Name	Typ	Description
aadAppId	string (uuid)	Tjänstens huvudnamns Microsoft Entra AppId.

ServicePrincipalPrincipal

Objekt

Representerar tjänstens huvudnamn för Microsoft Entra.

Name	Typ	Description
displayName	string	Huvudkontots visningsnamn.
id	string (uuid)	Huvudmannens ID.
servicePrincipalDetails	ServicePrincipalDetails	Specifik information om tjänstens huvudnamn. Gäller när huvudtypen är `ServicePrincipal`.
type	string: ServicePrincipal	Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

ServicePrincipalProfileDetails

Objekt

Profilinformation för tjänstens huvudnamn. Gäller när huvudtypen är ServicePrincipalProfile.

Name	Typ	Description
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Tjänstens huvudnamnsprofils överordnade huvudnamn.

ServicePrincipalProfilePrincipal

Objekt

Representerar en profil för tjänstens huvudnamn.

Name	Typ	Description
displayName	string	Huvudkontots visningsnamn.
id	string (uuid)	Huvudmannens ID.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Profilinformation för tjänstens huvudnamn. Gäller när huvudtypen är `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

UserDetails

Objekt

Specifik information om användarens huvudnamn. Gäller när huvudtypen är User.

Name	Typ	Description
userPrincipalName	string	Användarens huvudnamn.

UserPrincipal

Objekt

Representerar ett Microsoft Entra-användarhuvudnamn.

Name	Typ	Description
displayName	string	Huvudkontots visningsnamn.
id	string (uuid)	Huvudmannens ID.
type	string: User	Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.
userDetails	UserDetails	Specifik information om användarens huvudnamn. Gäller när huvudtypen är `User`.

External Data Shares Provider - Get External Data Share

Behörigheter

Obligatoriska delegerade omfång

Nödvändiga klientinställningar

Begränsningar

Identiteter som stöds av Microsoft Entra

Gränssnitt

URI-parametrar

Svar

Exempel

Get external data share example

Exempelbegäran

Exempelsvar

Definitioner

EntireTenantPrincipal

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ExternalDataShare

ExternalDataShareRecipientType

ExternalDataShareSPRecipient

ExternalDataShareStatus

ExternalDataShareUserRecipient

GroupDetails

GroupPrincipal

GroupType

PrincipalType

ServicePrincipalDetails

ServicePrincipalPrincipal

ServicePrincipalProfileDetails

ServicePrincipalProfilePrincipal

UserDetails

UserPrincipal