External Data Shares Provider - Create External Data Share

Service:: Core

Version d'API:: v1

Crée un partage de données externe pour un chemin d’accès donné ou une liste de chemins d’accès dans l’élément spécifié.

Permissions

L’appelant doit disposer d’autorisations de lecture et de partage sur l’élément.

Étendues déléguées requises

Les API d’élément peuvent avoir l’une de ces étendues dans leur jeton :

Étendue générique : Item.ExternalDataShare.All
Étendue spécifique : itemType. ExternalDataShare.All, par exemple : Lakehouse.ExternalDataShare.All

Pour plus d’informations sur les étendues, consultez article sur les étendues.

Paramètres de locataire requis

Pour utiliser cette API, activez le commutateur d’administrateur de partage de données externe pour le principal appelant.

Limitations

Maximum 10 requêtes par minute.

Types d’éléments pris en charge : consultez partage de données externes dans Microsoft Fabric - Types d’éléments pris en charge.

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identity	Support
User	Yes
Service principal et identités gérées	Yes

Interface

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
itemId	path	True	string (uuid)	ID d’élément.
workspaceId	path	True	string (uuid)	Identifiant de l’espace de travail.

Corps de la demande

Nom	Obligatoire	Type	Description
paths	True	string[]	Chemin d’accès ou liste de chemins d’accès à partager en externe. Vous pouvez partager jusqu’à 100 chemins d’accès dans chaque partage. Un chemin d’accès valide à un partage de données externe doit commencer par « Fichiers/ » ou « Tables/ ». Vous ne pouvez pas partager le dossier racine lui-même (fichiers ou tables). Par exemple, ces chemins d’accès sont valides : "Files/MyFolder1" « Tables/MySchema » "Tables/MyTable1"
recipient	True	ExternalDataShareRecipient	Destinataire invité à accepter le partage de données externe.

Nom

Obligatoire

Type

Description

paths

True

string[]

Chemin d’accès ou liste de chemins d’accès à partager en externe. Vous pouvez partager jusqu’à 100 chemins d’accès dans chaque partage. Un chemin d’accès valide à un partage de données externe doit commencer par « Fichiers/ » ou « Tables/ ». Vous ne pouvez pas partager le dossier racine lui-même (fichiers ou tables).

Par exemple, ces chemins d’accès sont valides :

"Files/MyFolder1"
« Tables/MySchema »
"Tables/MyTable1"

recipient

True

ExternalDataShareRecipient

Destinataire invité à accepter le partage de données externe.

Réponses

Nom	Type	Description
201 Created	ExternalDataShare	Création réussie. En-têtes Location: string
Other Status Codes	ErrorResponse	Codes d’erreur courants : UnknownError : une erreur s’est produite.

Nom

Type

Description

201 Created

ExternalDataShare

Création réussie.

En-têtes

Location: string

Other Status Codes

ErrorResponse

Codes d’erreur courants :

UnknownError : une erreur s’est produite.

Exemples

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

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
}

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
}

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
}

Définitions

Nom	Description
CreateExternalDataShareRequest	Charge utile de la demande pour la création d’un partage de données externe.
ErrorRelatedResource	Objet de détails de ressource associé à l’erreur.
ErrorResponse	Réponse d’erreur.
ErrorResponseDetails	Détails de la réponse d’erreur.
ExternalDataShare	Objet de partage de données externe.
ExternalDataShareRecipient	Représentation du destinataire du partage de données externe.
ExternalDataShareStatus	État d’un partage de données externe donné. Des types `ExternalDataShareStatus` supplémentaires peuvent être ajoutés au fil du temps.
GroupDetails	Détails spécifiques du groupe. Applicable lorsque le type principal est `Group`.
GroupType	Type du groupe. Des types de groupes supplémentaires peuvent être ajoutés au fil du temps.
Principal	Représente une identité ou un groupe Microsoft Entra.
PrincipalType	Type du principal. Des types principaux supplémentaires peuvent être ajoutés au fil du temps.
ServicePrincipalDetails	Détails spécifiques au principal de service. Applicable lorsque le type principal est `ServicePrincipal`.
ServicePrincipalProfileDetails	Détails du profil du principal de service. Applicable lorsque le type principal est `ServicePrincipalProfile`.
UserDetails	Détails spécifiques au principal de l’utilisateur. Applicable lorsque le type principal est `User`.

CreateExternalDataShareRequest

Object

Charge utile de la demande pour la création d’un partage de données externe.

Nom	Type	Description
paths	string[]	Chemin d’accès ou liste de chemins d’accès à partager en externe. Vous pouvez partager jusqu’à 100 chemins d’accès dans chaque partage. Un chemin d’accès valide à un partage de données externe doit commencer par « Fichiers/ » ou « Tables/ ». Vous ne pouvez pas partager le dossier racine lui-même (fichiers ou tables). Par exemple, ces chemins d’accès sont valides : "Files/MyFolder1" « Tables/MySchema » "Tables/MyTable1"
recipient	ExternalDataShareRecipient	Destinataire invité à accepter le partage de données externe.

Nom

Type

Description

paths

string[]

Par exemple, ces chemins d’accès sont valides :

"Files/MyFolder1"
« Tables/MySchema »
"Tables/MyTable1"

recipient

ExternalDataShareRecipient

Destinataire invité à accepter le partage de données externe.

ErrorRelatedResource

Object

Objet de détails de ressource associé à l’erreur.

Nom	Type	Description
resourceId	string	ID de ressource impliqué dans l’erreur.
resourceType	string	Type de la ressource impliquée dans l’erreur.

ErrorResponse

Object

Réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
moreDetails	ErrorResponseDetails[]	Liste des détails d’erreur supplémentaires.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.
requestId	string	ID de la demande associée à l’erreur.

ErrorResponseDetails

Object

Détails de la réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.

ExternalDataShare

Object

Objet de partage de données externe.

Nom	Type	Description
acceptedByTenantId	string (uuid)	ID de locataire dans lequel le partage de données externe a été accepté.
creatorPrincipal	Principal	Principal qui a créé le partage de données externe.
expirationTimeUtc	string (date-time)	Date et heure d’expiration (UTC) de l’invitation au partage de données externe.
id	string (uuid)	ID de partage de données externe.
invitationUrl	string (uri)	URL permettant d’accepter l’invitation au partage de données externe.
itemId	string (uuid)	ID d’élément.
paths	string[]	Chemin d’accès ou liste de chemins d’accès partagés en externe.
recipient	ExternalDataShareRecipient	Destinataire invité à accepter le partage de données externe.
status	ExternalDataShareStatus	État du partage de données externe.
workspaceId	string (uuid)	Identifiant de l’espace de travail.

ExternalDataShareRecipient

Object

Représentation du destinataire du partage de données externe.

Nom	Type	Description
tenantId	string (uuid)	ID de locataire du destinataire.
userPrincipalName	string maxLength: 256	Adresse e-mail du destinataire.

ExternalDataShareStatus

Énumération

État d’un partage de données externe donné. Des types ExternalDataShareStatus supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
Pending	Une invitation a été créée et est maintenant en attente d’acceptation par le destinataire.
Active	L’invitation a été acceptée par le destinataire et le partage de données externe est actif.
Revoked	Le partage de données externe a été révoqué.
InvitationExpired	L’invitation a expiré et ne peut plus être acceptée par le destinataire.

GroupDetails

Object

Détails spécifiques du groupe. Applicable lorsque le type principal est Group.

Nom	Type	Description
groupType	GroupType	Type du groupe. Des types de groupes supplémentaires peuvent être ajoutés au fil du temps.

GroupType

Énumération

Type du groupe. Des types de groupes supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
Unknown	Le type de groupe principal est inconnu.
SecurityGroup	Principal est un groupe de sécurité.
DistributionList	Principal est une liste de distribution.

Principal

Object

Représente une identité ou un groupe Microsoft Entra.

Nom	Type	Description
displayName	string	Nom complet du principal.
groupDetails	GroupDetails	Détails spécifiques du groupe. Applicable lorsque le type principal est `Group`.
id	string (uuid)	ID du principal.
servicePrincipalDetails	ServicePrincipalDetails	Détails spécifiques au principal de service. Applicable lorsque le type principal est `ServicePrincipal`.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Détails du profil du principal de service. Applicable lorsque le type principal est `ServicePrincipalProfile`.
type	PrincipalType	Type du principal. Des types principaux supplémentaires peuvent être ajoutés au fil du temps.
userDetails	UserDetails	Détails spécifiques au principal de l’utilisateur. Applicable lorsque le type principal est `User`.

PrincipalType

Énumération

Type du principal. Des types principaux supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
User	Principal est un principal d’utilisateur Microsoft Entra.
ServicePrincipal	Principal est un principal de service Microsoft Entra.
Group	Principal est un groupe de sécurité.
ServicePrincipalProfile	Le principal est un profil de principal de service.
EntireTenant	Le principal représente tous les utilisateurs du locataire.

ServicePrincipalDetails

Object

Détails spécifiques au principal de service. Applicable lorsque le type principal est ServicePrincipal.

Nom	Type	Description
aadAppId	string (uuid)	Microsoft EntraId du principal de service.

ServicePrincipalProfileDetails

Object

Détails du profil du principal de service. Applicable lorsque le type principal est ServicePrincipalProfile.

Nom	Type	Description
parentPrincipal	Principal	Principal parent du profil de principal de service.

UserDetails

Object

Détails spécifiques au principal de l’utilisateur. Applicable lorsque le type principal est User.

Nom	Type	Description
userPrincipalName	string	Nom d’utilisateur principal.

Partager via

External Data Shares Provider - Create External Data Share

Permissions

Étendues déléguées requises

Paramètres de locataire requis

Limitations

Identités prises en charge par Microsoft Entra

Interface

Paramètres URI

Corps de la demande

Réponses

Exemples

Create an external data share example

Exemple de requête

Exemple de réponse

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

Exemple de requête

Exemple de réponse

Create an external data share with multiple paths example

Exemple de requête

Exemple de réponse

Définitions

CreateExternalDataShareRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ExternalDataShare

ExternalDataShareRecipient

ExternalDataShareStatus

GroupDetails

GroupType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails