External Data Shares Provider - List External Data Shares

Referência

Serviço:: Admin

Versão da API:: v1

Lista os compartilhamentos de dados externos no locatário.

Essa API dá suporte a de paginação.

Permissões

O chamador deve ser um administrador do Fabric ou autenticar usando uma entidade de serviço.

Escopos delegados necessários

Tenant.ReadWrite.All

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.

Limitações

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

Identidades com suporte do Microsoft Entra

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

Identidade	Apoio
Utilizador	Sim
Entidade de serviço e identidades gerenciadas	Sim

Interfase

GET https://api.fabric.microsoft.com/v1/admin/items/externalDataShares

Com parâmetros opcionais:

GET https://api.fabric.microsoft.com/v1/admin/items/externalDataShares?continuationToken={continuationToken}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
continuationToken	query		string	Um token para recuperar a próxima página de resultados.

Respostas

Nome	Tipo	Description
200 OK	ExternalDataShares	Solicitação concluída com êxito.
Other Status Codes	ErrorResponse	Códigos de erro comuns: UnknownError – Ocorreu um erro.

Nome

Tipo

Description

200 OK

ExternalDataShares

Solicitação concluída com êxito.

Other Status Codes

ErrorResponse

Códigos de erro comuns:

UnknownError – Ocorreu um erro.

Exemplos

List external data shares in the tenant example

Solicitação de exemplo

HTTP

GET https://api.fabric.microsoft.com/v1/admin/items/externalDataShares

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "id": "dccc162f-7a41-4720-83c3-5c7e81187959",
      "paths": [
        "Files/Sales/Contoso_Sales_2023"
      ],
      "creatorPrincipal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Jacob Hancock",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "jacob@contoso.com"
        }
      },
      "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"
    },
    {
      "id": "96c21561-65b8-4b23-bb9a-ee8cef945c45",
      "paths": [
        "Files/Sales/Contoso_Sales_2023"
      ],
      "creatorPrincipal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Jacob Hancock",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "jacob@contoso.com"
        }
      },
      "recipient": {
        "userPrincipalName": "lisa@fabrikam.com"
      },
      "status": "Active",
      "expirationTimeUtc": "2024-08-31T00: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=96c21561-65b8-4b23-bb9a-ee8cef945c45",
      "acceptedByTenantId": "c51dc03f-268a-4da0-a879-25f24947ab8b"
    },
    {
      "id": "0f40aeca-8f78-4a6f-a552-e5c45faadc60",
      "paths": [
        "Files/Sales/Contoso_Sales_2023"
      ],
      "creatorPrincipal": {
        "id": "81fac5e1-2a81-421b-a168-110b1c72fa11",
        "displayName": "Eric Solomon",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "eric@contoso.com"
        }
      },
      "recipient": {
        "userPrincipalName": "lisa@fabrikam.com"
      },
      "status": "InvitationExpired",
      "expirationTimeUtc": "2024-01-01T00: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=0f40aeca-8f78-4a6f-a552-e5c45faadc60"
    },
    {
      "id": "89e82a82-0140-4837-8eee-9c919e3e5952",
      "paths": [
        "Files/Sales/Contoso_Sales_2023"
      ],
      "creatorPrincipal": {
        "id": "81fac5e1-2a81-421b-a168-110b1c72fa11",
        "displayName": "Eric Solomon",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "eric@contoso.com"
        }
      },
      "recipient": {
        "userPrincipalName": "lisa@fabrikam.com"
      },
      "status": "Revoked",
      "expirationTimeUtc": "2024-12-01T00: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=89e82a82-0140-4837-8eee-9c919e3e5952",
      "acceptedByTenantId": "c51dc03f-268a-4da0-a879-25f24947ab8b"
    }
  ]
}

Definições

Nome	Description
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.
ExternalDataShares	Uma lista de compartilhamentos de dados externos com um token de continuação.
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`.

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.

ExternalDataShares

Objeto

Uma lista de compartilhamentos de dados externos com um token de continuação.

Nome	Tipo	Description
continuationToken	string	O token do próximo lote do conjunto de resultados. Se não houver mais registros, ele será removido da resposta.
continuationUri	string	O URI do próximo lote do conjunto de resultados. Se não houver mais registros, ele será removido da resposta.
value	ExternalDataShare[]	Uma lista de compartilhamentos de dados externos.

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
Active	O convite foi aceito pelo destinatário e o compartilhamento de dados externo está ativo.
InvitationExpired	O convite expirou e não pode mais ser aceito pelo destinatário.
Pending	Um convite foi criado e agora está pendente de aceitação pelo destinatário.
Revoked	O compartilhamento de dados externo foi revogado.

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
DistributionList	Principal é uma lista de distribuição.
SecurityGroup	A entidade de segurança é um grupo de segurança.
Unknown	O tipo de grupo principal é desconhecido.

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
Group	A entidade de segurança é um grupo de segurança.
ServicePrincipal	A entidade de segurança é uma entidade de serviço do Microsoft Entra.
ServicePrincipalProfile	Principal é um perfil de entidade de serviço.
User	Principal é uma entidade de usuário do Microsoft Entra.

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 - List External Data Shares

Permissões

Escopos delegados necessários

Configurações de locatário necessárias

Limitações

Identidades com suporte do Microsoft Entra

Interfase

Parâmetros de URI

Respostas

Exemplos

List external data shares in the tenant example

Solicitação de exemplo

Resposta de exemplo

Definições

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ExternalDataShare

ExternalDataShareRecipient

ExternalDataShares

ExternalDataShareStatus

GroupDetails

GroupType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails