External Data Shares Provider - Create External Data Share

Serviço:: Core

Versão da API:: v1

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

Permissions

O chamador deve ter permissões de leitura e recompartilhamento no item.

Escopos delegados necessários

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

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

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

Configurações de locatário necessárias

Para usar essa API, habilite a opção Administrador de compartilhamento de dados externo para a entidade de chamada.

Limitations

Máximo de 10 pedidos por minuto.

Tipos de item suportados: Consulte Compartilhamento de dados externos no Microsoft Fabric - Tipos de item suportados.

Identidades suportadas pelo Entra da Microsoft

Esta API suporta as identidades do Microsoft listadas nesta secção.

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

Interface

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
itemId	path	True	string (uuid)	O ID do item.
workspaceId	path	True	string (uuid)	O ID do espaço de trabalho.

Corpo do Pedido

Name	Necessário	Tipo	Description
paths	True	string[]	O caminho ou 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, estes caminhos são válidos: "Files/MyFolder1" "Tabelas/MySchema" "Tables/MyTable1"
recipient	True	ExternalDataShareRecipient	O destinatário convidado a aceitar o compartilhamento de dados externos.

Name

Necessário

Tipo

Description

paths

True

string[]

O caminho ou 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, estes caminhos são válidos:

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

recipient

True

ExternalDataShareRecipient

O destinatário convidado a aceitar o compartilhamento de dados externos.

Respostas

Name	Tipo	Description
201 Created	ExternalDataShare	Criado com sucesso. Cabeçalhos Location: string
Other Status Codes	ErrorResponse	Códigos de erro comuns: UnknownError - Ocorreu um erro.

Name

Tipo

Description

201 Created

ExternalDataShare

Criado com sucesso.

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

Pedido de amostra

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 da amostra

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

Pedido de amostra

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 da amostra

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

Pedido de amostra

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 da amostra

Código de estado:: 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

Name	Description
CreateExternalDataShareRequest	A carga útil 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 externo do compartilhamento de dados.
ExternalDataShareStatus	O status de um determinado compartilhamento de dados externos. 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 do principal. Ao longo do tempo, podem ser acrescentados tipos principais adicionais.
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 principais do usuário. Aplicável quando o tipo principal é `User`.

CreateExternalDataShareRequest

Object

A carga útil da solicitação para criar um compartilhamento de dados externo.

Name	Tipo	Description
paths	string[]	O caminho ou 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, estes caminhos são válidos: "Files/MyFolder1" "Tabelas/MySchema" "Tables/MyTable1"
recipient	ExternalDataShareRecipient	O destinatário convidado a aceitar o compartilhamento de dados externos.

Name

Tipo

Description

paths

string[]

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

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

recipient

ExternalDataShareRecipient

O destinatário convidado a aceitar o compartilhamento de dados externos.

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

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

ErrorResponse

Object

A resposta de erro.

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

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

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

ExternalDataShare

Object

Um objeto de compartilhamento de dados externo.

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

ExternalDataShareRecipient

Object

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

Name	Tipo	Description
tenantId	string (uuid)	O ID do locatário do destinatário.
userPrincipalName	string maxLength: 256	O endereço de e-mail do destinatário.

ExternalDataShareStatus

Enumeração

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

Valor	Description
Pending	Foi criado um convite que está agora pendente de aceitação por parte do destinatário.
Active	O convite foi aceito pelo destinatário e o compartilhamento de dados externos está ativo.
Revoked	O compartilhamento de dados externos foi revogado.
InvitationExpired	O convite expirou e não pode mais ser aceito pelo destinatário.

GroupDetails

Object

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

Name	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	Principal é um grupo de segurança.
DistributionList	Principal é uma lista de distribuição.

Principal

Object

Representa uma identidade ou um grupo do Microsoft Entra.

Name	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)	O 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 do principal. Ao longo do tempo, podem ser acrescentados tipos principais adicionais.
userDetails	UserDetails	Detalhes específicos principais do usuário. Aplicável quando o tipo principal é `User`.

PrincipalType

Enumeração

O tipo do principal. Ao longo do tempo, podem ser acrescentados tipos principais adicionais.

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

ServicePrincipalDetails

Object

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

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

ServicePrincipalProfileDetails

Object

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

Name	Tipo	Description
parentPrincipal	Principal	A entidade principal do perfil da entidade de serviço.

UserDetails

Object

Detalhes específicos principais do usuário. Aplicável quando o tipo principal é User.

Name	Tipo	Description
userPrincipalName	string	O nome principal do usuário.

Partilhar via

External Data Shares Provider - Create External Data Share

Permissions

Escopos delegados necessários

Configurações de locatário necessárias

Limitations

Identidades suportadas pelo Entra da Microsoft

Interface

Parâmetros do URI

Corpo do Pedido

Respostas

Exemplos

Create an external data share example

Pedido de amostra

Resposta da amostra

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

Pedido de amostra

Resposta da amostra

Create an external data share with multiple paths example

Pedido de amostra

Resposta da amostra

Definições

CreateExternalDataShareRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ExternalDataShare

ExternalDataShareRecipient

ExternalDataShareStatus

GroupDetails

GroupType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails