Admin - InformationProtection SetLabelsAsAdmin

リファレンス

Service:: Power BI REST APIs

API Version:: v1.0

Power BI アイテム (レポートやダッシュボードなど) の秘密度ラベルを項目 ID で設定します。

この API を使用して秘密度ラベルを設定するには、管理者ユーザーまたは委任されたユーザー (指定されている場合) にラベルがラベルポリシーに含まれている必要があります。使用例については、「秘密度ラベルを設定または削除する」を参照してください。

アクセス許可

ユーザーは管理者権限 (Office 365グローバル管理者や Power BI サービス管理者など) を持っている必要があります。
管理者ユーザーと委任されたユーザー (指定されている場合) には、ラベルを設定するための十分な使用権限が必要です。

必要なスコープ

Tenant.ReadWrite.All

制限事項

1 時間あたり最大 25 件の要求。
各要求は、最大 2,000 個の Power BI アイテムを更新できます。

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

要求本文

名前	必須	型	説明
artifacts	True	InformationProtectionArtifactsChangeLabel	アイテムの種類ごとの Power BI 項目 ID の複合
labelId	True	string	ユーザーのラベルポリシーに含まれている必要があるラベル ID。
assignmentMethod		assignmentMethod	割り当てられたラベルが自動プロセスによって設定されたか、手動で設定されたかを指定します。
delegatedUser		DelegatedUser	委任されたユーザーの詳細。委任されたユーザーとは、管理者がユーザーの代わりにラベルを設定する組織内のユーザーです。管理者はラベルを設定しますが、委任されたユーザーはラベル発行者としてマークされます。

応答

名前	型	説明
200 OK	InformationProtectionChangeLabelResponse	OK

例

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

定義

名前	説明
ArtifactId	UUID 形式の Power BI 項目の一意の ID。ダッシュボード、レポート、およびデータフロー ID は UUID 形式で、データセット ID は UUID または文字列形式にすることができます。
ArtifactStringId	文字列または UUID 形式の Power BI 項目の一意の ID。ダッシュボード、レポート、およびデータフロー ID は UUID 形式で、データセット ID は UUID または文字列形式にすることができます。
assignmentMethod	割り当てられたラベルが自動プロセスによって設定されたか、手動で設定されたかを指定します。
ChangeLabelStatus	Power BI アイテムの一意の ID と情報保護ラベルの変更状態
DelegatedUser	委任されたユーザーの詳細。ユーザーは Power BI と Azure AAD の既存のユーザーであり、過去 3 か月間に Power BI にサインインしている必要があります。
InformationProtectionArtifactsChangeLabel	アイテムの種類ごとの Power BI 項目 ID の複合。 ID は、情報保護ラベルの更新が必要な Power BI 項目を指定します。
InformationProtectionChangeLabelDetails	情報保護ラベルを更新するために必要なラベル情報の複合
InformationProtectionChangeLabelResponse	種類別に整理された 1 つ以上の Power BI 項目の ID と情報保護ラベルの変更状態の複合
status	情報保護ラベル変更操作の状態

ArtifactId

UUID 形式の Power BI 項目の一意の ID。ダッシュボード、レポート、およびデータフロー ID は UUID 形式で、データセット ID は UUID または文字列形式にすることができます。

名前	型	説明
id	string	UUID 形式の ID

ArtifactStringId

文字列または UUID 形式の Power BI 項目の一意の ID。ダッシュボード、レポート、およびデータフロー ID は UUID 形式で、データセット ID は UUID または文字列形式にすることができます。

名前	型	説明
id	string	文字列または UUID 形式の ID

assignmentMethod

割り当てられたラベルが自動プロセスによって設定されたか、手動で設定されたかを指定します。

名前	型	説明
Priviledged	string	ラベルが手動で設定されました
Standard	string	ラベルは自動化されたプロセスによって設定されました (既定値)

ChangeLabelStatus

Power BI アイテムの一意の ID と情報保護ラベルの変更状態

名前	型	説明
id	string	Power BI 項目の一意の ID。 ID は、ダッシュボード、レポート、およびデータフローの UUID 形式です。データセットの UUID または文字列形式。
status	status	情報保護ラベル変更操作の状態

DelegatedUser

委任されたユーザーの詳細。ユーザーは Power BI と Azure AAD の既存のユーザーであり、過去 3 か月間に Power BI にサインインしている必要があります。

名前	型	説明
emailAddress	string	委任されたユーザーのメールアドレス

InformationProtectionArtifactsChangeLabel

アイテムの種類ごとの Power BI 項目 ID の複合。 ID は、情報保護ラベルの更新が必要な Power BI 項目を指定します。

名前	型	説明
dashboards	ArtifactId[]	一意のダッシュボード ID の一覧
dataflows	ArtifactId[]	一意のデータフロー ID の一覧
datasets	ArtifactStringId[]	一意のデータセット ID の一覧
reports	ArtifactId[]	一意のレポート ID の一覧

InformationProtectionChangeLabelDetails

情報保護ラベルを更新するために必要なラベル情報の複合

名前	型	説明
artifacts	InformationProtectionArtifactsChangeLabel	アイテムの種類ごとの Power BI 項目 ID の複合
assignmentMethod	assignmentMethod	割り当てられたラベルが自動プロセスによって設定されたか、手動で設定されたかを指定します。
delegatedUser	DelegatedUser	委任されたユーザーの詳細。委任されたユーザーとは、管理者がユーザーの代わりにラベルを設定する組織内のユーザーです。管理者はラベルを設定しますが、委任されたユーザーはラベル発行者としてマークされます。
labelId	string	ユーザーのラベルポリシーに含まれている必要があるラベル ID。

InformationProtectionChangeLabelResponse

種類別に整理された 1 つ以上の Power BI 項目の ID と情報保護ラベルの変更状態の複合

名前	型	説明
dashboards	ChangeLabelStatus[]	1 つ以上のダッシュボードの一意の ID と情報保護ラベルの変更状態を含むリスト
dataflows	ChangeLabelStatus[]	1 つ以上のデータフローの一意の ID と情報保護ラベルの変更状態を含むリスト
datasets	ChangeLabelStatus[]	1 つ以上のデータセットの一意の ID と情報保護ラベルの変更状態を含むリスト
reports	ChangeLabelStatus[]	1 つ以上のレポートの一意の ID と情報保護ラベルの変更状態を含むリスト

status

情報保護ラベル変更操作の状態

名前	型	説明
Failed	string	新しいラベルを設定できませんでした。もう一度お試しください。
FailedToGetUsageRights	string	新しいラベルを設定できませんでした。 Power BI 項目には保護設定の秘密度ラベルがあり、Power BI はユーザーがラベルを変更するための十分な使用権限を持っていることを確認できませんでした。
InsufficientUsageRights	string	新しいラベルを設定できませんでした。 Power BI 項目には保護設定を含む秘密度ラベルがあり、管理者ユーザー (および提供されている場合は委任されたユーザー) には、ラベルを変更するための十分な使用権限がありません。
NotFound	string	Power BI 項目 ID またはラベルが見つかりませんでした
Succeeded	string	Power BI 項目ラベルが変更されました