External Data Shares Provider - Create External Data Share

Serviço:: Core

Versão da API:: v1

Cria um compartilhamento de dados externo para um determinado caminho ou lista de caminhos no item especificado.

Permissions

O chamador deve ter permissões de leitura e recompartilhação no item.

Escopos delegados necessários

As APIs de item podem ter um destes escopos em seu token:

Escopo genérico: Item.ExternalDataShare.All
Escopo específico: itemType. ExternalDataShare.All, por exemplo: Lakehouse.ExternalDataShare.All

Para obter mais informações sobre escopos, consulte artigo de escopos.

Configurações de locatário necessárias

Para usar essa API, habilite a opção de administrador de compartilhamento de dados externos para a entidade de segurança de chamada.

Limitations

Máximo de 10 solicitações por minuto.

Tipos de item com suporte: consulte compartilhamento de dados externos no Microsoft Fabric – tipos de item com suporte.

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identity	Support
User	Yes
Entidade de serviço e identidades gerenciadas	Yes

Interface

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
itemId	path	True	string (uuid)	A ID do item.
workspaceId	path	True	string (uuid)	O identificador do espaço de trabalho.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
paths	True	string[]	O caminho ou a lista de caminhos que devem ser compartilhados externamente. Você pode compartilhar até 100 caminhos em cada compartilhamento. Um caminho válido para um compartilhamento de dados externo deve começar com "Arquivos/" ou "Tabelas/". Você não pode compartilhar a pasta raiz em si (Arquivos ou Tabelas). Por exemplo, esses caminhos são válidos: "Files/MyFolder1" "Tables/MySchema" "Tables/MyTable1"
recipient	True	ExternalDataShareRecipient	O destinatário que é convidado a aceitar o compartilhamento de dados externo.

Nome

Obrigatório

Tipo

Description

paths

True

string[]

O caminho ou a lista de caminhos que devem ser compartilhados externamente. Você pode compartilhar até 100 caminhos em cada compartilhamento. Um caminho válido para um compartilhamento de dados externo deve começar com "Arquivos/" ou "Tabelas/". Você não pode compartilhar a pasta raiz em si (Arquivos ou Tabelas).

Por exemplo, esses caminhos são válidos:

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

recipient

True

ExternalDataShareRecipient

O destinatário que é convidado a aceitar o compartilhamento de dados externo.

Respostas

Nome	Tipo	Description
201 Created	ExternalDataShare	Criado com êxito. Cabeçalhos Location: string
Other Status Codes	ErrorResponse	Códigos de erro comuns: UnknownError – Ocorreu um erro.

Nome

Tipo

Description

201 Created

ExternalDataShare

Criado com êxito.

Cabeçalhos

Location: string

Other Status Codes

ErrorResponse

Códigos de erro comuns:

UnknownError – Ocorreu um erro.

Exemplos

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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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"
}

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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"
}

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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"
}

Definições

Nome	Description
CreateExternalDataShareRequest	O conteúdo da solicitação para criar um compartilhamento de dados externo.
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
ExternalDataShare	Um objeto de compartilhamento de dados externo.
ExternalDataShareRecipient	Uma representação do destinatário do compartilhamento de dados externo.
ExternalDataShareStatus	O status de um determinado compartilhamento de dados externo. Tipos de `ExternalDataShareStatus` adicionais podem ser adicionados ao longo do tempo.
GroupDetails	Detalhes específicos do grupo. Aplicável quando o tipo principal é `Group`.
GroupType	O tipo do grupo. Tipos de grupo adicionais podem ser adicionados ao longo do tempo.
Principal	Representa uma identidade ou um grupo do Microsoft Entra.
PrincipalType	O tipo da entidade de segurança. Tipos de entidades de segurança adicionais podem ser adicionados ao longo do tempo.
ServicePrincipalDetails	Detalhes específicos da entidade de serviço. Aplicável quando o tipo principal é `ServicePrincipal`.
ServicePrincipalProfileDetails	Detalhes do perfil da entidade de serviço. Aplicável quando o tipo principal é `ServicePrincipalProfile`.
UserDetails	Detalhes específicos da entidade de usuário. Aplicável quando o tipo principal é `User`.

CreateExternalDataShareRequest

Objeto

O conteúdo da solicitação para criar um compartilhamento de dados externo.

Nome	Tipo	Description
paths	string[]	O caminho ou a lista de caminhos que devem ser compartilhados externamente. Você pode compartilhar até 100 caminhos em cada compartilhamento. Um caminho válido para um compartilhamento de dados externo deve começar com "Arquivos/" ou "Tabelas/". Você não pode compartilhar a pasta raiz em si (Arquivos ou Tabelas). Por exemplo, esses caminhos são válidos: "Files/MyFolder1" "Tables/MySchema" "Tables/MyTable1"
recipient	ExternalDataShareRecipient	O destinatário que é convidado a aceitar o compartilhamento de dados externo.

Nome

Tipo

Description

paths

string[]

Por exemplo, esses caminhos são válidos:

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

recipient

ExternalDataShareRecipient

O destinatário que é convidado a aceitar o compartilhamento de dados externo.

ErrorRelatedResource

Objeto

O objeto de detalhes do recurso relacionado ao erro.

Nome	Tipo	Description
resourceId	string	A ID do recurso envolvida no erro.
resourceType	string	O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.
requestId	string	ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.

ExternalDataShare

Objeto

Um objeto de compartilhamento de dados externo.

Nome	Tipo	Description
acceptedByTenantId	string (uuid)	A ID do locatário na qual o compartilhamento de dados externo foi aceito.
creatorPrincipal	Principal	A entidade de segurança que criou o compartilhamento de dados externo.
expirationTimeUtc	string (date-time)	A data e hora de expiração (UTC) do convite para o compartilhamento de dados externo.
id	string (uuid)	A ID do compartilhamento de dados externo.
invitationUrl	string (uri)	A URL para aceitar o convite para o compartilhamento de dados externo.
itemId	string (uuid)	A ID do item.
paths	string[]	O caminho ou a lista de caminhos compartilhados externamente.
recipient	ExternalDataShareRecipient	O destinatário que foi convidado a aceitar o compartilhamento de dados externo.
status	ExternalDataShareStatus	O status do compartilhamento de dados externo.
workspaceId	string (uuid)	O identificador do espaço de trabalho.

ExternalDataShareRecipient

Objeto

Uma representação do destinatário do compartilhamento de dados externo.

Nome	Tipo	Description
tenantId	string (uuid)	A ID do locatário do destinatário.
userPrincipalName	string maxLength: 256	O endereço de email do destinatário.

ExternalDataShareStatus

Enumeração

O status de um determinado compartilhamento de dados externo. Tipos de ExternalDataShareStatus adicionais podem ser adicionados ao longo do tempo.

Valor	Description
Pending	Um convite foi criado e agora está pendente de aceitação pelo destinatário.
Active	O convite foi aceito pelo destinatário e o compartilhamento de dados externo está ativo.
Revoked	O compartilhamento de dados externo foi revogado.
InvitationExpired	O convite expirou e não pode mais ser aceito pelo destinatário.

GroupDetails

Objeto

Detalhes específicos do grupo. Aplicável quando o tipo principal é Group.

Nome	Tipo	Description
groupType	GroupType	O tipo do grupo. Tipos de grupo adicionais podem ser adicionados ao longo do tempo.

GroupType

Enumeração

O tipo do grupo. Tipos de grupo adicionais podem ser adicionados ao longo do tempo.

Valor	Description
Unknown	O tipo de grupo principal é desconhecido.
SecurityGroup	A entidade de segurança é um grupo de segurança.
DistributionList	Principal é uma lista de distribuição.

Principal

Objeto

Representa uma identidade ou um grupo do Microsoft Entra.

Nome	Tipo	Description
displayName	string	O nome de exibição da entidade de segurança.
groupDetails	GroupDetails	Detalhes específicos do grupo. Aplicável quando o tipo principal é `Group`.
id	string (uuid)	A ID da entidade de segurança.
servicePrincipalDetails	ServicePrincipalDetails	Detalhes específicos da entidade de serviço. Aplicável quando o tipo principal é `ServicePrincipal`.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Detalhes do perfil da entidade de serviço. Aplicável quando o tipo principal é `ServicePrincipalProfile`.
type	PrincipalType	O tipo da entidade de segurança. Tipos de entidades de segurança adicionais podem ser adicionados ao longo do tempo.
userDetails	UserDetails	Detalhes específicos da entidade de usuário. Aplicável quando o tipo principal é `User`.

PrincipalType

Enumeração

O tipo da entidade de segurança. Tipos de entidades de segurança adicionais podem ser adicionados ao longo do tempo.

Valor	Description
User	Principal é uma entidade de usuário do Microsoft Entra.
ServicePrincipal	A entidade de segurança é uma entidade de serviço do Microsoft Entra.
Group	A entidade de segurança é um grupo de segurança.
ServicePrincipalProfile	Principal é um perfil de entidade de serviço.
EntireTenant	A entidade de segurança representa todos os usuários do locatário.

ServicePrincipalDetails

Objeto

Detalhes específicos da entidade de serviço. Aplicável quando o tipo principal é ServicePrincipal.

Nome	Tipo	Description
aadAppId	string (uuid)	O Microsoft Entra AppId da entidade de serviço.

ServicePrincipalProfileDetails

Objeto

Detalhes do perfil da entidade de serviço. Aplicável quando o tipo principal é ServicePrincipalProfile.

Nome	Tipo	Description
parentPrincipal	Principal	A entidade pai do perfil da entidade de serviço.

UserDetails

Objeto

Detalhes específicos da entidade de usuário. Aplicável quando o tipo principal é User.

Nome	Tipo	Description
userPrincipalName	string	Nome principal do usuário.

Compartilhar via

External Data Shares Provider - Create External Data Share

Permissions

Escopos delegados necessários

Configurações de locatário necessárias

Limitations

Identidades com suporte do Microsoft Entra

Interface

Parâmetros de URI

Corpo da solicitação

Respostas

Exemplos

Create an external data share example

Solicitação de exemplo

Resposta de exemplo

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

Solicitação de exemplo

Resposta de exemplo

Create an external data share with multiple paths example

Solicitação de exemplo

Resposta de exemplo

Definições

CreateExternalDataShareRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ExternalDataShare

ExternalDataShareRecipient

ExternalDataShareStatus

GroupDetails

GroupType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails