Admin - InformationProtection SetLabelsAsAdmin

Référence

Service:: Power BI REST APIs

API Version:: v1.0

Définissez les étiquettes de confidentialité sur les éléments Power BI (tels que les rapports ou les tableaux de bord) par ID d’élément.

Pour définir une étiquette de confidentialité à l’aide de cette API, l’utilisateur administrateur ou l’utilisateur délégué (le cas échéant) doit avoir l’étiquette incluse dans sa stratégie d’étiquette. Pour obtenir un exemple d’utilisation, consultez Définir ou supprimer des étiquettes de confidentialité.

Autorisations

L’utilisateur doit disposer de droits d’administrateur (par exemple, Office 365 administrateur général ou administrateur de service Power BI).
L’utilisateur administrateur et l’utilisateur délégué (le cas échéant) doivent disposer de droits d’utilisation suffisants pour définir des étiquettes.

Étendue requise

Tenant.ReadWrite.All

Limites

25 demandes maximales par heure.
Chaque demande peut mettre à jour jusqu’à 2 000 éléments Power BI.

POST https://api.powerbi.com/v1.0/myorg/admin/informationprotection/setLabels

Corps de la demande

Nom	Obligatoire	Type	Description
artifacts	True	InformationProtectionArtifactsChangeLabel	Composite des ID d’élément Power BI pour chaque type d’élément
labelId	True	string	ID d’étiquette, qui doit se trouver dans la stratégie d’étiquette de l’utilisateur.
assignmentMethod		assignmentMethod	Spécifie si l’étiquette affectée a été définie par un processus automatisé ou manuellement.
delegatedUser		DelegatedUser	Détails de l’utilisateur délégué. Un utilisateur délégué est un utilisateur au sein d’une organisation dont l’administrateur définit une étiquette au nom de l’utilisateur. Bien que l’administrateur définit l’étiquette, l’utilisateur délégué est marqué comme émetteur d’étiquette.

Réponses

Nom	Type	Description
200 OK	InformationProtectionChangeLabelResponse	Ok

Exemples

Example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/admin/informationprotection/setLabels

Request Body

{
  "artifacts": {
    "dashboards": [
      {
        "id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542a"
      },
      {
        "id": "476fcafe-b514-495d-b13f-ca9a4f0b1d8b"
      }
    ],
    "reports": [
      {
        "id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542c"
      }
    ],
    "datasets": [
      {
        "id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542e"
      },
      {
        "id": "myDatabaseName"
      }
    ],
    "dataflows": [
      {
        "id": "476fcafe-b514-495d-b13f-ca9a4f0b1d8g"
      }
    ]
  },
  "labelId": "fe472f5e-636e-4c10-a1c6-7e9edc0b542p",
  "assignmentMethod": "Standard",
  "delegatedUser": {
    "emailAddress": "john@contoso.com"
  }
}

Sample Response

Status code:: 200

{
  "dashboards": [
    {
      "id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542a",
      "status": "NotFound"
    },
    {
      "id": "476fcafe-b514-495d-b13f-ca9a4f0b1d8b",
      "status": "Failed"
    }
  ],
  "reports": [
    {
      "id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542c",
      "status": "Succeeded"
    }
  ],
  "datasets": [
    {
      "id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542e",
      "status": "InsufficientUsageRights"
    },
    {
      "id": "myDatabaseName",
      "status": "FailedToGetUsageRights"
    }
  ],
  "dataflows": [
    {
      "id": "476fcafe-b514-495d-b13f-ca9a4f0b1d8g",
      "status": "Succeeded"
    }
  ]
}

Définitions

Nom	Description
ArtifactId	ID unique d’un élément Power BI au format UUID. Les ID de tableau de bord, de rapport et de flux de données sont au format UUID et les ID de jeu de données peuvent être au format UUID ou chaîne.
ArtifactStringId	ID unique d’un élément Power BI au format chaîne ou UUID. Les ID de tableau de bord, de rapport et de flux de données sont au format UUID et les ID de jeu de données peuvent être au format UUID ou chaîne.
assignmentMethod	Spécifie si l’étiquette affectée a été définie par un processus automatisé ou manuellement.
ChangeLabelStatus	L’ID unique et l’étiquette de protection des informations changent l’état d’un élément Power BI
DelegatedUser	Détails de l’utilisateur délégué. L’utilisateur doit être un utilisateur existant dans Power BI et Azure AAD, et doit être connecté à Power BI au cours des trois derniers mois.
InformationProtectionArtifactsChangeLabel	Composite des ID d’élément Power BI pour chaque type d’élément. Les ID spécifient les éléments Power BI qui nécessitent une mise à jour d’étiquette de protection des informations.
InformationProtectionChangeLabelDetails	Composite des informations d’étiquette requises pour mettre à jour une étiquette de protection des informations
InformationProtectionChangeLabelResponse	Composite de l’id et de l’état des étiquettes de protection des informations pour un ou plusieurs éléments Power BI organisés par type
status	État d’une opération de modification d’étiquette information protection

ArtifactId

ID unique d’un élément Power BI au format UUID. Les ID de tableau de bord, de rapport et de flux de données sont au format UUID et les ID de jeu de données peuvent être au format UUID ou chaîne.

Nom	Type	Description
id	string	ID au format UUID

ArtifactStringId

ID unique d’un élément Power BI au format chaîne ou UUID. Les ID de tableau de bord, de rapport et de flux de données sont au format UUID et les ID de jeu de données peuvent être au format UUID ou chaîne.

Nom	Type	Description
id	string	ID au format chaîne ou UUID

assignmentMethod

Spécifie si l’étiquette affectée a été définie par un processus automatisé ou manuellement.

Nom	Type	Description
Priviledged	string	L’étiquette a été définie manuellement
Standard	string	L’étiquette a été définie par un processus automatisé (valeur par défaut)

ChangeLabelStatus

L’ID unique et l’étiquette de protection des informations changent l’état d’un élément Power BI

Nom	Type	Description
id	string	ID unique d’un élément Power BI. L’ID est au format UUID pour les tableaux de bord, les rapports et les flux de données ; et au format UUID ou chaîne pour les jeux de données.
status	status	État d’une opération de modification d’étiquette information protection

DelegatedUser

Détails de l’utilisateur délégué. L’utilisateur doit être un utilisateur existant dans Power BI et Azure AAD, et doit être connecté à Power BI au cours des trois derniers mois.

Nom	Type	Description
emailAddress	string	Adresse e-mail de l’utilisateur délégué

InformationProtectionArtifactsChangeLabel

Composite des ID d’élément Power BI pour chaque type d’élément. Les ID spécifient les éléments Power BI qui nécessitent une mise à jour d’étiquette de protection des informations.

Nom	Type	Description
dashboards	ArtifactId[]	Liste des ID de tableau de bord uniques
dataflows	ArtifactId[]	Liste des ID de flux de données uniques
datasets	ArtifactStringId[]	Liste des ID de jeu de données uniques
reports	ArtifactId[]	Liste des ID de rapport uniques

InformationProtectionChangeLabelDetails

Composite des informations d’étiquette requises pour mettre à jour une étiquette de protection des informations

Nom	Type	Description
artifacts	InformationProtectionArtifactsChangeLabel	Composite des ID d’élément Power BI pour chaque type d’élément
assignmentMethod	assignmentMethod	Spécifie si l’étiquette affectée a été définie par un processus automatisé ou manuellement.
delegatedUser	DelegatedUser	Détails de l’utilisateur délégué. Un utilisateur délégué est un utilisateur au sein d’une organisation dont l’administrateur définit une étiquette au nom de l’utilisateur. Bien que l’administrateur définit l’étiquette, l’utilisateur délégué est marqué comme émetteur d’étiquette.
labelId	string	ID d’étiquette, qui doit se trouver dans la stratégie d’étiquette de l’utilisateur.

InformationProtectionChangeLabelResponse

Composite de l’id et de l’état des étiquettes de protection des informations pour un ou plusieurs éléments Power BI organisés par type

Nom	Type	Description
dashboards	ChangeLabelStatus[]	Liste contenant l’id unique et l’état des étiquettes de protection des informations d’un ou de plusieurs tableaux de bord
dataflows	ChangeLabelStatus[]	Liste contenant l’id unique et l’état des étiquettes de protection des informations d’un ou de plusieurs dataflows
datasets	ChangeLabelStatus[]	Liste contenant l’id unique et l’état de modification de l’étiquette de protection des informations d’un ou plusieurs jeux de données
reports	ChangeLabelStatus[]	Liste contenant l’id unique et l’état de modification de l’étiquette de protection des informations d’un ou de plusieurs rapports

status

État d’une opération de modification d’étiquette information protection

Nom	Type	Description
Failed	string	Échec de la définition d’une nouvelle étiquette. Veuillez réessayer.
FailedToGetUsageRights	string	Échec de la définition d’une nouvelle étiquette. L’élément Power BI a une étiquette de confidentialité avec les paramètres de protection, et Power BI n’a pas pu vérifier que l’utilisateur dispose de droits d’utilisation suffisants pour modifier l’étiquette.
InsufficientUsageRights	string	Échec de la définition d’une nouvelle étiquette. L’élément Power BI a une étiquette de confidentialité avec les paramètres de protection, et l’utilisateur administrateur (et l’utilisateur délégué, le cas échéant) n’a pas suffisamment de droits d’utilisation pour modifier l’étiquette.
NotFound	string	L’ID ou l’étiquette de l’élément Power BI n’a pas été trouvé
Succeeded	string	L’étiquette d’élément Power BI a été modifiée