Admin - InformationProtection SetLabelsAsAdmin

参考

Service:: Power BI REST APIs

API Version:: v1.0

在 Power BI 项上设置敏感度标签 (，例如按项 ID) 报表或仪表板。

若要使用此 API 设置敏感度标签，管理员用户或委托用户 (如果提供) 必须包含标签策略中的标签。有关使用示例，请参阅 “设置或删除敏感度标签”。

权限

用户必须具有管理员权限 (，例如Office 365全局管理员或 Power BI 服务管理员) 。
如果提供的) 必须具有足够的使用权限来设置标签，则管理员用户和委托用户 (。

所需范围

Tenant.ReadWrite.All

限制

每小时最多 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，该 ID 必须位于用户的标签策略中。
assignmentMethod		assignmentMethod	指定是由自动化过程还是手动设置分配的标签。
delegatedUser		DelegatedUser	委派的用户详细信息。委托用户是组织中的用户，其管理员代表用户设置标签。尽管管理员设置了标签，但委托的用户被标记为标签颁发者。

响应

名称	类型	说明
200 OK	InformationProtectionChangeLabelResponse	确定

示例

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 中的现有用户，并且在过去三个月内必须登录到 Power BI。
InformationProtectionArtifactsChangeLabel	每个项类型的 Power BI 项 ID 的组合。 ID 指定哪些 Power BI 项需要信息保护标签更新。
InformationProtectionChangeLabelDetails	更新信息保护标签所需的标签信息组合
InformationProtectionChangeLabelResponse	按类型组织的一个或多个 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 中的现有用户，并且在过去三个月内必须登录到 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，该 ID 必须位于用户的标签策略中。

InformationProtectionChangeLabelResponse

按类型组织的一个或多个 Power BI 项的 ID 和信息保护标签更改状态的组合

名称	类型	说明
dashboards	ChangeLabelStatus[]	包含一个或多个仪表板的唯一 ID 和信息保护标签更改状态的列表
dataflows	ChangeLabelStatus[]	包含一个或多个数据流的唯一 ID 和信息保护标签更改状态的列表
datasets	ChangeLabelStatus[]	包含一个或多个数据集的唯一 ID 和信息保护标签更改状态的列表
reports	ChangeLabelStatus[]	包含一个或多个报表的唯一 ID 和信息保护标签更改状态的列表

status

信息保护标签更改操作的状态

名称	类型	说明
Failed	string	未能设置新标签。请重试。
FailedToGetUsageRights	string	未能设置新标签。 Power BI 项具有具有保护设置的敏感度标签，并且 Power BI 无法验证用户是否具有足够的使用权限来更改标签。
InsufficientUsageRights	string	未能设置新标签。 Power BI 项具有具有保护设置的敏感度标签，并且管理员用户 (和委派用户（如果提供) 没有足够的使用权限来更改标签）。
NotFound	string	找不到 Power BI 项 ID 或标签
Succeeded	string	Power BI 项标签已更改