Compartilhar via


Admin - InformationProtection SetLabelsAsAdmin

Defina rótulos de confidencialidade em itens do Power BI (como relatórios ou dashboards) por ID do item.

Para definir um rótulo de confidencialidade usando essa API, o usuário administrador ou o usuário delegado (se fornecido) devem ter o rótulo incluído em sua política de rótulo. Para obter um exemplo de uso, consulte Definir ou remover rótulos de confidencialidade.

Permissões

  • O usuário deve ter direitos de administrador (como Office 365 Administrador Global ou Administrador de Serviços do Power BI).
  • O usuário administrador e o usuário delegado (se fornecido) devem ter direitos de uso suficientes para definir rótulos.

Escopo Necessário

Tenant.ReadWrite.All

Limitações

  • Máximo de 25 solicitações por hora.
  • Cada solicitação pode atualizar até 2.000 itens do Power BI.

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

Corpo da solicitação

Nome Obrigatório Tipo Description
artifacts True

InformationProtectionArtifactsChangeLabel

Uma composição de IDs de item do Power BI para cada tipo de item

labelId True

string

A ID do rótulo, que deve estar na política de rótulo do usuário.

assignmentMethod

assignmentMethod

Especifica se o rótulo atribuído foi definido por um processo automatizado ou manualmente.

delegatedUser

DelegatedUser

Detalhes do usuário delegado. Um usuário delegado é um usuário dentro de uma organização cujo administrador define um rótulo em nome do usuário. Embora o administrador defina o rótulo, o usuário delegado é marcado como o emissor do rótulo.

Respostas

Nome Tipo Description
200 OK

InformationProtectionChangeLabelResponse

OK

Exemplos

Example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/admin/informationprotection/setLabels
{
  "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

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

Definições

Nome Description
ArtifactId

A ID exclusiva de um item do Power BI no formato UUID. As IDs de painel, relatório e fluxo de dados estão no formato UUID e as IDs do conjunto de dados podem estar no formato UUID ou cadeia de caracteres.

ArtifactStringId

A ID exclusiva de um item do Power BI em formato de cadeia de caracteres ou UUID. As IDs de painel, relatório e fluxo de dados estão no formato UUID e as IDs do conjunto de dados podem estar no formato UUID ou cadeia de caracteres.

assignmentMethod

Especifica se o rótulo atribuído foi definido por um processo automatizado ou manualmente.

ChangeLabelStatus

A ID exclusiva e o status de alteração do rótulo de proteção de informações de um item do Power BI

DelegatedUser

Detalhes do usuário delegado. O usuário deve ser um usuário existente no Power BI e no Azure AAD e deve ter se conectado ao Power BI nos últimos três meses.

InformationProtectionArtifactsChangeLabel

Uma composição de IDs de item do Power BI para cada tipo de item. As IDs especificam quais itens do Power BI exigem uma atualização do rótulo de proteção de informações.

InformationProtectionChangeLabelDetails

Uma composição de informações de rótulo necessárias para atualizar um rótulo de proteção de informações

InformationProtectionChangeLabelResponse

Uma composição do status de alteração do rótulo de proteção de informações e ID para um ou mais itens do Power BI organizados por tipo

status

O status de uma operação de alteração de rótulo de proteção de informações

ArtifactId

A ID exclusiva de um item do Power BI no formato UUID. As IDs de painel, relatório e fluxo de dados estão no formato UUID e as IDs do conjunto de dados podem estar no formato UUID ou cadeia de caracteres.

Nome Tipo Description
id

string

Uma ID no formato UUID

ArtifactStringId

A ID exclusiva de um item do Power BI em formato de cadeia de caracteres ou UUID. As IDs de painel, relatório e fluxo de dados estão no formato UUID e as IDs do conjunto de dados podem estar no formato UUID ou cadeia de caracteres.

Nome Tipo Description
id

string

Uma ID no formato de cadeia de caracteres ou UUID

assignmentMethod

Especifica se o rótulo atribuído foi definido por um processo automatizado ou manualmente.

Nome Tipo Description
Priviledged

string

O rótulo foi definido manualmente

Standard

string

O rótulo foi definido por um processo automatizado (valor padrão)

ChangeLabelStatus

A ID exclusiva e o status de alteração do rótulo de proteção de informações de um item do Power BI

Nome Tipo Description
id

string

A ID exclusiva de um item do Power BI. A ID está no formato UUID para dashboards, relatórios e fluxos de dados; e no formato UUID ou cadeia de caracteres para conjuntos de dados.

status

status

O status de uma operação de alteração de rótulo de proteção de informações

DelegatedUser

Detalhes do usuário delegado. O usuário deve ser um usuário existente no Power BI e no Azure AAD e deve ter se conectado ao Power BI nos últimos três meses.

Nome Tipo Description
emailAddress

string

O endereço de email do usuário delegado

InformationProtectionArtifactsChangeLabel

Uma composição de IDs de item do Power BI para cada tipo de item. As IDs especificam quais itens do Power BI exigem uma atualização do rótulo de proteção de informações.

Nome Tipo Description
dashboards

ArtifactId[]

Uma lista de IDs exclusivas do painel

dataflows

ArtifactId[]

Uma lista de IDs de fluxo de dados exclusivas

datasets

ArtifactStringId[]

Uma lista de IDs exclusivas do conjunto de dados

reports

ArtifactId[]

Uma lista de IDs de relatório exclusivas

InformationProtectionChangeLabelDetails

Uma composição de informações de rótulo necessárias para atualizar um rótulo de proteção de informações

Nome Tipo Description
artifacts

InformationProtectionArtifactsChangeLabel

Uma composição de IDs de item do Power BI para cada tipo de item

assignmentMethod

assignmentMethod

Especifica se o rótulo atribuído foi definido por um processo automatizado ou manualmente.

delegatedUser

DelegatedUser

Detalhes do usuário delegado. Um usuário delegado é um usuário dentro de uma organização cujo administrador define um rótulo em nome do usuário. Embora o administrador defina o rótulo, o usuário delegado é marcado como o emissor do rótulo.

labelId

string

A ID do rótulo, que deve estar na política de rótulo do usuário.

InformationProtectionChangeLabelResponse

Uma composição do status de alteração do rótulo de proteção de informações e ID para um ou mais itens do Power BI organizados por tipo

Nome Tipo Description
dashboards

ChangeLabelStatus[]

Uma lista que contém a ID exclusiva e o status de alteração do rótulo de proteção de informações de um ou mais painéis

dataflows

ChangeLabelStatus[]

Uma lista que contém a ID exclusiva e o status de alteração do rótulo de proteção de informações de um ou mais fluxos de dados

datasets

ChangeLabelStatus[]

Uma lista que contém a ID exclusiva e o status de alteração do rótulo de proteção de informações de um ou mais conjuntos de dados

reports

ChangeLabelStatus[]

Uma lista que contém a ID exclusiva e o status de alteração do rótulo de proteção de informações de um ou mais relatórios

status

O status de uma operação de alteração de rótulo de proteção de informações

Nome Tipo Description
Failed

string

Falha ao definir um novo rótulo. Tente novamente.

FailedToGetUsageRights

string

Falha ao definir um novo rótulo. O item do Power BI tem um rótulo de confidencialidade com configurações de proteção e o Power BI não pôde verificar se o usuário tem direitos de uso suficientes para alterar o rótulo.

InsufficientUsageRights

string

Falha ao definir um novo rótulo. O item do Power BI tem um rótulo de confidencialidade com configurações de proteção e o usuário administrador (e o usuário delegado, se fornecido) não tem direitos de uso suficientes para alterar o rótulo.

NotFound

string

A ID ou o rótulo do item do Power BI não foi encontrado

Succeeded

string

O rótulo de item do Power BI foi alterado