Admin - InformationProtection SetLabelsAsAdmin

Odwołanie

Service:: Power BI REST APIs

API Version:: v1.0

Ustaw etykiety poufności na elementach usługi Power BI (takich jak raporty lub pulpity nawigacyjne) według identyfikatora elementu.

Aby ustawić etykietę poufności przy użyciu tego interfejsu API, administrator lub delegowany użytkownik (jeśli podano) musi mieć etykietę dołączona do zasad etykiet. Aby zapoznać się z przykładem użycia, zobacz Ustawianie lub usuwanie etykiet poufności.

Uprawnienia

Użytkownik musi mieć uprawnienia administratora (takie jak administrator globalny Office 365 lub administrator usługi Power BI).
Użytkownik administracyjny i użytkownik delegowany (jeśli podano) muszą mieć wystarczające prawa użytkowania , aby ustawić etykiety.

Wymagany zakres

Tenant.ReadWrite.All

Ograniczenia

Maksymalnie 25 żądań na godzinę.
Każde żądanie może zaktualizować maksymalnie 2000 elementów usługi Power BI.

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

Treść żądania

Nazwa	Wymagane	Typ	Opis
artifacts	True	InformationProtectionArtifactsChangeLabel	Złożony identyfikator elementów usługi Power BI dla każdego typu elementu
labelId	True	string	Identyfikator etykiety, który musi znajdować się w zasadach etykiety użytkownika.
assignmentMethod		assignmentMethod	Określa, czy przypisana etykieta została ustawiona przez zautomatyzowany proces, czy ręcznie.
delegatedUser		DelegatedUser	Szczegóły delegowanego użytkownika. Użytkownik delegowany jest użytkownikiem w organizacji, którego administrator ustawia etykietę w imieniu użytkownika. Mimo że administrator ustawia etykietę, delegowany użytkownik jest oznaczony jako wystawca etykiety.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	InformationProtectionChangeLabelResponse	OK

Przykłady

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

Definicje

Nazwa	Opis
ArtifactId	Unikatowy identyfikator elementu usługi Power BI w formacie UUID. Identyfikatory pulpitu nawigacyjnego, raportu i przepływu danych są w formacie UUID, a identyfikatory zestawów danych mogą być w formacie UUID lub ciągu.
ArtifactStringId	Unikatowy identyfikator elementu usługi Power BI w formacie ciągu lub UUID. Identyfikatory pulpitu nawigacyjnego, raportu i przepływu danych są w formacie UUID, a identyfikatory zestawów danych mogą być w formacie UUID lub ciągu.
assignmentMethod	Określa, czy przypisana etykieta została ustawiona przez zautomatyzowany proces, czy ręcznie.
ChangeLabelStatus	Stan zmiany unikatowego identyfikatora i etykiety ochrony informacji elementu usługi Power BI
DelegatedUser	Szczegóły delegowanego użytkownika. Użytkownik musi być istniejącym użytkownikiem usługi Power BI i usługi Azure AAD i musi zalogować się do usługi Power BI w ciągu ostatnich trzech miesięcy.
InformationProtectionArtifactsChangeLabel	Złożony identyfikator elementów usługi Power BI dla każdego typu elementu. Identyfikatory określają, które elementy usługi Power BI wymagają aktualizacji etykiety ochrony informacji.
InformationProtectionChangeLabelDetails	Złożona informacja o etykiecie wymagana do zaktualizowania etykiety ochrony informacji
InformationProtectionChangeLabelResponse	Złożony stan zmiany etykiety identyfikatora i ochrony informacji dla co najmniej jednego elementu usługi Power BI zorganizowanego według typu
status	Stan operacji zmiany etykiety ochrony informacji

ArtifactId

Unikatowy identyfikator elementu usługi Power BI w formacie UUID. Identyfikatory pulpitu nawigacyjnego, raportu i przepływu danych są w formacie UUID, a identyfikatory zestawów danych mogą być w formacie UUID lub ciągu.

Nazwa	Typ	Opis
id	string	Identyfikator w formacie UUID

ArtifactStringId

Unikatowy identyfikator elementu usługi Power BI w formacie ciągu lub UUID. Identyfikatory pulpitu nawigacyjnego, raportu i przepływu danych są w formacie UUID, a identyfikatory zestawów danych mogą być w formacie UUID lub ciągu.

Nazwa	Typ	Opis
id	string	Identyfikator w formacie ciągu lub UUID

assignmentMethod

Określa, czy przypisana etykieta została ustawiona przez zautomatyzowany proces, czy ręcznie.

Nazwa	Typ	Opis
Priviledged	string	Etykieta została ustawiona ręcznie
Standard	string	Etykieta została ustawiona przez zautomatyzowany proces (wartość domyślna)

ChangeLabelStatus

Stan zmiany unikatowego identyfikatora i etykiety ochrony informacji elementu usługi Power BI

Nazwa	Typ	Opis
id	string	Unikatowy identyfikator elementu usługi Power BI. Identyfikator jest w formacie UUID dla pulpitów nawigacyjnych, raportów i przepływów danych; i w formacie UUID lub ciągu dla zestawów danych.
status	status	Stan operacji zmiany etykiety ochrony informacji

DelegatedUser

Szczegóły delegowanego użytkownika. Użytkownik musi być istniejącym użytkownikiem usługi Power BI i usługi Azure AAD i musi zalogować się do usługi Power BI w ciągu ostatnich trzech miesięcy.

Nazwa	Typ	Opis
emailAddress	string	Adres e-mail delegowanego użytkownika

InformationProtectionArtifactsChangeLabel

Złożony identyfikator elementów usługi Power BI dla każdego typu elementu. Identyfikatory określają, które elementy usługi Power BI wymagają aktualizacji etykiety ochrony informacji.

Nazwa	Typ	Opis
dashboards	ArtifactId[]	Lista unikatowych identyfikatorów pulpitu nawigacyjnego
dataflows	ArtifactId[]	Lista unikatowych identyfikatorów przepływów danych
datasets	ArtifactStringId[]	Lista unikatowych identyfikatorów zestawów danych
reports	ArtifactId[]	Lista unikatowych identyfikatorów raportów

InformationProtectionChangeLabelDetails

Złożona informacja o etykiecie wymagana do zaktualizowania etykiety ochrony informacji

Nazwa	Typ	Opis
artifacts	InformationProtectionArtifactsChangeLabel	Złożony identyfikator elementów usługi Power BI dla każdego typu elementu
assignmentMethod	assignmentMethod	Określa, czy przypisana etykieta została ustawiona przez zautomatyzowany proces, czy ręcznie.
delegatedUser	DelegatedUser	Szczegóły delegowanego użytkownika. Użytkownik delegowany jest użytkownikiem w organizacji, którego administrator ustawia etykietę w imieniu użytkownika. Mimo że administrator ustawia etykietę, delegowany użytkownik jest oznaczony jako wystawca etykiety.
labelId	string	Identyfikator etykiety, który musi znajdować się w zasadach etykiety użytkownika.

InformationProtectionChangeLabelResponse

Złożony stan zmiany etykiety identyfikatora i ochrony informacji dla co najmniej jednego elementu usługi Power BI zorganizowanego według typu

Nazwa	Typ	Opis
dashboards	ChangeLabelStatus[]	Lista zawierająca unikatowy identyfikator i stan zmiany etykiety ochrony informacji co najmniej jednego pulpitu nawigacyjnego
dataflows	ChangeLabelStatus[]	Lista zawierająca unikatowy identyfikator i stan zmiany etykiety ochrony informacji co najmniej jednego przepływu danych
datasets	ChangeLabelStatus[]	Lista zawierająca unikatowy identyfikator i stan zmiany etykiety ochrony informacji dla co najmniej jednego zestawu danych
reports	ChangeLabelStatus[]	Lista zawierająca unikatowy identyfikator i stan zmiany etykiety ochrony informacji co najmniej jednego raportu

status

Stan operacji zmiany etykiety ochrony informacji

Nazwa	Typ	Opis
Failed	string	Nie można ustawić nowej etykiety. Spróbuj ponownie.
FailedToGetUsageRights	string	Nie można ustawić nowej etykiety. Element usługi Power BI ma etykietę poufności z ustawieniami ochrony, a usługa Power BI nie może sprawdzić, czy użytkownik ma wystarczające prawa użytkowania, aby zmienić etykietę.
InsufficientUsageRights	string	Nie można ustawić nowej etykiety. Element usługi Power BI ma etykietę poufności z ustawieniami ochrony, a administrator (i użytkownik delegowany, jeśli podano) nie ma wystarczających praw użytkowania, aby zmienić etykietę.
NotFound	string	Nie znaleziono identyfikatora lub etykiety elementu usługi Power BI
Succeeded	string	Zmieniono etykietę elementu usługi Power BI