External Data Shares Provider - Create External Data Share

Servicio:: Core

Versión de la API:: v1

Crea un recurso compartido de datos externo para una ruta de acceso determinada o una lista de rutas de acceso en el elemento especificado.

Permissions

El autor de la llamada debe tener permisos de lectura y volver a compartir en el elemento.

Ámbitos delegados necesarios

Las API de elemento pueden tener uno de estos ámbitos en su token:

Ámbito genérico: Item.ExternalDataShare.All
Ámbito específico: itemType. ExternalDataShare.All, por ejemplo: Lakehouse.ExternalDataShare.All

Para obtener más información sobre los ámbitos, consulte el artículo ámbitos.

Configuración de inquilino necesaria

Para usar esta API, habilite el modificador Administrador de uso compartido de datos externos para la entidad de seguridad de llamada.

Limitations

Máximo de 10 solicitudes por minuto.

Tipos de elementos admitidos: vea Uso compartido de datos externos en Microsoft Fabric: tipos de elementos admitidos.

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

Identity	Support
User	Yes
Entidad de servicio e Identidades administradas	Yes

Interface

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
itemId	path	True	string (uuid)	Identificador del elemento.
workspaceId	path	True	string (uuid)	El identificador del área de trabajo.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
paths	True	string[]	Ruta de acceso o lista de rutas de acceso que se van a compartir externamente. Puede compartir hasta 100 rutas de acceso en cada recurso compartido. Una ruta de acceso válida a un recurso compartido de datos externo debe comenzar con "Files/" o "Tables/". No se puede compartir la propia carpeta raíz (Archivos o tablas). Por ejemplo, estas rutas de acceso son válidas: "Files/MyFolder1" "Tables/MySchema" "Tables/MyTable1"
recipient	True	ExternalDataShareRecipient	Destinatario al que se invita a aceptar el recurso compartido de datos externo.

Nombre

Requerido

Tipo

Description

paths

True

string[]

Ruta de acceso o lista de rutas de acceso que se van a compartir externamente. Puede compartir hasta 100 rutas de acceso en cada recurso compartido. Una ruta de acceso válida a un recurso compartido de datos externo debe comenzar con "Files/" o "Tables/". No se puede compartir la propia carpeta raíz (Archivos o tablas).

Por ejemplo, estas rutas de acceso son válidas:

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

recipient

True

ExternalDataShareRecipient

Destinatario al que se invita a aceptar el recurso compartido de datos externo.

Respuestas

Nombre	Tipo	Description
201 Created	ExternalDataShare	Se ha creado correctamente. Encabezados Location: string
Other Status Codes	ErrorResponse	Códigos de error comunes: UnknownError: se produjo un error.

Nombre

Tipo

Description

201 Created

ExternalDataShare

Se ha creado correctamente.

Encabezados

Location: string

Other Status Codes

ErrorResponse

Códigos de error comunes:

UnknownError: se produjo un error.

Ejemplos

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

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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"
}

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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"
}

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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"
}

Definiciones

Nombre	Description
CreateExternalDataShareRequest	Carga de solicitud para crear un recurso compartido de datos externo.
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
ExternalDataShare	Objeto de recurso compartido de datos externo.
ExternalDataShareRecipient	Representación del destinatario del recurso compartido de datos externo.
ExternalDataShareStatus	Estado de un recurso compartido de datos externo determinado. Se pueden agregar tipos de `ExternalDataShareStatus` adicionales a lo largo del tiempo.
GroupDetails	Detalles específicos del grupo. Aplicable cuando el tipo de entidad de seguridad es `Group`.
GroupType	Tipo del grupo. Se pueden agregar tipos de grupo adicionales a lo largo del tiempo.
Principal	Representa una identidad o un grupo de Microsoft Entra.
PrincipalType	Tipo de la entidad de seguridad. Se pueden agregar tipos de entidad de seguridad adicionales a lo largo del tiempo.
ServicePrincipalDetails	Detalles específicos de la entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es `ServicePrincipal`.
ServicePrincipalProfileDetails	Detalles del perfil de entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es `ServicePrincipalProfile`.
UserDetails	Detalles específicos de la entidad de seguridad de usuario. Aplicable cuando el tipo de entidad de seguridad es `User`.

CreateExternalDataShareRequest

Object

Carga de solicitud para crear un recurso compartido de datos externo.

Nombre	Tipo	Description
paths	string[]	Ruta de acceso o lista de rutas de acceso que se van a compartir externamente. Puede compartir hasta 100 rutas de acceso en cada recurso compartido. Una ruta de acceso válida a un recurso compartido de datos externo debe comenzar con "Files/" o "Tables/". No se puede compartir la propia carpeta raíz (Archivos o tablas). Por ejemplo, estas rutas de acceso son válidas: "Files/MyFolder1" "Tables/MySchema" "Tables/MyTable1"
recipient	ExternalDataShareRecipient	Destinatario al que se invita a aceptar el recurso compartido de datos externo.

Nombre

Tipo

Description

paths

string[]

Por ejemplo, estas rutas de acceso son válidas:

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

recipient

ExternalDataShareRecipient

Destinatario al que se invita a aceptar el recurso compartido de datos externo.

ErrorRelatedResource

Object

Objeto de detalles del recurso relacionado con el error.

Nombre	Tipo	Description
resourceId	string	Identificador de recurso implicado en el error.
resourceType	string	Tipo del recurso implicado en el error.

ErrorResponse

Object

Respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message	string	Representación legible del error.
moreDetails	ErrorResponseDetails[]	Lista de detalles de error adicionales.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.
requestId	string	Identificador de la solicitud asociada al error.

ErrorResponseDetails

Object

Detalles de la respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message	string	Representación legible del error.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.

ExternalDataShare

Object

Objeto de recurso compartido de datos externo.

Nombre	Tipo	Description
acceptedByTenantId	string (uuid)	Identificador de inquilino en el que se aceptó el recurso compartido de datos externo.
creatorPrincipal	Principal	Entidad de seguridad que creó el recurso compartido de datos externo.
expirationTimeUtc	string (date-time)	Fecha y hora de expiración (UTC) de la invitación al recurso compartido de datos externo.
id	string (uuid)	Identificador del recurso compartido de datos externo.
invitationUrl	string (uri)	Dirección URL para aceptar la invitación al recurso compartido de datos externo.
itemId	string (uuid)	Identificador del elemento.
paths	string[]	Ruta de acceso o lista de rutas de acceso compartidas externamente.
recipient	ExternalDataShareRecipient	Destinatario invitado a aceptar el recurso compartido de datos externo.
status	ExternalDataShareStatus	Estado del recurso compartido de datos externo.
workspaceId	string (uuid)	El identificador del área de trabajo.

ExternalDataShareRecipient

Object

Representación del destinatario del recurso compartido de datos externo.

Nombre	Tipo	Description
tenantId	string (uuid)	Identificador de inquilino del destinatario.
userPrincipalName	string maxLength: 256	Dirección de correo electrónico del destinatario.

ExternalDataShareStatus

Enumeración

Estado de un recurso compartido de datos externo determinado. Se pueden agregar tipos de ExternalDataShareStatus adicionales a lo largo del tiempo.

Valor	Description
Pending	Se creó una invitación y el destinatario ahora está pendiente de aceptación.
Active	El destinatario ha aceptado la invitación y el recurso compartido de datos externo está activo.
Revoked	Se revoca el recurso compartido de datos externo.
InvitationExpired	La invitación ha expirado y el destinatario ya no puede aceptarla.

GroupDetails

Object

Detalles específicos del grupo. Aplicable cuando el tipo de entidad de seguridad es Group.

Nombre	Tipo	Description
groupType	GroupType	Tipo del grupo. Se pueden agregar tipos de grupo adicionales a lo largo del tiempo.

GroupType

Enumeración

Tipo del grupo. Se pueden agregar tipos de grupo adicionales a lo largo del tiempo.

Valor	Description
Unknown	El tipo de grupo principal es desconocido.
SecurityGroup	La entidad de seguridad es un grupo de seguridad.
DistributionList	La entidad de seguridad es una lista de distribución.

Principal

Object

Representa una identidad o un grupo de Microsoft Entra.

Nombre	Tipo	Description
displayName	string	Nombre para mostrar de la entidad de seguridad.
groupDetails	GroupDetails	Detalles específicos del grupo. Aplicable cuando el tipo de entidad de seguridad es `Group`.
id	string (uuid)	Identificador de la entidad de seguridad.
servicePrincipalDetails	ServicePrincipalDetails	Detalles específicos de la entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es `ServicePrincipal`.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Detalles del perfil de entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es `ServicePrincipalProfile`.
type	PrincipalType	Tipo de la entidad de seguridad. Se pueden agregar tipos de entidad de seguridad adicionales a lo largo del tiempo.
userDetails	UserDetails	Detalles específicos de la entidad de seguridad de usuario. Aplicable cuando el tipo de entidad de seguridad es `User`.

PrincipalType

Enumeración

Tipo de la entidad de seguridad. Se pueden agregar tipos de entidad de seguridad adicionales a lo largo del tiempo.

Valor	Description
User	La entidad de seguridad es una entidad de seguridad de usuario de Microsoft Entra.
ServicePrincipal	La entidad de seguridad es una entidad de servicio de Microsoft Entra.
Group	La entidad de seguridad es un grupo de seguridad.
ServicePrincipalProfile	La entidad de servicio es un perfil de entidad de servicio.
EntireTenant	La entidad de seguridad representa todos los usuarios de inquilinos.

ServicePrincipalDetails

Object

Detalles específicos de la entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es ServicePrincipal.

Nombre	Tipo	Description
aadAppId	string (uuid)	Microsoft Entra AppId de la entidad de servicio.

ServicePrincipalProfileDetails

Object

Detalles del perfil de entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es ServicePrincipalProfile.

Nombre	Tipo	Description
parentPrincipal	Principal	La entidad de seguridad principal del perfil de la entidad de servicio.

UserDetails

Object

Detalles específicos de la entidad de seguridad de usuario. Aplicable cuando el tipo de entidad de seguridad es User.

Nombre	Tipo	Description
userPrincipalName	string	Nombre principal de usuario.

Compartir a través de

External Data Shares Provider - Create External Data Share

Permissions

Ámbitos delegados necesarios

Configuración de inquilino necesaria

Limitations

Identidades admitidas de Microsoft Entra

Interface

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Ejemplos

Create an external data share example

Solicitud de ejemplo

Respuesta de muestra

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

Solicitud de ejemplo

Respuesta de muestra

Create an external data share with multiple paths example

Solicitud de ejemplo

Respuesta de muestra

Definiciones

CreateExternalDataShareRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ExternalDataShare

ExternalDataShareRecipient

ExternalDataShareStatus

GroupDetails

GroupType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails