External Data Shares Provider - Create External Data Share

Usługa:: Core

Wersja interfejsu API:: v1

Tworzy zewnętrzny udział danych dla danej ścieżki lub listy ścieżek w określonym elemencie.

Permissions

Obiekt wywołujący musi mieć uprawnienia do odczytu i udostępniania dalej w elemencie.

Wymagane zakresy delegowane

Interfejsy API elementów mogą mieć jeden z tych zakresów w tokenie:

Zakres ogólny: Item.ExternalDataShare.All
Określony zakres: itemType. ExternalDataShare.All, na przykład: Lakehouse.ExternalDataShare.All

Aby uzyskać więcej informacji na temat zakresów, zobacz artykuł dotyczący zakresów.

Wymagane ustawienia dzierżawy

Aby użyć tego interfejsu API, włącz przełącznik administratora udostępniania danych zewnętrznych dla nazwy głównej wywołującej.

Limitations

Maksymalnie 10 żądań na minutę.

Obsługiwane typy elementów: zobacz Udostępnianie danych zewnętrznych w usłudze Microsoft Fabric — obsługiwane typy elementów.

Tożsamości obsługiwane przez Microsoft Entra

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Identity	Support
User	Yes
Główne usługi i Tożsamości zarządzane	Yes

Interface

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
itemId	path	True	string (uuid)	Identyfikator elementu.
workspaceId	path	True	string (uuid)	Identyfikator przestrzeni roboczej.

Treść żądania

Nazwa	Wymagane	Typ	Opis
paths	True	string[]	Ścieżka lub lista ścieżek, które mają być udostępniane zewnętrznie. W każdym udziale można udostępniać maksymalnie 100 ścieżek. Prawidłowa ścieżka do zewnętrznego udziału danych musi zaczynać się od "Pliki/" lub "Tabele/". Nie można udostępnić samego folderu głównego (pliki lub tabele). Na przykład następujące ścieżki są prawidłowe: "Files/MyFolder1" "Tables/MySchema" "Tables/MyTable1"
recipient	True	ExternalDataShareRecipient	Odbiorca, który jest zaproszony do zaakceptowania zewnętrznego udziału danych.

Nazwa

Wymagane

Typ

Opis

paths

True

string[]

Ścieżka lub lista ścieżek, które mają być udostępniane zewnętrznie. W każdym udziale można udostępniać maksymalnie 100 ścieżek. Prawidłowa ścieżka do zewnętrznego udziału danych musi zaczynać się od "Pliki/" lub "Tabele/". Nie można udostępnić samego folderu głównego (pliki lub tabele).

Na przykład następujące ścieżki są prawidłowe:

"Files/MyFolder1"
"Tables/MySchema"
"Tables/MyTable1"

recipient

True

ExternalDataShareRecipient

Odbiorca, który jest zaproszony do zaakceptowania zewnętrznego udziału danych.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	ExternalDataShare	Pomyślnie utworzono. Nagłówki Location: string
Other Status Codes	ErrorResponse	Typowe kody błędów: UnknownError — wystąpił błąd.

Nazwa

Typ

Opis

201 Created

ExternalDataShare

Pomyślnie utworzono.

Nagłówki

Location: string

Other Status Codes

ErrorResponse

Typowe kody błędów:

UnknownError — wystąpił błąd.

Przykłady

Create an external data share example

Create an external data share with a specific recipient tenant ID example

Create an external data share with multiple paths example

Przykładowe żądanie

HTTP

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

{
  "paths": [
    "Files/Sales/Contoso_Sales_2023"
  ],
  "recipient": {
    "userPrincipalName": "lisa@fabrikam.com"
  }
}

Przykładowa odpowiedź

Kod stanu:: 201

Location: https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/5b218778-e7a5-4d73-8187-f10824047715/externalDataShares/dccc162f-7a41-4720-83c3-5c7e81187959

{
  "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"
}

Przykładowe żądanie

HTTP

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

{
  "paths": [
    "Files/Sales/Contoso_Sales_2023"
  ],
  "recipient": {
    "userPrincipalName": "lisa@fabrikam.com",
    "tenantId": "c51dc03f-268a-4da0-a879-25f24947ab8b"
  }
}

Przykładowa odpowiedź

Kod stanu:: 201

Location: https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/5b218778-e7a5-4d73-8187-f10824047715/externalDataShares/dccc162f-7a41-4720-83c3-5c7e81187959

{
  "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",
    "tenantId": "c51dc03f-268a-4da0-a879-25f24947ab8b"
  },
  "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"
}

Przykładowe żądanie

HTTP

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

{
  "paths": [
    "Files/Sales/Contoso_Sales_2023",
    "Files/Sales/Contoso_Sales_2024/SubFolder1",
    "Files/Sales/Contoso_Sales_2024/SubFolder2/SubFolder3"
  ],
  "recipient": {
    "userPrincipalName": "lisa@fabrikam.com"
  }
}

Przykładowa odpowiedź

Kod stanu:: 201

Location: https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/5b218778-e7a5-4d73-8187-f10824047715/externalDataShares/dccc162f-7a41-4720-83c3-5c7e81187959

{
  "id": "dccc162f-7a41-4720-83c3-5c7e81187959",
  "paths": [
    "Files/Sales/Contoso_Sales_2023",
    "Files/Sales/Contoso_Sales_2024/SubFolder1",
    "Files/Sales/Contoso_Sales_2024/SubFolder2/SubFolder3"
  ],
  "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"
}

Definicje

Nazwa	Opis
CreateExternalDataShareRequest	Ładunek żądania do tworzenia zewnętrznego udziału danych.
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
ExternalDataShare	Obiekt zewnętrznego udziału danych.
ExternalDataShareRecipient	Reprezentacja adresata zewnętrznego udziału danych.
ExternalDataShareStatus	Stan danego udziału danych zewnętrznych. Dodatkowe typy `ExternalDataShareStatus` można dodawać w czasie.
GroupDetails	Grupuj szczegółowe informacje. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość `Group`.
GroupType	Typ grupy. Dodatkowe typy grup mogą być dodawane w czasie.
Principal	Reprezentuje tożsamość lub grupę firmy Microsoft Entra.
PrincipalType	Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.
ServicePrincipalDetails	Szczegóły dotyczące jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość `ServicePrincipal`.
ServicePrincipalProfileDetails	Szczegóły profilu jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość `ServicePrincipalProfile`.
UserDetails	Szczegóły dotyczące podmiotu zabezpieczeń użytkownika. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość `User`.

CreateExternalDataShareRequest

Objekt

Ładunek żądania do tworzenia zewnętrznego udziału danych.

Nazwa	Typ	Opis
paths	string[]	Ścieżka lub lista ścieżek, które mają być udostępniane zewnętrznie. W każdym udziale można udostępniać maksymalnie 100 ścieżek. Prawidłowa ścieżka do zewnętrznego udziału danych musi zaczynać się od "Pliki/" lub "Tabele/". Nie można udostępnić samego folderu głównego (pliki lub tabele). Na przykład następujące ścieżki są prawidłowe: "Files/MyFolder1" "Tables/MySchema" "Tables/MyTable1"
recipient	ExternalDataShareRecipient	Odbiorca, który jest zaproszony do zaakceptowania zewnętrznego udziału danych.

Nazwa

Typ

Opis

paths

string[]

Na przykład następujące ścieżki są prawidłowe:

"Files/MyFolder1"
"Tables/MySchema"
"Tables/MyTable1"

recipient

ExternalDataShareRecipient

Odbiorca, który jest zaproszony do zaakceptowania zewnętrznego udziału danych.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa	Typ	Opis
resourceId	string	Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType	string	Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.

ExternalDataShare

Objekt

Obiekt zewnętrznego udziału danych.

Nazwa	Typ	Opis
acceptedByTenantId	string (uuid)	Identyfikator dzierżawy, w którym zaakceptowano zewnętrzny udział danych.
creatorPrincipal	Principal	Podmiot zabezpieczeń, który utworzył zewnętrzny udział danych.
expirationTimeUtc	string (date-time)	Data i godzina wygaśnięcia zaproszenia do udziału danych zewnętrznych (UTC).
id	string (uuid)	Identyfikator zewnętrznego udziału danych.
invitationUrl	string (uri)	Adres URL akceptowania zaproszenia do zewnętrznego udziału danych.
itemId	string (uuid)	Identyfikator elementu.
paths	string[]	Ścieżka lub lista ścieżek, które są udostępniane zewnętrznie.
recipient	ExternalDataShareRecipient	Odbiorca, który został zaproszony do zaakceptowania zewnętrznego udziału danych.
status	ExternalDataShareStatus	Stan zewnętrznego udziału danych.
workspaceId	string (uuid)	Identyfikator przestrzeni roboczej.

ExternalDataShareRecipient

Objekt

Reprezentacja adresata zewnętrznego udziału danych.

Nazwa	Typ	Opis
tenantId	string (uuid)	Identyfikator dzierżawy odbiorcy.
userPrincipalName	string maxLength: 256	Adres e-mail adresata.

ExternalDataShareStatus

Wyliczanie

Stan danego udziału danych zewnętrznych. Dodatkowe typy ExternalDataShareStatus można dodawać w czasie.

Wartość	Opis
Pending	Zaproszenie zostało utworzone i oczekuje na zaakceptowanie przez adresata.
Active	Zaproszenie zostało zaakceptowane przez adresata, a udział danych zewnętrznych jest aktywny.
Revoked	Zewnętrzny udział danych został odwołany.
InvitationExpired	Zaproszenie wygasło i nie może zostać zaakceptowane przez adresata.

GroupDetails

Objekt

Grupuj szczegółowe informacje. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość Group.

Nazwa	Typ	Opis
groupType	GroupType	Typ grupy. Dodatkowe typy grup mogą być dodawane w czasie.

GroupType

Wyliczanie

Typ grupy. Dodatkowe typy grup mogą być dodawane w czasie.

Wartość	Opis
Unknown	Typ grupy podmiotu zabezpieczeń jest nieznany.
SecurityGroup	Podmiot zabezpieczeń jest grupą zabezpieczeń.
DistributionList	Podmiot zabezpieczeń jest listą dystrybucyjną.

Principal

Objekt

Reprezentuje tożsamość lub grupę firmy Microsoft Entra.

Nazwa	Typ	Opis
displayName	string	Nazwa wyświetlana podmiotu zabezpieczeń.
groupDetails	GroupDetails	Grupuj szczegółowe informacje. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość `Group`.
id	string (uuid)	Identyfikator podmiotu zabezpieczeń.
servicePrincipalDetails	ServicePrincipalDetails	Szczegóły dotyczące jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość `ServicePrincipal`.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Szczegóły profilu jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość `ServicePrincipalProfile`.
type	PrincipalType	Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.
userDetails	UserDetails	Szczegóły dotyczące podmiotu zabezpieczeń użytkownika. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość `User`.

PrincipalType

Wyliczanie

Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.

Wartość	Opis
User	Podmiot zabezpieczeń jest podmiotem zabezpieczeń użytkownika firmy Microsoft Entra.
ServicePrincipal	Jednostka jest jednostką usługi Microsoft Entra.
Group	Podmiot zabezpieczeń jest grupą zabezpieczeń.
ServicePrincipalProfile	Jednostka jest profilem jednostki usługi.
EntireTenant	Podmiot zabezpieczeń reprezentuje wszystkich użytkowników dzierżawy.

ServicePrincipalDetails

Objekt

Szczegóły dotyczące jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość ServicePrincipal.

Nazwa	Typ	Opis
aadAppId	string (uuid)	Jednostka usługi Firmy Microsoft Entra AppId.

ServicePrincipalProfileDetails

Objekt

Szczegóły profilu jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość ServicePrincipalProfile.

Nazwa	Typ	Opis
parentPrincipal	Principal	Jednostka nadrzędna profilu jednostki usługi.

UserDetails

Objekt

Szczegóły dotyczące podmiotu zabezpieczeń użytkownika. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość User.

Nazwa	Typ	Opis
userPrincipalName	string	Główna nazwa użytkownika.

Udostępnij przez

External Data Shares Provider - Create External Data Share

Permissions

Wymagane zakresy delegowane

Wymagane ustawienia dzierżawy

Limitations

Tożsamości obsługiwane przez Microsoft Entra

Interface

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Przykłady

Create an external data share example

Przykładowe żądanie

Przykładowa odpowiedź

Create an external data share with a specific recipient tenant ID example

Przykładowe żądanie

Przykładowa odpowiedź

Create an external data share with multiple paths example

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

CreateExternalDataShareRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ExternalDataShare

ExternalDataShareRecipient

ExternalDataShareStatus

GroupDetails

GroupType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails