External Data Shares Provider - Get External Data Share

Palvelu:
Core
Ohjelmointirajapinnan versio:
v1

Palauttaa määritetyn ulkoisen dataresurssin tiedot.

Käyttöoikeudet

Soittajalla on oltava kohteen luku- ja uudelleenjakamisoikeudet.

Vaaditut delegoidut vaikutusalueet

Kohteen ohjelmointirajapinnoilla voi olla jokin näistä vaikutusalueista tunnunnissaan:

  • Yleinen vaikutusalue: Item.ExternalDataShare.All
  • Tietty vaikutusalue: itemType. ExternalDataShare.All, esimerkiksi: Lakehouse.ExternalDataShare.All

Lisätietoja vaikutusalueista on vaikutusalueita artikkelissa.

Vaaditut vuokraaja-asetukset

Jos haluat käyttää tätä ohjelmointirajapintaa, ota ulkoisen tietojen jakamisen järjestelmänvalvojan valitsin käyttöön kutsuvan päänimen kohdalla.

Rajoitukset

Enintään 10 pyyntöä minuuttia kohti.

Microsoft Entran tukemat käyttäjätiedot

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft -käyttäjätietoja.

Identiteetti Tuki
Käyttäjä Kyllä
palvelun päänimen ja Hallittujen käyttäjätietojen Kyllä

Rajapinta

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

URI-parametrit

Nimi Kohteessa Pakollinen Tyyppi Kuvaus
externalDataShareId
 path True

string (uuid)

Ulkoisten tietojen jakamisen tunnus.
itemId
 path True

string (uuid)

Kohdetunnus.
workspaceId
 path True

string (uuid)

Työtilan tunnus.

Vastaukset

Nimi Tyyppi Kuvaus
200 OK

ExternalDataShare

Pyynnön valmistuttua.
429 Too Many Requests

ErrorResponse

Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka Retry-After ilmaisee sekunteina, kuinka kauan asiakkaan on odotettava, ennen kuin lisäpyynnöt lähetetään.

Otsikot

Retry-After: integer
Other Status Codes

ErrorResponse

Yleiset virhekoodit:

  • UnknownError – Ilmeni virhe.

Esimerkit

Get external data share example

Mallipyyntö

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

Mallivastaus

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

Määritelmät

Nimi Kuvaus
EntireTenantPrincipal

Edustaa vuokraajan päänimeä
ErrorRelatedResource

Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse

Virhevastaus.
ErrorResponseDetails

Virheen vastauksen tiedot.
ExternalDataShare

Ulkoisen dataresurssin objekti.
ExternalDataShareRecipientType

Ulkoisen dataresurssin vastaanottajan tyyppi. Oletusarvo on "Käyttäjä", jos ei ole annettu. Muita vastaanottajatyyppejä voidaan lisätä ajan kuluessa.
ExternalDataShareSPRecipient

Ulkoisen dataresurssin vastaanottaja, joka on palvelun päänimi, tunnistetaan päätunnuksella ja vuokraajan tunnuksella.
ExternalDataShareStatus

Tietyn ulkoisen dataresurssin tila. Muita ExternalDataShareStatus tyyppejä voidaan lisätä ajan kuluessa.
ExternalDataShareUserRecipient

Ulkoisen dataresurssin vastaanottaja, joka on käyttäjä, tunnistetaan käyttäjän päänimellä (sähköpostiosoite). Tämä on oletusarvoinen vastaanottajatyyppi.
GroupDetails

Ryhmäkohtaiset tiedot. Soveltuu, kun päätyyppi on Group.
GroupPrincipal

Edustaa käyttöoikeusryhmää.
GroupType

Ryhmän tyyppi. Muita ryhmätyyppejä voidaan lisätä ajan mittaan.
PrincipalType

Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.
ServicePrincipalDetails

Palvelun päänimen tarkat tiedot. Soveltuu, kun päätyyppi on ServicePrincipal.
ServicePrincipalPrincipal

Edustaa Microsoft Entra -palvelun päänimeä.
ServicePrincipalProfileDetails

Palvelun pääprofiilin tiedot. Soveltuu, kun päätyyppi on ServicePrincipalProfile.
ServicePrincipalProfilePrincipal

Edustaa palvelun pääprofiilia.
UserDetails

Käyttäjän päänimen tarkat tiedot. Soveltuu, kun päätyyppi on User.
UserPrincipal

Edustaa Microsoft Entra -käyttäjäobjektia.

EntireTenantPrincipal

Kohde

Edustaa vuokraajan päänimeä

Nimi Tyyppi Kuvaus
displayName

string

Tämä on päänimen näyttönimi.
id

string (uuid)

Päänimen tunnus.
type string:

EntireTenant

Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.

ErrorRelatedResource

Kohde

Virheeseen liittyvä resurssitieto-objekti.

Nimi Tyyppi Kuvaus
resourceId

string

Virheestä liittyvä resurssitunnus.
resourceType

string

Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Kohde

Virhevastaus.

Nimi Tyyppi Kuvaus
errorCode

string

Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
isRetriable

boolean

Kun arvo on tosi, pyyntöä voidaan yrittää uudelleen. Määritä viive vastausotsikon Retry-After avulla, jos se on käytettävissä.
message

string

Ihmisen luettavissa oleva esitys virheestä.
moreDetails

ErrorResponseDetails[]

Luettelo virheiden lisätiedoista.
relatedResource

ErrorRelatedResource

Virheisiin liittyvät resurssitiedot.
requestId

string (uuid)

Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Kohde

Virheen vastauksen tiedot.

Nimi Tyyppi Kuvaus
errorCode

string

Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message

string

Ihmisen luettavissa oleva esitys virheestä.
relatedResource

ErrorRelatedResource

Virheisiin liittyvät resurssitiedot.

ExternalDataShare

Kohde

Ulkoisen dataresurssin objekti.

Nimi Tyyppi Kuvaus
acceptedByTenantId

string (uuid)

Vuokraajatunnus, jossa ulkoinen dataresurssi hyväksyttiin.
creatorPrincipal Principal:

Tämä on ulkoisen dataresurssin luonut päänimi.
expirationTimeUtc

string (date-time)

Ulkoiseen dataresurssiin kutsusta umpeutumispäivä ja -aika (UTC).
id

string (uuid)

Ulkoisten tietojen jakamisen tunnus.
invitationUrl

string (uri)

Url-osoite kutsun hyväksymiseksi ulkoiseen dataresurssiin.
itemId

string (uuid)

Kohdetunnus.
paths

string[]

Polku tai luettelo poluista, jotka on jaettu ulkoisesti.
recipient BaseExternalDataShareRecipient:

Vastaanottaja, joka on kutsuttu hyväksymään ulkoinen dataresurssi.
status

ExternalDataShareStatus

Ulkoisen dataresurssin tila.
workspaceId

string (uuid)

Työtilan tunnus.

ExternalDataShareRecipientType

Luettelointi

Ulkoisen dataresurssin vastaanottajan tyyppi. Oletusarvo on "Käyttäjä", jos ei ole annettu. Muita vastaanottajatyyppejä voidaan lisätä ajan kuluessa.

Arvo Kuvaus
ServicePrincipal

Vastaanottaja on palvelun päänimi, joka tunnistetaan objektitunnuksella ja vuokraajatunnuksella.
User

Vastaanottaja on käyttäjä, joka tunnistetaan käyttäjän päänimellä (sähköpostiosoite). Tämä on oletusarvo.

ExternalDataShareSPRecipient

Kohde

Ulkoisen dataresurssin vastaanottaja, joka on palvelun päänimi, tunnistetaan päätunnuksella ja vuokraajan tunnuksella.

Nimi Tyyppi Oletusarvo Kuvaus
principalId

string (uuid)

Palvelun päänimen vastaanottajan päätunnus. Tämä vastaa Entra ID -tunnus objektitunnusta.
tenantId

string (uuid)

Palvelun päänimen vastaanottajan vuokraajatunnus.
type string:

ServicePrincipal

User

Ulkoisen dataresurssin vastaanottajan tyyppi. Oletusarvo on "Käyttäjä", jos ei ole annettu. Muita vastaanottajatyyppejä voidaan lisätä ajan kuluessa.

ExternalDataShareStatus

Luettelointi

Tietyn ulkoisen dataresurssin tila. Muita ExternalDataShareStatus tyyppejä voidaan lisätä ajan kuluessa.

Arvo Kuvaus
Pending

Kutsu luotiin, ja vastaanottaja odottaa nyt hyväksyntää.
Active

Vastaanottaja on hyväksynyt kutsun ja ulkoinen dataresurssi on aktiivinen.
Revoked

Ulkoinen dataresurssi on kumottu.
InvitationExpired

Kutsu on vanhentunut, eikä vastaanottaja voi enää hyväksyä sitä.

ExternalDataShareUserRecipient

Kohde

Ulkoisen dataresurssin vastaanottaja, joka on käyttäjä, tunnistetaan käyttäjän päänimellä (sähköpostiosoite). Tämä on oletusarvoinen vastaanottajatyyppi.

Nimi Tyyppi Oletusarvo Kuvaus
tenantId

string (uuid)

Käyttäjän vastaanottajan vuokraajatunnus. Valinnainen.
type string:

User

User

Ulkoisen dataresurssin vastaanottajan tyyppi. Oletusarvo on "Käyttäjä", jos ei ole annettu. Muita vastaanottajatyyppejä voidaan lisätä ajan kuluessa.
userPrincipalName

string

maxLength: 256

Vastaanottajan täydellinen käyttäjätunnus (sähköpostiosoite).

GroupDetails

Kohde

Ryhmäkohtaiset tiedot. Soveltuu, kun päätyyppi on Group.

Nimi Tyyppi Kuvaus
groupType

GroupType

Ryhmän tyyppi. Muita ryhmätyyppejä voidaan lisätä ajan mittaan.

GroupPrincipal

Kohde

Edustaa käyttöoikeusryhmää.

Nimi Tyyppi Kuvaus
displayName

string

Tämä on päänimen näyttönimi.
groupDetails

GroupDetails

Ryhmäkohtaiset tiedot. Soveltuu, kun päätyyppi on Group.
id

string (uuid)

Päänimen tunnus.
type string:

Group

Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.

GroupType

Luettelointi

Ryhmän tyyppi. Muita ryhmätyyppejä voidaan lisätä ajan mittaan.

Arvo Kuvaus
Unknown

Pääryhmän tyyppi on tuntematon.
SecurityGroup

Principal on käyttöoikeusryhmä.
DistributionList

Principal on jakeluluettelo.

PrincipalType

Luettelointi

Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.

Arvo Kuvaus
User

Principal on Microsoft Entra -käyttäjäobjekti.
ServicePrincipal

Principal on Microsoft Entra -palvelun päänimi.
Group

Principal on käyttöoikeusryhmä.
ServicePrincipalProfile

Principal on palvelun pääprofiili.
EntireTenant

Principal edustaa kaikkia vuokraajan käyttäjiä.

ServicePrincipalDetails

Kohde

Palvelun päänimen tarkat tiedot. Soveltuu, kun päätyyppi on ServicePrincipal.

Nimi Tyyppi Kuvaus
aadAppId

string (uuid)

Palvelun päänimen Microsoft Entra AppId.

ServicePrincipalPrincipal

Kohde

Edustaa Microsoft Entra -palvelun päänimeä.

Nimi Tyyppi Kuvaus
displayName

string

Tämä on päänimen näyttönimi.
id

string (uuid)

Päänimen tunnus.
servicePrincipalDetails

ServicePrincipalDetails

Palvelun päänimen tarkat tiedot. Soveltuu, kun päätyyppi on ServicePrincipal.
type string:

ServicePrincipal

Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.

ServicePrincipalProfileDetails

Kohde

Palvelun pääprofiilin tiedot. Soveltuu, kun päätyyppi on ServicePrincipalProfile.

Nimi Tyyppi Kuvaus
parentPrincipal Principal:

Palvelun pääprofiilin pääobjekti.

ServicePrincipalProfilePrincipal

Kohde

Edustaa palvelun pääprofiilia.

Nimi Tyyppi Kuvaus
displayName

string

Tämä on päänimen näyttönimi.
id

string (uuid)

Päänimen tunnus.
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Palvelun pääprofiilin tiedot. Soveltuu, kun päätyyppi on ServicePrincipalProfile.
type string:

ServicePrincipalProfile

Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.

UserDetails

Kohde

Käyttäjän päänimen tarkat tiedot. Soveltuu, kun päätyyppi on User.

Nimi Tyyppi Kuvaus
userPrincipalName

string

Täydellinen käyttäjänimi.

UserPrincipal

Kohde

Edustaa Microsoft Entra -käyttäjäobjektia.

Nimi Tyyppi Kuvaus
displayName

string

Tämä on päänimen näyttönimi.
id

string (uuid)

Päänimen tunnus.
type string:

User

Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.
userDetails

UserDetails

Käyttäjän päänimen tarkat tiedot. Soveltuu, kun päätyyppi on User.