Admin - InformationProtection SetLabelsAsAdmin

參考

Service:: Power BI REST APIs

API Version:: v1.0

在 Power BI 專案上設定敏感度標籤 (，例如依專案識別碼) 報表或儀表板。

若要使用此 API 設定敏感度標籤，如果提供) 系統管理員使用者或委派的使用者必須具有標籤原則中包含的標籤，則 (。如需使用範例，請參閱設定或移除敏感度標籤。

權限

使用者必須具有系統管理員許可權 (，例如Office 365全域管理員或 Power BI 服務管理員) 。
如果提供) 必須有足夠的許可權來設定標籤，則系統管理員使用者和委派的使用者 (。

必要範圍

Tenant.ReadWrite.All

限制

每小時最多 25 個要求。
每個要求最多可以更新 2，000 個 Power BI 專案。

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

要求本文

名稱	必要	類型	Description
artifacts	True	InformationProtectionArtifactsChangeLabel	每個專案類型的 Power BI 專案識別碼複合
labelId	True	string	標籤識別碼，必須位於使用者的標籤原則中。
assignmentMethod		assignmentMethod	指定指派的標籤是由自動化程式設定，還是手動設定。
delegatedUser		DelegatedUser	委派的使用者詳細資料。委派的使用者是組織內的使用者，其系統管理員代表使用者設定標籤。雖然系統管理員會設定標籤，但委派的使用者會標示為標籤簽發者。

回應

名稱	類型	Description
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"
    }
  ]
}

定義

名稱	Description
ArtifactId	UUID 格式之 Power BI 專案的唯一識別碼。儀表板、報表和資料流程識別碼為 UUID 格式，而資料集識別碼可以是 UUID 或字串格式。
ArtifactStringId	字串或 UUID 格式之 Power BI 專案的唯一識別碼。儀表板、報表和資料流程識別碼為 UUID 格式，而資料集識別碼可以是 UUID 或字串格式。
assignmentMethod	指定指派的標籤是由自動化程式設定，還是手動設定。
ChangeLabelStatus	Power BI 專案的唯一識別碼和資訊保護標籤變更狀態
DelegatedUser	委派的使用者詳細資料。使用者必須是 Power BI 和 Azure AAD 中的現有使用者，而且在過去三個月內必須登入 Power BI。
InformationProtectionArtifactsChangeLabel	每個專案類型的 Power BI 專案識別碼複合。識別碼會指定哪些 Power BI 專案需要資訊保護標籤更新。
InformationProtectionChangeLabelDetails	更新資訊保護標籤所需的標籤資訊複合
InformationProtectionChangeLabelResponse	依類型組織之一或多個 Power BI 專案的識別碼和資訊保護標籤變更狀態的複合
status	資訊保護標籤變更作業的狀態

ArtifactId

UUID 格式之 Power BI 專案的唯一識別碼。儀表板、報表和資料流程識別碼為 UUID 格式，而資料集識別碼可以是 UUID 或字串格式。

名稱	類型	Description
id	string	UUID 格式的識別碼

ArtifactStringId

字串或 UUID 格式之 Power BI 專案的唯一識別碼。儀表板、報表和資料流程識別碼為 UUID 格式，而資料集識別碼可以是 UUID 或字串格式。

名稱	類型	Description
id	string	字串或 UUID 格式的識別碼

assignmentMethod

指定指派的標籤是由自動化程式設定，還是手動設定。

名稱	類型	Description
Priviledged	string	標籤已手動設定
Standard	string	標籤是由自動化程式所設定， (預設值)

ChangeLabelStatus

Power BI 專案的唯一識別碼和資訊保護標籤變更狀態

名稱	類型	Description
id	string	Power BI 專案的唯一識別碼。識別碼為儀表板、報表和資料流程的 UUID 格式;和，以 UUID 或資料集的字串格式表示。
status	status	資訊保護標籤變更作業的狀態

DelegatedUser

委派的使用者詳細資料。使用者必須是 Power BI 和 Azure AAD 中的現有使用者，而且在過去三個月內必須登入 Power BI。

名稱	類型	Description
emailAddress	string	委派使用者的電子郵件地址

InformationProtectionArtifactsChangeLabel

每個專案類型的 Power BI 專案識別碼複合。識別碼會指定哪些 Power BI 專案需要資訊保護標籤更新。

名稱	類型	Description
dashboards	ArtifactId[]	唯一儀表板識別碼的清單
dataflows	ArtifactId[]	唯一資料流程識別碼的清單
datasets	ArtifactStringId[]	唯一資料集識別碼的清單
reports	ArtifactId[]	唯一報表識別碼的清單

InformationProtectionChangeLabelDetails

更新資訊保護標籤所需的標籤資訊複合

名稱	類型	Description
artifacts	InformationProtectionArtifactsChangeLabel	每個專案類型的 Power BI 專案識別碼複合
assignmentMethod	assignmentMethod	指定指派的標籤是由自動化程式設定，還是手動設定。
delegatedUser	DelegatedUser	委派的使用者詳細資料。委派的使用者是組織內的使用者，其系統管理員代表使用者設定標籤。雖然系統管理員會設定標籤，但委派的使用者會標示為標籤簽發者。
labelId	string	標籤識別碼，必須位於使用者的標籤原則中。

InformationProtectionChangeLabelResponse

依類型組織之一或多個 Power BI 專案的識別碼和資訊保護標籤變更狀態的複合

名稱	類型	Description
dashboards	ChangeLabelStatus[]	包含一或多個儀表板的唯一識別碼和資訊保護標籤變更狀態的清單
dataflows	ChangeLabelStatus[]	包含一或多個資料流程的唯一識別碼和資訊保護標籤變更狀態的清單
datasets	ChangeLabelStatus[]	包含一或多個資料集的唯一識別碼和資訊保護標籤變更狀態的清單
reports	ChangeLabelStatus[]	包含一或多個報表的唯一識別碼和資訊保護標籤變更狀態的清單

status

資訊保護標籤變更作業的狀態

名稱	類型	Description
Failed	string	無法設定新的標籤。請再試一次。
FailedToGetUsageRights	string	無法設定新的標籤。 Power BI 專案具有具有保護設定的敏感度標籤，且 Power BI 無法確認使用者有足夠的許可權可變更標籤。
InsufficientUsageRights	string	無法設定新的標籤。如果提供的) 沒有足夠的許可權來變更標籤，Power BI 專案具有具有保護設定的敏感度標籤，而系統管理員使用者 (和委派的使用者。
NotFound	string	找不到 Power BI 專案識別碼或標籤
Succeeded	string	Power BI 專案標籤已變更