Sharing Links - Bulk Remove Sharing Links

Referência

Serviço:: Admin

Versão da API:: v1

Observação

Essa API está em versão prévia.

Exclui todos os links de compartilhamento da organização para os itens do Fabric especificados. Essa ação não pode ser desfeita.
Essa API dá suporte a LRO (operações de execução longa).

Use a API REST do Administrador do PowerBI do LinksSharedToWholeOrganization para obter relatórios do Power BI compartilhados por meio de links de compartilhamento organizacional.

Permissões

O chamador deve ser um administrador do Fabric.

Escopos delegados necessários

Tenant.ReadWrite.All

Limitações

Máximo de 10 solicitações por minuto.
Cada solicitação pode excluir links de compartilhamento da organização para até 500 itens do Fabric.
Há suporte apenas para relatórios do Power BI.

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

POST https://api.fabric.microsoft.com/v1/admin/items/bulkRemoveSharingLinks

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
items	True	ItemInfo[]	Uma lista de itens. A lista inclui a ID do item e o tipo.
sharingLinkType	True	SharingLinkType	Especifica o tipo de link de compartilhamento que deve ser excluído para cada item do Fabric. Tipos de link de compartilhamento adicionais podem ser adicionados ao longo do tempo.

Respostas

Nome	Tipo	Description
200 OK	BulkRemoveSharingLinksResponse	Solicitação concluída com êxito.
202 Accepted		Solicitação aceita. A recuperação da definição está em andamento. Cabeçalhos Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de erro comuns: Proibido – o chamador não tem permissões para chamar a API.

Nome

Tipo

Description

200 OK

BulkRemoveSharingLinksResponse

Solicitação concluída com êxito.

202 Accepted

Solicitação aceita. A recuperação da definição está em andamento.

Cabeçalhos

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Códigos de erro comuns:

Proibido – o chamador não tem permissões para chamar a API.

Exemplos

Solicitação de exemplo

HTTP

POST https://api.fabric.microsoft.com/v1/admin/items/bulkRemoveSharingLinks

{
  "items": [
    {
      "id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542a",
      "type": "Report"
    },
    {
      "id": "476fcafe-b514-495d-b13f-ca9a4f0b1d8b",
      "type": "Report"
    },
    {
      "id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542c",
      "type": "Report"
    },
    {
      "id": "476fcafe-b514-495d-b13f-ca9a4f0b1d8f",
      "type": "Notebook"
    }
  ],
  "sharingLinkType": "OrgLink"
}

Resposta de exemplo

Código de status:: 200

{
  "itemsRemoveSharingLinksStatus": [
    {
      "id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542a",
      "type": "Report",
      "status": "NotFound"
    },
    {
      "id": "476fcafe-b514-495d-b13f-ca9a4f0b1d8b",
      "type": "Report",
      "status": "Failed"
    },
    {
      "id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542c",
      "type": "Report",
      "status": "Succeeded"
    },
    {
      "id": "476fcafe-b514-495d-b13f-ca9a4f0b1d8f",
      "type": "Notebook",
      "status": "Succeeded"
    }
  ],
  "sharingLinkType": "OrgLink"
}

Código de status:: 202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Definições

Nome	Description
BulkRemoveSharingLinksRequest	Uma lista de itens para os quais todos os links de compartilhamento e acesso relacionado devem ser removidos. Também aceita o tipo de link de compartilhamento a ser removido.
BulkRemoveSharingLinksResponse	Uma lista das IDs exclusivas e o status de remoção de links de compartilhamento dos itens do Fabric na solicitação remover links de compartilhamento
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
ItemInfo	As informações do item, incluindo a ID e o tipo do item.
ItemRemoveSharingLinksStatus	A ID exclusiva e o status de remoção de links de compartilhamento de um item do Fabric
ItemType	O tipo do item. Tipos de item adicionais podem ser adicionados ao longo do tempo.
SharingLinksRemovalStatus	O status da remoção de links de compartilhamento. Tipos de `SharingLinksRemovalStatus` adicionais podem ser adicionados ao longo do tempo.
SharingLinkType	Especifica o tipo de link de compartilhamento que deve ser excluído para cada item do Fabric. Tipos de link de compartilhamento adicionais podem ser adicionados ao longo do tempo.

BulkRemoveSharingLinksRequest

Objeto

Uma lista de itens para os quais todos os links de compartilhamento e acesso relacionado devem ser removidos. Também aceita o tipo de link de compartilhamento a ser removido.

Nome	Tipo	Description
items	ItemInfo[]	Uma lista de itens. A lista inclui a ID do item e o tipo.
sharingLinkType	SharingLinkType	Especifica o tipo de link de compartilhamento que deve ser excluído para cada item do Fabric. Tipos de link de compartilhamento adicionais podem ser adicionados ao longo do tempo.

BulkRemoveSharingLinksResponse

Objeto

Uma lista das IDs exclusivas e o status de remoção de links de compartilhamento dos itens do Fabric na solicitação remover links de compartilhamento

Nome	Tipo	Description
itemsRemoveSharingLinksStatus	ItemRemoveSharingLinksStatus[]	Uma lista de itens remove o status do link de compartilhamento.
sharingLinkType	SharingLinkType	Especifica o tipo de link de compartilhamento solicitado para exclusão para cada item do Fabric. Tipos de link de compartilhamento adicionais podem ser adicionados ao longo do tempo.

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.

ItemInfo

Objeto

As informações do item, incluindo a ID e o tipo do item.

Nome	Tipo	Description
id	string (uuid)	Uma ID no formato UUID.
type	ItemType	O tipo de item.

ItemRemoveSharingLinksStatus

Objeto

A ID exclusiva e o status de remoção de links de compartilhamento de um item do Fabric

Nome	Tipo	Description
id	string (uuid)	Uma ID no formato UUID.
status	SharingLinksRemovalStatus	O status da operação de remoção de links de compartilhamento. Tipos de propriedade adicionais podem ser adicionados ao longo do tempo.
type	ItemType	O tipo de item.

ItemType

Enumeração

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

Valor	Description
ApacheAirflowJob	Um ApacheAirflowJob.
CopyJob	Um trabalho de cópia.
Dashboard	Painel do PowerBI.
DataPipeline	Um pipeline de dados.
Dataflow	Um fluxo de dados.
Datamart	Datamart do PowerBI.
DigitalTwinBuilder	Um DigitalTwinBuilder.
DigitalTwinBuilderFlow	Um fluxo do Construtor de Gêmeos Digitais.
Environment	Um ambiente.
Eventhouse	Uma casa de eventos.
Eventstream	Um fluxo de eventos.
GraphQLApi	Um item de API para GraphQL.
KQLDashboard	Um painel KQL.
KQLDatabase	Um banco de dados KQL.
KQLQueryset	Um conjunto de consultas KQL.
Lakehouse	Uma casa no lago.
MLExperiment	Um experimento de aprendizado de máquina.
MLModel	Um modelo de machine learning.
MirroredAzureDatabricksCatalog	Um catálogo espelhado do Azure Databricks.
MirroredDatabase	Um banco de dados espelhado.
MirroredWarehouse	Um armazém espelhado.
MountedDataFactory	Um MountedDataFactory.
Notebook	Um notebook.
PaginatedReport	Relatório paginado do PowerBI.
Reflex	Um Reflexo.
Report	Relatório do PowerBI.
SQLDatabase	Um SQLDatabase.
SQLEndpoint	Um ponto de extremidade SQL.
SemanticModel	Modelo semântico do PowerBI.
SparkJobDefinition	Uma definição de trabalho do Spark.
VariableLibrary	Um VariableLibrary.
Warehouse	Um armazém.
WarehouseSnapshot	Um instantâneo do Warehouse.

SharingLinksRemovalStatus

Enumeração

O status da remoção de links de compartilhamento. Tipos de SharingLinksRemovalStatus adicionais podem ser adicionados ao longo do tempo.

Valor	Description
NotFound	A ID do item do Fabric, o rótulo ou o tipo não foram encontrados.
Succeeded	Todos os links de compartilhamento foram removidos.

SharingLinkType

Enumeração

Especifica o tipo de link de compartilhamento que deve ser excluído para cada item do Fabric. Tipos de link de compartilhamento adicionais podem ser adicionados ao longo do tempo.

Valor	Description
OrgLink	O link de compartilhamento concede acesso a toda a organização (valor padrão).

Compartilhar via

Sharing Links - Bulk Remove Sharing Links

Permissões

Escopos delegados necessários

Limitações

Identidades com suporte do Microsoft Entra

Interfase

Corpo da solicitação

Respostas

Exemplos

Remove sharing links for specific items example

Solicitação de exemplo

Resposta de exemplo

Definições

BulkRemoveSharingLinksRequest

BulkRemoveSharingLinksResponse

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemInfo

ItemRemoveSharingLinksStatus

ItemType

SharingLinksRemovalStatus

SharingLinkType