Sharing Links - Bulk Remove Sharing Links

Référence

Service:: Admin

Version d'API:: v1

Remarque

Cette API est en préversion.

Supprime tous les liens de partage d’organisation pour les éléments Fabric spécifiés. Cette opération est irréversible.
Cette API prend en charge opérations longues (LRO).

Utilisez l’API REST d’administration PowerBI LinksSharedToWholeOrganization pour obtenir des rapports Power BI partagés via des liens de partage organisationnel.

Autorisations

L’appelant doit être un administrateur Fabric.

Étendues déléguées requises

Tenant.ReadWrite.All

Limites

Maximum 10 requêtes par minute.
Chaque demande peut supprimer des liens de partage d’organisation pour jusqu’à 500 éléments Fabric.
Seuls les rapports Power BI sont pris en charge.

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité	Soutien
Utilisateur	Oui
Service principal et identités gérées	Oui

Interface

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

Corps de la demande

Nom	Obligatoire	Type	Description
items	True	ItemInfo[]	Liste d’éléments. La liste inclut l’ID et le type d’élément.
sharingLinkType	True	SharingLinkType	Spécifie le type de lien de partage qui doit être supprimé pour chaque élément Fabric. Des types de liens de partage supplémentaires peuvent être ajoutés au fil du temps.

Réponses

Nom	Type	Description
200 OK	BulkRemoveSharingLinksResponse	La demande s’est terminée avec succès.
202 Accepted		Demande acceptée. La récupération de la définition est en cours. En-têtes Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Codes d’erreur courants : Interdit : l’appelant n’a pas les autorisations nécessaires pour appeler l’API.

Nom

Type

Description

200 OK

BulkRemoveSharingLinksResponse

La demande s’est terminée avec succès.

202 Accepted

Demande acceptée. La récupération de la définition est en cours.

En-têtes

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

Other Status Codes

ErrorResponse

Codes d’erreur courants :

Interdit : l’appelant n’a pas les autorisations nécessaires pour appeler l’API.

Exemples

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
}

Code d’état:: 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

Définitions

Nom	Description
BulkRemoveSharingLinksRequest	Liste des éléments pour lesquels tous les liens de partage et l’accès associé doivent être supprimés. Accepte également le type de lien de partage à supprimer.
BulkRemoveSharingLinksResponse	Liste des ID uniques et de l’état de suppression des liens de partage des éléments Fabric dans la demande de suppression des liens de partage
ErrorRelatedResource	Objet de détails de ressource associé à l’erreur.
ErrorResponse	Réponse d’erreur.
ErrorResponseDetails	Détails de la réponse d’erreur.
ItemInfo	Informations sur l’élément, y compris l’ID et le type d’élément.
ItemRemoveSharingLinksStatus	L’ID unique et l’état de suppression des liens de partage d’un élément Fabric
ItemType	Type de l’élément. Des types d’éléments supplémentaires peuvent être ajoutés au fil du temps.
SharingLinksRemovalStatus	État de la suppression des liens de partage. Des types `SharingLinksRemovalStatus` supplémentaires peuvent être ajoutés au fil du temps.
SharingLinkType	Spécifie le type de lien de partage qui doit être supprimé pour chaque élément Fabric. Des types de liens de partage supplémentaires peuvent être ajoutés au fil du temps.

BulkRemoveSharingLinksRequest

Object

Liste des éléments pour lesquels tous les liens de partage et l’accès associé doivent être supprimés. Accepte également le type de lien de partage à supprimer.

Nom	Type	Description
items	ItemInfo[]	Liste d’éléments. La liste inclut l’ID et le type d’élément.
sharingLinkType	SharingLinkType	Spécifie le type de lien de partage qui doit être supprimé pour chaque élément Fabric. Des types de liens de partage supplémentaires peuvent être ajoutés au fil du temps.

BulkRemoveSharingLinksResponse

Object

Liste des ID uniques et de l’état de suppression des liens de partage des éléments Fabric dans la demande de suppression des liens de partage

Nom	Type	Description
itemsRemoveSharingLinksStatus	ItemRemoveSharingLinksStatus[]	Une liste d’éléments supprime l’état du lien de partage.
sharingLinkType	SharingLinkType	Spécifie le type de lien de partage demandé pour la suppression de chaque élément Fabric. Des types de liens de partage supplémentaires peuvent être ajoutés au fil du temps.

ErrorRelatedResource

Object

Objet de détails de ressource associé à l’erreur.

Nom	Type	Description
resourceId	string	ID de ressource impliqué dans l’erreur.
resourceType	string	Type de la ressource impliquée dans l’erreur.

ErrorResponse

Object

Réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
moreDetails	ErrorResponseDetails[]	Liste des détails d’erreur supplémentaires.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.
requestId	string	ID de la demande associée à l’erreur.

ErrorResponseDetails

Object

Détails de la réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.

ItemInfo

Object

Informations sur l’élément, y compris l’ID et le type d’élément.

Nom	Type	Description
id	string (uuid)	ID au format UUID.
type	ItemType	Type d’élément.

ItemRemoveSharingLinksStatus

Object

L’ID unique et l’état de suppression des liens de partage d’un élément Fabric

Nom	Type	Description
id	string (uuid)	ID au format UUID.
status	SharingLinksRemovalStatus	État de l’opération de suppression des liens de partage. Des types de propriétés supplémentaires peuvent être ajoutés au fil du temps.
type	ItemType	Type d’élément.

ItemType

Énumération

Type de l’élément. Des types d’éléments supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
ApacheAirflowJob	An ApacheAirflowJob.
CopyJob	Tâche de copie.
Dashboard	Tableau de bord PowerBI.
DataPipeline	Un pipeline de données.
Dataflow	Flux de données.
Datamart	Datamart PowerBI.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Flux de générateur de jumeaux numériques.
Environment	Environnement.
Eventhouse	Un eventhouse.
Eventstream	Flux d’événements.
GraphQLApi	API pour l’élément GraphQL.
KQLDashboard	Tableau de bord KQL.
KQLDatabase	Base de données KQL.
KQLQueryset	Ensemble de requêtes KQL.
Lakehouse	Un lac.
MLExperiment	Une expérience de Machine Learning.
MLModel	Modèle Machine Learning.
MirroredAzureDatabricksCatalog	Catalogue Azure databricks mis en miroir.
MirroredDatabase	Une base de données mise en miroir.
MirroredWarehouse	Un entrepôt mis en miroir.
MountedDataFactory	Un MountedDataFactory.
Notebook	Un notebook.
PaginatedReport	Rapport paginé PowerBI.
Reflex	Un réflexe.
Report	Rapport PowerBI.
SQLDatabase	A SQLDatabase.
SQLEndpoint	Point de terminaison SQL.
SemanticModel	Modèle sémantique PowerBI.
SparkJobDefinition	Définition d’un travail Spark.
VariableLibrary	A VariableLibrary.
Warehouse	Un entrepôt.
WarehouseSnapshot	Capture instantanée de l’entrepôt.

SharingLinksRemovalStatus

Énumération

État de la suppression des liens de partage. Des types SharingLinksRemovalStatus supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
NotFound	L’ID, l’étiquette ou le type de l’élément Fabric n’a pas été trouvé.
Succeeded	Tous les liens de partage ont été supprimés.

SharingLinkType

Énumération

Spécifie le type de lien de partage qui doit être supprimé pour chaque élément Fabric. Des types de liens de partage supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
OrgLink	Le lien de partage accorde l’accès à l’ensemble de l’organisation (valeur par défaut).

Partager via

Sharing Links - Bulk Remove Sharing Links

Autorisations

Étendues déléguées requises

Limites

Identités prises en charge par Microsoft Entra

Interface

Corps de la demande

Réponses

Exemples

Remove sharing links for specific items example

Exemple de requête

Exemple de réponse

Définitions

BulkRemoveSharingLinksRequest

BulkRemoveSharingLinksResponse

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemInfo

ItemRemoveSharingLinksStatus

ItemType

SharingLinksRemovalStatus

SharingLinkType