Items - Update Item

Servicio:: Core

Versión de la API:: v1

Actualiza las propiedades del elemento especificado.
Esta API se admite para varios tipos de elementos, busque los tipos de elementos admitidos e información sobre su estructura de definición en Información general de administración de elementos.

Permisos

El autor de la llamada debe tener permisos de lectura y escritura para el elemento.

Ámbitos delegados necesarios

Para las API de elementos, use estos tipos de ámbito:

Ámbito genérico: Item.ReadWrite.All
Ámbito específico: itemType. ReadWrite.All (por ejemplo: Notebook.ReadWrite.All)

para obtener más información sobre los ámbitos, vea: artículo ámbitos.

Microsoft Entra identidades admitidas

Esta API admite los Microsoft identities enumerados en esta sección.

Identidad	Apoyo
Usuario	Sí
Entidad de servicio e Identidades administradas	Cuando se admite el tipo de elemento en la llamada. Compruebe la API correspondiente para el tipo de elemento al que llama, para ver si se admite la llamada. Por ejemplo, se admiten modelos semánticos.

Interfaz

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
itemId	path	True	string (uuid)	Identificador del elemento.
workspaceId	path	True	string (uuid)	Identificador del área de trabajo.

Cuerpo de la solicitud

Nombre	Tipo	Description
description	string	Descripción del elemento. La longitud máxima es de 256 caracteres.
displayName	string	Nombre para mostrar del elemento. El nombre para mostrar debe seguir las reglas de nomenclatura según el tipo de elemento.

Respuestas

Nombre Tipo Description

200 OK

Nombre	Tipo	Description
200 OK	Item	Solicitud completada correctamente.
429 Too Many Requests	ErrorResponse	Se superó el límite de frecuencia de servicio. El servidor devuelve un `Retry-After` encabezado que indica, en segundos, cuánto tiempo debe esperar el cliente antes de enviar solicitudes adicionales. Encabezados Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de error comunes: ItemNotFound: no se encontró el elemento solicitado. InvalidRequest: solicitud de actualización no válida.

Item

Solicitud completada correctamente.

429 Too Many Requests

ErrorResponse

Se superó el límite de frecuencia de servicio. El servidor devuelve un Retry-After encabezado que indica, en segundos, cuánto tiempo debe esperar el cliente antes de enviar solicitudes adicionales.

Encabezados

Retry-After: integer

Other Status Codes

ErrorResponse

Códigos de error comunes:

ItemNotFound: no se encontró el elemento solicitado.
InvalidRequest: solicitud de actualización no válida.

Ejemplos

Update an item example

Solicitud de ejemplo

HTTP

PATCH https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/5b218778-e7a5-4d73-8187-f10824047715

{
  "displayName": "Item's New name",
  "description": "Item's New description"
}

Respuesta de muestra

status code:: 200

{
  "displayName": "Item's New name",
  "description": "Item's New description",
  "type": "Lakehouse",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}

Definiciones

Nombre	Description
EntireTenantPrincipal	Representa una entidad de seguridad de inquilino
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
GroupDetails	Detalles específicos del grupo. Aplicable cuando el tipo de entidad de seguridad es `Group`.
GroupPrincipal	Representa un grupo de seguridad.
GroupType	Tipo del grupo. Se pueden agregar tipos de grupo adicionales a lo largo del tiempo.
Item	Objeto item.
ItemTag	Representa una etiqueta aplicada en un elemento.
ItemType	Tipo del elemento. Se pueden agregar tipos de elementos adicionales a lo largo del tiempo.
PrincipalType	Tipo de la entidad de seguridad. Se pueden agregar tipos de entidad de seguridad adicionales a lo largo del tiempo.
SensitivityLabel	Representa una etiqueta de confidencialidad aplicada a un elemento.
ServicePrincipalDetails	Detalles específicos de la entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es `ServicePrincipal`.
ServicePrincipalPrincipal	Representa una entidad de servicio de Microsoft Entra.
ServicePrincipalProfileDetails	Detalles del perfil de entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Representa un perfil de entidad de servicio.
UpdateItemRequest	Actualizar solicitud de elemento.
UserDetails	Detalles específicos de la entidad de seguridad de usuario. Aplicable cuando el tipo de entidad de seguridad es `User`.
UserPrincipal	Representa una entidad de seguridad de usuario Microsoft Entra.

EntireTenantPrincipal

Objeto

Representa una entidad de seguridad de inquilino

Nombre	Tipo	Description
displayName	string	Nombre para mostrar de la entidad de seguridad.
id	string (uuid)	Identificador de la entidad de seguridad.
type	string: EntireTenant	Tipo de la entidad de seguridad. Se pueden agregar tipos de entidad de seguridad adicionales a lo largo del tiempo.

ErrorRelatedResource

Objeto

Objeto de detalles del recurso relacionado con el error.

Nombre	Tipo	Description
resourceId	string	Identificador de recurso implicado en el error.
resourceType	string	Tipo del recurso implicado en el error.

ErrorResponse

Objeto

Respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message	string	Representación legible del error.
moreDetails	ErrorResponseDetails[]	Lista de detalles de error adicionales.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.
requestId	string (uuid)	Identificador de la solicitud asociada al error.

ErrorResponseDetails

Objeto

Detalles de la respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message	string	Representación legible del error.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.

GroupDetails

Objeto

Detalles específicos del grupo. Aplicable cuando el tipo de entidad de seguridad es Group.

Nombre	Tipo	Description
groupType	GroupType	Tipo del grupo. Se pueden agregar tipos de grupo adicionales a lo largo del tiempo.

GroupPrincipal

Objeto

Representa un grupo de seguridad.

Nombre	Tipo	Description
displayName	string	Nombre para mostrar de la entidad de seguridad.
groupDetails	GroupDetails	Detalles específicos del grupo. Aplicable cuando el tipo de entidad de seguridad es `Group`.
id	string (uuid)	Identificador de la entidad de seguridad.
type	string: Group	Tipo de la entidad de seguridad. Se pueden agregar tipos de entidad de seguridad adicionales a lo largo del tiempo.

GroupType

Enumeración

Tipo del grupo. Se pueden agregar tipos de grupo adicionales a lo largo del tiempo.

Valor	Description
Unknown	El tipo de grupo principal es desconocido.
SecurityGroup	La entidad de seguridad es un grupo de seguridad.
DistributionList	La entidad de seguridad es una lista de distribución.

Item

Objeto

Objeto item.

Nombre	Tipo	Description
defaultIdentity	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Identidad predeterminada del elemento.
description	string	Descripción del elemento.
displayName	string	Nombre para mostrar del elemento.
folderId	string (uuid)	Identificador de carpeta.
id	string (uuid)	Identificador del elemento.
sensitivityLabel	SensitivityLabel	Etiqueta de confidencialidad del elemento.
tags	ItemTag[]	Lista de etiquetas aplicadas.
type	ItemType	Tipo de elemento.
workspaceId	string (uuid)	Identificador del área de trabajo.

ItemTag

Objeto

Representa una etiqueta aplicada en un elemento.

Nombre	Tipo	Description
displayName	string	Nombre de la etiqueta.
id	string (uuid)	Identificador de etiqueta.

ItemType

Enumeración

Tipo del elemento. Se pueden agregar tipos de elementos adicionales a lo largo del tiempo.

Valor	Description
Dashboard	Panel de PowerBI.
Report	Informe de PowerBI.
SemanticModel	Modelo semántico de PowerBI.
PaginatedReport	Informe paginado de PowerBI.
Datamart	Datamart de PowerBI.
Lakehouse	Una casa de lago.
Eventhouse	Un centro de eventos.
Environment	Un entorno.
KQLDatabase	Una base de datos KQL.
KQLQueryset	Un conjunto de consultas KQL.
KQLDashboard	Un panel de KQL.
DataPipeline	Una canalización de datos.
Notebook	Un cuaderno.
SparkJobDefinition	Una definición de trabajo de Spark.
MLExperiment	Un experimento de aprendizaje automático.
MLModel	Un modelo de aprendizaje automático.
Warehouse	Un almacén.
Eventstream	Una secuencia de eventos.
SQLEndpoint	Un punto de conexión de SQL.
MirroredWarehouse	Un almacén reflejado.
MirroredDatabase	Una base de datos reflejada.
Reflex	Un reflejo.
GraphQLApi	Una API para el elemento GraphQL.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	Un trabajo de copia.
VariableLibrary	A VariableLibrary.
Dataflow	Flujo de datos.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Una instantánea de almacenamiento.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Un flujo de Digital Twin Builder.
MirroredAzureDatabricksCatalog	Un catálogo de Azure Databricks reflejado.
Map	Un mapa.
AnomalyDetector	An Anomaly Detector.
UserDataFunction	Una función de datos de usuario.
GraphModel	Un GraphModel.
GraphQuerySet	Un conjunto de consultas de Graph.
SnowflakeDatabase	Una base de datos de Snowflake para almacenar tablas de Cosmos creadas a partir de la cuenta de Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Una base de datos de Cosmos DB.
Ontology	Una ontología.
EventSchemaSet	An EventSchemaSet.
DataAgent	A DataAgent.

PrincipalType

Enumeración

Tipo de la entidad de seguridad. Se pueden agregar tipos de entidad de seguridad adicionales a lo largo del tiempo.

Valor	Description
User	La entidad de seguridad es una entidad de seguridad de usuario Microsoft Entra.
ServicePrincipal	La entidad de seguridad es una entidad de servicio Microsoft Entra.
Group	La entidad de seguridad es un grupo de seguridad.
ServicePrincipalProfile	La entidad de servicio es un perfil de entidad de servicio.
EntireTenant	La entidad de seguridad representa todos los usuarios de inquilinos.

SensitivityLabel

Objeto

Representa una etiqueta de confidencialidad aplicada a un elemento.

Nombre	Tipo	Description
id	string (uuid)	Identificador de etiqueta de confidencialidad.

ServicePrincipalDetails

Objeto

Detalles específicos de la entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es ServicePrincipal.

Nombre	Tipo	Description
aadAppId	string (uuid)	AppId de Microsoft Entra de la entidad de servicio.

ServicePrincipalPrincipal

Objeto

Representa una entidad de servicio de Microsoft Entra.

Nombre	Tipo	Description
displayName	string	Nombre para mostrar de la entidad de seguridad.
id	string (uuid)	Identificador de la entidad de seguridad.
servicePrincipalDetails	ServicePrincipalDetails	Detalles específicos de la entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es `ServicePrincipal`.
type	string: ServicePrincipal	Tipo de la entidad de seguridad. Se pueden agregar tipos de entidad de seguridad adicionales a lo largo del tiempo.

ServicePrincipalProfileDetails

Objeto

Detalles del perfil de entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es ServicePrincipalProfile.

Nombre	Tipo	Description
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	La entidad de seguridad principal del perfil de la entidad de servicio.

ServicePrincipalProfilePrincipal

Objeto

Representa un perfil de entidad de servicio.

Nombre	Tipo	Description
displayName	string	Nombre para mostrar de la entidad de seguridad.
id	string (uuid)	Identificador de la entidad de seguridad.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Detalles del perfil de entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Tipo de la entidad de seguridad. Se pueden agregar tipos de entidad de seguridad adicionales a lo largo del tiempo.

UpdateItemRequest

Objeto

Actualizar solicitud de elemento.

Nombre	Tipo	Description
description	string	Descripción del elemento. La longitud máxima es de 256 caracteres.
displayName	string	Nombre para mostrar del elemento. El nombre para mostrar debe seguir las reglas de nomenclatura según el tipo de elemento.

UserDetails

Objeto

Detalles específicos de la entidad de seguridad de usuario. Aplicable cuando el tipo de entidad de seguridad es User.

Nombre	Tipo	Description
userPrincipalName	string	Nombre principal de usuario.

UserPrincipal

Objeto

Representa una entidad de seguridad de usuario Microsoft Entra.

Nombre	Tipo	Description
displayName	string	Nombre para mostrar de la entidad de seguridad.
id	string (uuid)	Identificador de la entidad de seguridad.
type	string: User	Tipo de la entidad de seguridad. Se pueden agregar tipos de entidad de seguridad adicionales a lo largo del tiempo.
userDetails	UserDetails	Detalles específicos de la entidad de seguridad de usuario. Aplicable cuando el tipo de entidad de seguridad es `User`.