Admin - InformationProtection SetLabelsAsAdmin

Referenz

Service:: Power BI REST APIs

API Version:: v1.0

Legen Sie Vertraulichkeitsbezeichnungen für Power BI-Elemente (z. B. Berichte oder Dashboards) nach Element-ID fest.

Um eine Vertraulichkeitsbezeichnung mithilfe dieser API festzulegen, muss der Administratorbenutzer oder der delegierte Benutzer (sofern angegeben) über die Bezeichnungsrichtlinie verfügen. Ein Verwendungsbeispiel finden Sie unter Festlegen oder Entfernen von Vertraulichkeitsbezeichnungen.

Berechtigungen

Der Benutzer muss Administratorrechte haben (z. B. Office 365 globaler Administrator oder Power BI-Dienstadministrator).
Der Administratorbenutzer und der delegierte Benutzer (sofern angegeben) muss über ausreichende Nutzungsrechte verfügen, um Bezeichnungen festzulegen.

Erforderlicher Bereich

Tenant.ReadWrite.All

Einschränkungen

Maximal 25 Anforderungen pro Stunde.
Jede Anforderung kann bis zu 2.000 Power BI-Elemente aktualisieren.

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

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
artifacts	True	InformationProtectionArtifactsChangeLabel	Ein Zusammengesetzt aus Power BI-Element-IDs für jeden Elementtyp
labelId	True	string	Die Bezeichnungs-ID, die sich in der Bezeichnungsrichtlinie des Benutzers befinden muss.
assignmentMethod		assignmentMethod	Gibt an, ob die zugewiesene Bezeichnung von einem automatisierten Prozess oder manuell festgelegt wurde.
delegatedUser		DelegatedUser	Delegierte Benutzerdetails. Ein delegierter Benutzer ist ein Benutzer innerhalb einer Organisation, dessen Administrator eine Bezeichnung im Namen des Benutzers festlegt. Obwohl der Administrator die Bezeichnung festlegt, wird der delegierte Benutzer als Bezeichnungsaussteller markiert.

Antworten

Name	Typ	Beschreibung
200 OK	InformationProtectionChangeLabelResponse	OK

Beispiele

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

Definitionen

Name	Beschreibung
ArtifactId	Die eindeutige ID eines Power BI-Elements im UUID-Format. Dashboard-, Berichts- und Datenfluss-IDs befinden sich im UUID-Format, und Dataset-IDs können sich im UUID- oder Zeichenfolgenformat befinden.
ArtifactStringId	Die eindeutige ID eines Power BI-Elements im Zeichenfolgen- oder UUID-Format. Dashboard-, Berichts- und Datenfluss-IDs befinden sich im UUID-Format, und Dataset-IDs können sich im UUID- oder Zeichenfolgenformat befinden.
assignmentMethod	Gibt an, ob die zugewiesene Bezeichnung von einem automatisierten Prozess oder manuell festgelegt wurde.
ChangeLabelStatus	Der eindeutige ID- und Informationsschutzbezeichnungsstatus eines Power BI-Elements ändern
DelegatedUser	Delegierte Benutzerdetails. Der Benutzer muss ein vorhandener Benutzer in Power BI und Azure AAD sein und sich während der letzten drei Monate bei Power BI angemeldet haben.
InformationProtectionArtifactsChangeLabel	Eine Kombination aus Power BI-Element-IDs für jeden Elementtyp. Die IDs geben an, welche Power BI-Elemente eine Aktualisierung der Informationsschutzbezeichnung erfordern.
InformationProtectionChangeLabelDetails	Eine Kombination aus Bezeichnungsinformationen, die zum Aktualisieren einer Informationsschutzbezeichnung erforderlich sind
InformationProtectionChangeLabelResponse	Ein Zusammengesetzt aus dem Status der ID- und Informationsschutzbezeichnung für einen oder mehrere Power BI-Elemente, die nach Typ organisiert sind
status	Der Status eines Änderungsvorgangs für den Informationsschutz

ArtifactId

Die eindeutige ID eines Power BI-Elements im UUID-Format. Dashboard-, Berichts- und Datenfluss-IDs befinden sich im UUID-Format, und Dataset-IDs können sich im UUID- oder Zeichenfolgenformat befinden.

Name	Typ	Beschreibung
id	string	Eine ID im UUID-Format

ArtifactStringId

Die eindeutige ID eines Power BI-Elements im Zeichenfolgen- oder UUID-Format. Dashboard-, Berichts- und Datenfluss-IDs befinden sich im UUID-Format, und Dataset-IDs können sich im UUID- oder Zeichenfolgenformat befinden.

Name	Typ	Beschreibung
id	string	Eine ID im Zeichenfolgen- oder UUID-Format

assignmentMethod

Gibt an, ob die zugewiesene Bezeichnung von einem automatisierten Prozess oder manuell festgelegt wurde.

Name	Typ	Beschreibung
Priviledged	string	Die Bezeichnung wurde manuell festgelegt.
Standard	string	Die Bezeichnung wurde durch einen automatisierten Prozess (Standardwert) festgelegt.

ChangeLabelStatus

Der eindeutige ID- und Informationsschutzbezeichnungsstatus eines Power BI-Elements ändern

Name	Typ	Beschreibung
id	string	Die eindeutige ID eines Power BI-Elements. Die ID befindet sich im UUID-Format für Dashboards, Berichte und Datenflüsse; und im UUID- oder Zeichenfolgenformat für Datasets.
status	status	Der Status eines Änderungsvorgangs für den Informationsschutz

DelegatedUser

Delegierte Benutzerdetails. Der Benutzer muss ein vorhandener Benutzer in Power BI und Azure AAD sein und sich während der letzten drei Monate bei Power BI angemeldet haben.

Name	Typ	Beschreibung
emailAddress	string	Die E-Mail-Adresse des delegierten Benutzers

InformationProtectionArtifactsChangeLabel

Eine Kombination aus Power BI-Element-IDs für jeden Elementtyp. Die IDs geben an, welche Power BI-Elemente eine Aktualisierung der Informationsschutzbezeichnung erfordern.

Name	Typ	Beschreibung
dashboards	ArtifactId[]	Eine Liste eindeutiger Dashboard-IDs
dataflows	ArtifactId[]	Eine Liste eindeutiger Datenfluss-IDs
datasets	ArtifactStringId[]	Eine Liste eindeutiger Dataset-IDs
reports	ArtifactId[]	Eine Liste der eindeutigen Berichts-IDs

InformationProtectionChangeLabelDetails

Eine Kombination aus Bezeichnungsinformationen, die zum Aktualisieren einer Informationsschutzbezeichnung erforderlich sind

Name	Typ	Beschreibung
artifacts	InformationProtectionArtifactsChangeLabel	Ein Zusammengesetzt aus Power BI-Element-IDs für jeden Elementtyp
assignmentMethod	assignmentMethod	Gibt an, ob die zugewiesene Bezeichnung von einem automatisierten Prozess oder manuell festgelegt wurde.
delegatedUser	DelegatedUser	Delegierte Benutzerdetails. Ein delegierter Benutzer ist ein Benutzer innerhalb einer Organisation, dessen Administrator eine Bezeichnung im Namen des Benutzers festlegt. Obwohl der Administrator die Bezeichnung festlegt, wird der delegierte Benutzer als Bezeichnungsaussteller markiert.
labelId	string	Die Bezeichnungs-ID, die sich in der Bezeichnungsrichtlinie des Benutzers befinden muss.

InformationProtectionChangeLabelResponse

Ein Zusammengesetzt aus dem Status der ID- und Informationsschutzbezeichnung für einen oder mehrere Power BI-Elemente, die nach Typ organisiert sind

Name	Typ	Beschreibung
dashboards	ChangeLabelStatus[]	Eine Liste mit dem eindeutigen ID- und Informationsschutzbezeichnungsänderungsstatus eines oder mehrerer Dashboards
dataflows	ChangeLabelStatus[]	Eine Liste mit dem eindeutigen ID- und Informationsschutzbezeichnungsänderungsstatus eines oder mehrerer Datenflüsse
datasets	ChangeLabelStatus[]	Eine Liste mit dem eindeutigen ID- und Informationsschutzbezeichnungsänderungsstatus eines oder mehrerer Datasets
reports	ChangeLabelStatus[]	Eine Liste mit dem eindeutigen ID- und Informationsschutzbezeichnungsstatus eines oder mehrerer Berichte

status

Der Status eines Änderungsvorgangs für den Informationsschutz

Name	Typ	Beschreibung
Failed	string	Fehler beim Festlegen einer neuen Bezeichnung. Versuchen Sie es erneut.
FailedToGetUsageRights	string	Fehler beim Festlegen einer neuen Bezeichnung. Das Power BI-Element verfügt über eine Vertraulichkeitsbezeichnung mit Schutzeinstellungen, und Power BI konnte nicht überprüfen, ob der Benutzer über ausreichende Nutzungsrechte verfügt, um die Bezeichnung zu ändern.
InsufficientUsageRights	string	Fehler beim Festlegen einer neuen Bezeichnung. Das Power BI-Element verfügt über eine Vertraulichkeitsbezeichnung mit Schutzeinstellungen, und der Administratorbenutzer (und der delegierte Benutzer, sofern angegeben), verfügt nicht über ausreichende Nutzungsrechte, um die Bezeichnung zu ändern.
NotFound	string	Die Power BI-Element-ID oder Bezeichnung wurde nicht gefunden.
Succeeded	string	Die Power BI-Elementbezeichnung wurde geändert.