Sharing Links - Bulk Remove Sharing Links

Referencia

Servicio:: Admin

Versión de la API:: v1

Nota:

Esta API está en versión preliminar.

Elimina todos los vínculos de uso compartido de la organización para los elementos de Fabric especificados. Esta acción no se puede deshacer.
Esta API admite operaciones de larga duración (LRO).

Use linksSharedToWholeOrganization PowerBI Admin REST API para obtener informes de Power BI compartidos a través de vínculos de uso compartido de la organización.

Permisos

El autor de la llamada debe ser administrador de Fabric.

Ámbitos delegados necesarios

Tenant.ReadWrite.All

Limitaciones

Máximo de 10 solicitudes por minuto.
Cada solicitud puede eliminar vínculos de uso compartido de la organización para hasta 500 elementos de Fabric.
Solo se admiten informes de Power BI.

Identidades admitidas de Microsoft Entra

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

identidad	Apoyo
Usuario	Sí
Entidad de servicio e Identidades administradas	Sí

Interfaz

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

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
items	True	ItemInfo[]	Lista de elementos. La lista incluye el identificador y el tipo de elemento.
sharingLinkType	True	SharingLinkType	Especifica el tipo de vínculo de uso compartido que se debe eliminar para cada elemento de Fabric. Se pueden agregar tipos de vínculo de uso compartido adicionales a lo largo del tiempo.

Respuestas

Nombre	Tipo	Description
200 OK	BulkRemoveSharingLinksResponse	Solicitud completada correctamente.
202 Accepted		Solicitud aceptada. La recuperación de la definición está en curso. Encabezados Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de error comunes: Prohibido: el autor de la llamada no tiene permisos para llamar a la API.

Nombre

Tipo

Description

200 OK

BulkRemoveSharingLinksResponse

Solicitud completada correctamente.

202 Accepted

Solicitud aceptada. La recuperación de la definición está en curso.

Encabezados

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

Other Status Codes

ErrorResponse

Códigos de error comunes:

Prohibido: el autor de la llamada no tiene permisos para llamar a la API.

Ejemplos

Solicitud de ejemplo

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

Respuesta de muestra

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

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

Definiciones

Nombre	Description
BulkRemoveSharingLinksRequest	Lista de elementos para los que se deben quitar todos los vínculos de uso compartido y el acceso relacionado. También acepta el tipo de vínculo de uso compartido que se va a quitar.
BulkRemoveSharingLinksResponse	Una lista de los identificadores únicos y el estado de eliminación de vínculos de uso compartido de los elementos de Fabric en la solicitud quitar vínculos de uso compartido
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
ItemInfo	La información del elemento, incluido el identificador y el tipo de elemento.
ItemRemoveSharingLinksStatus	El identificador único y el estado de eliminación de vínculos de uso compartido de un elemento de Fabric
ItemType	Tipo del elemento. Se pueden agregar tipos de elementos adicionales a lo largo del tiempo.
SharingLinksRemovalStatus	Estado de eliminación de vínculos de uso compartido. Se pueden agregar tipos de `SharingLinksRemovalStatus` adicionales a lo largo del tiempo.
SharingLinkType	Especifica el tipo de vínculo de uso compartido que se debe eliminar para cada elemento de Fabric. Se pueden agregar tipos de vínculo de uso compartido adicionales a lo largo del tiempo.

BulkRemoveSharingLinksRequest

Object

Lista de elementos para los que se deben quitar todos los vínculos de uso compartido y el acceso relacionado. También acepta el tipo de vínculo de uso compartido que se va a quitar.

Nombre	Tipo	Description
items	ItemInfo[]	Lista de elementos. La lista incluye el identificador y el tipo de elemento.
sharingLinkType	SharingLinkType	Especifica el tipo de vínculo de uso compartido que se debe eliminar para cada elemento de Fabric. Se pueden agregar tipos de vínculo de uso compartido adicionales a lo largo del tiempo.

BulkRemoveSharingLinksResponse

Object

Una lista de los identificadores únicos y el estado de eliminación de vínculos de uso compartido de los elementos de Fabric en la solicitud quitar vínculos de uso compartido

Nombre	Tipo	Description
itemsRemoveSharingLinksStatus	ItemRemoveSharingLinksStatus[]	Una lista de elementos quita el estado del vínculo de uso compartido.
sharingLinkType	SharingLinkType	Especifica el tipo de vínculo de uso compartido que se solicita para su eliminación para cada elemento de Fabric. Se pueden agregar tipos de vínculo de uso compartido adicionales a lo largo del tiempo.

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.

ItemInfo

Object

La información del elemento, incluido el identificador y el tipo de elemento.

Nombre	Tipo	Description
id	string (uuid)	Identificador en formato UUID.
type	ItemType	Tipo de elemento.

ItemRemoveSharingLinksStatus

Object

El identificador único y el estado de eliminación de vínculos de uso compartido de un elemento de Fabric

Nombre	Tipo	Description
id	string (uuid)	Identificador en formato UUID.
status	SharingLinksRemovalStatus	Estado de la operación de eliminación de vínculos de uso compartido. Se pueden agregar tipos de propiedad adicionales a lo largo del tiempo.
type	ItemType	Tipo de elemento.

ItemType

Enumeración

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

Valor	Description
ApacheAirflowJob	An ApacheAirflowJob.
CopyJob	Un trabajo de copia.
Dashboard	Panel de PowerBI.
DataPipeline	Una canalización de datos.
Dataflow	Flujo de datos.
Datamart	Datamart de PowerBI.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Un flujo de Digital Twin Builder.
Environment	Un entorno.
Eventhouse	Un centro de eventos.
Eventstream	Una secuencia de eventos.
GraphQLApi	Una API para el elemento GraphQL.
KQLDashboard	Un panel de KQL.
KQLDatabase	Una base de datos KQL.
KQLQueryset	Un conjunto de consultas KQL.
Lakehouse	Una casa de lago.
MLExperiment	Un experimento de aprendizaje automático.
MLModel	Un modelo de aprendizaje automático.
MirroredAzureDatabricksCatalog	Un catálogo de Azure Databricks reflejado.
MirroredDatabase	Una base de datos reflejada.
MirroredWarehouse	Un almacén reflejado.
MountedDataFactory	A MountedDataFactory.
Notebook	Un cuaderno.
PaginatedReport	Informe paginado de PowerBI.
Reflex	Un reflejo.
Report	Informe de PowerBI.
SQLDatabase	A SQLDatabase.
SQLEndpoint	Un punto de conexión de SQL.
SemanticModel	Modelo semántico de PowerBI.
SparkJobDefinition	Una definición de trabajo de Spark.
VariableLibrary	A VariableLibrary.
Warehouse	Un almacén.
WarehouseSnapshot	Una instantánea de almacenamiento.

SharingLinksRemovalStatus

Enumeración

Estado de eliminación de vínculos de uso compartido. Se pueden agregar tipos de SharingLinksRemovalStatus adicionales a lo largo del tiempo.

Valor	Description
NotFound	No se encontró el identificador, la etiqueta o el tipo del elemento de Fabric.
Succeeded	Se quitaron todos los vínculos de uso compartido.

SharingLinkType

Enumeración

Especifica el tipo de vínculo de uso compartido que se debe eliminar para cada elemento de Fabric. Se pueden agregar tipos de vínculo de uso compartido adicionales a lo largo del tiempo.

Valor	Description
OrgLink	El vínculo para compartir concede acceso a toda la organización (valor predeterminado).

Compartir a través de

Sharing Links - Bulk Remove Sharing Links

Permisos

Ámbitos delegados necesarios

Limitaciones

Identidades admitidas de Microsoft Entra

Interfaz

Cuerpo de la solicitud

Respuestas

Ejemplos

Remove sharing links for specific items example

Solicitud de ejemplo

Respuesta de muestra

Definiciones

BulkRemoveSharingLinksRequest

BulkRemoveSharingLinksResponse

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemInfo

ItemRemoveSharingLinksStatus

ItemType

SharingLinksRemovalStatus

SharingLinkType