Admin - InformationProtection SetLabelsAsAdmin

Referencia

Service:: Power BI REST APIs

API Version:: v1.0

Establezca etiquetas de confidencialidad en elementos de Power BI (como informes o paneles) por identificador de elemento.

Para establecer una etiqueta de confidencialidad mediante esta API, el usuario administrador o el usuario delegado (si se proporciona) deben tener la etiqueta incluida en su directiva de etiquetas. Para obtener un ejemplo de uso, consulte Establecimiento o eliminación de etiquetas de confidencialidad.

Permisos

El usuario debe tener derechos de administrador (como Office 365 administrador global o administrador del servicio Power BI).
El usuario administrador y el usuario delegado (si se proporcionan) deben tener suficientes derechos de uso para establecer etiquetas.

Ámbito requerido

Tenant.ReadWrite.All

Limitaciones

Máximo de 25 solicitudes por hora.
Cada solicitud puede actualizar hasta 2000 elementos de Power BI.

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

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
artifacts	True	InformationProtectionArtifactsChangeLabel	Una composición de identificadores de elementos de Power BI para cada tipo de elemento
labelId	True	string	Identificador de etiqueta, que debe estar en la directiva de etiqueta del usuario.
assignmentMethod		assignmentMethod	Especifica si un proceso automatizado estableció la etiqueta asignada o manualmente.
delegatedUser		DelegatedUser	Detalles del usuario delegado. Un usuario delegado es un usuario de una organización cuyo administrador establece una etiqueta en nombre del usuario. Aunque el administrador establece la etiqueta, el usuario delegado se marca como emisor de etiquetas.

Respuestas

Nombre	Tipo	Description
200 OK	InformationProtectionChangeLabelResponse	Aceptar

Ejemplos

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

Definiciones

Nombre	Description
ArtifactId	Identificador único de un elemento de Power BI en formato UUID. Los identificadores de panel, informe y flujo de datos están en formato UUID y los identificadores de conjunto de datos pueden estar en formato UUID o de cadena.
ArtifactStringId	Identificador único de un elemento de Power BI en formato de cadena o UUID. Los identificadores de panel, informe y flujo de datos están en formato UUID y los identificadores de conjunto de datos pueden estar en formato UUID o de cadena.
assignmentMethod	Especifica si un proceso automatizado estableció la etiqueta asignada o manualmente.
ChangeLabelStatus	El identificador único y el estado de cambio de etiqueta de protección de la información de un elemento de Power BI
DelegatedUser	Detalles del usuario delegado. El usuario debe ser un usuario existente en Power BI y Azure AAD y debe haber iniciado sesión en Power BI durante los últimos tres meses.
InformationProtectionArtifactsChangeLabel	Compuesto de identificadores de elementos de Power BI para cada tipo de elemento. Los identificadores especifican qué elementos de Power BI requieren una actualización de la etiqueta de protección de la información.
InformationProtectionChangeLabelDetails	Una composición de la información de etiqueta necesaria para actualizar una etiqueta de protección de la información
InformationProtectionChangeLabelResponse	Una composición del estado de cambio de identificador y etiqueta de protección de la información para uno o varios elementos de Power BI organizados por tipo
status	Estado de una operación de cambio de etiqueta de protección de información

ArtifactId

Identificador único de un elemento de Power BI en formato UUID. Los identificadores de panel, informe y flujo de datos están en formato UUID y los identificadores de conjunto de datos pueden estar en formato UUID o de cadena.

Nombre	Tipo	Description
id	string	Un identificador en formato UUID

ArtifactStringId

Identificador único de un elemento de Power BI en formato de cadena o UUID. Los identificadores de panel, informe y flujo de datos están en formato UUID y los identificadores de conjunto de datos pueden estar en formato UUID o de cadena.

Nombre	Tipo	Description
id	string	Un identificador en formato de cadena o UUID

assignmentMethod

Especifica si un proceso automatizado estableció la etiqueta asignada o manualmente.

Nombre	Tipo	Description
Priviledged	string	La etiqueta se estableció manualmente.
Standard	string	La etiqueta se estableció mediante un proceso automatizado (valor predeterminado)

ChangeLabelStatus

El identificador único y el estado de cambio de etiqueta de protección de la información de un elemento de Power BI

Nombre	Tipo	Description
id	string	Identificador único de un elemento de Power BI. El identificador está en formato UUID para paneles, informes y flujos de datos; y en formato UUID o cadena para conjuntos de datos.
status	status	Estado de una operación de cambio de etiqueta de protección de información

DelegatedUser

Detalles del usuario delegado. El usuario debe ser un usuario existente en Power BI y Azure AAD y debe haber iniciado sesión en Power BI durante los últimos tres meses.

Nombre	Tipo	Description
emailAddress	string	Dirección de correo electrónico del usuario delegado

InformationProtectionArtifactsChangeLabel

Compuesto de identificadores de elementos de Power BI para cada tipo de elemento. Los identificadores especifican qué elementos de Power BI requieren una actualización de la etiqueta de protección de la información.

Nombre	Tipo	Description
dashboards	ArtifactId[]	Una lista de identificadores de panel únicos
dataflows	ArtifactId[]	Una lista de identificadores de flujo de datos únicos
datasets	ArtifactStringId[]	Una lista de identificadores de conjunto de datos únicos
reports	ArtifactId[]	Una lista de identificadores de informe únicos

InformationProtectionChangeLabelDetails

Una composición de la información de etiqueta necesaria para actualizar una etiqueta de protección de la información

Nombre	Tipo	Description
artifacts	InformationProtectionArtifactsChangeLabel	Una composición de identificadores de elementos de Power BI para cada tipo de elemento
assignmentMethod	assignmentMethod	Especifica si un proceso automatizado estableció la etiqueta asignada o manualmente.
delegatedUser	DelegatedUser	Detalles del usuario delegado. Un usuario delegado es un usuario de una organización cuyo administrador establece una etiqueta en nombre del usuario. Aunque el administrador establece la etiqueta, el usuario delegado se marca como emisor de etiquetas.
labelId	string	Identificador de etiqueta, que debe estar en la directiva de etiqueta del usuario.

InformationProtectionChangeLabelResponse

Una composición del estado de cambio de identificador y etiqueta de protección de la información para uno o varios elementos de Power BI organizados por tipo

Nombre	Tipo	Description
dashboards	ChangeLabelStatus[]	Lista que contiene el identificador único y el estado de cambio de etiqueta de protección de la información de uno o varios paneles.
dataflows	ChangeLabelStatus[]	Lista que contiene el identificador único y el estado de cambio de etiqueta de protección de la información de uno o varios flujos de datos.
datasets	ChangeLabelStatus[]	Una lista que contiene el identificador único y el estado de cambio de etiqueta de protección de la información de uno o varios conjuntos de datos
reports	ChangeLabelStatus[]	Lista que contiene el identificador único y el estado de cambio de etiqueta de protección de la información de uno o varios informes.

status

Estado de una operación de cambio de etiqueta de protección de información

Nombre	Tipo	Description
Failed	string	No se pudo establecer una nueva etiqueta. Inténtelo de nuevo.
FailedToGetUsageRights	string	No se pudo establecer una nueva etiqueta. El elemento de Power BI tiene una etiqueta de confidencialidad con la configuración de protección y Power BI no pudo comprobar que el usuario tiene suficientes derechos de uso para cambiar la etiqueta.
InsufficientUsageRights	string	No se pudo establecer una nueva etiqueta. El elemento de Power BI tiene una etiqueta de confidencialidad con la configuración de protección y el usuario administrador (y el usuario delegado, si se proporciona) no tiene suficientes derechos de uso para cambiar la etiqueta.
NotFound	string	No se encontró el identificador o la etiqueta del elemento de Power BI.
Succeeded	string	Se cambió la etiqueta de elemento de Power BI