Items - Update Variable Library Definition

Servicio:: VariableLibrary

Versión de la API:: v1

Invalida la definición de la biblioteca de variables especificada.
Esta API admite operaciones de larga duración (LRO).

La actualización de la definición de VariableLibrary no afecta a su etiqueta de confidencialidad.

Permisos

El autor de la llamada debe tener permisos de lectura y escritura para la biblioteca de variables.

Ámbitos delegados necesarios

VariableLibrary.ReadWrite.All o Item.ReadWrite.All

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

identidad	Apoyo
Usuario	Sí
de entidad de servicio y identidades administradas	Sí

Interfaz

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/VariableLibraries/{variableLibraryId}/updateDefinition

Con parámetros opcionales:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/VariableLibraries/{variableLibraryId}/updateDefinition?updateMetadata={updateMetadata}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
variableLibraryId	path	True	string (uuid)	Identificador variableLibrary.
workspaceId	path	True	string (uuid)	Identificador del área de trabajo.
updateMetadata	query		boolean	Cuando se establece en true y el archivo .platform se proporciona como parte de la definición, los metadatos del elemento se actualizan mediante los metadatos del archivo .platform.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
definition	True	VariableLibraryPublicDefinition	Objeto de definición pública VariableLibrary. Consulte este artículo para obtener más información sobre cómo crear una definición pública variableLibrary.

Respuestas

Nombre	Tipo	Description
200 OK		Solicitud completada correctamente.
202 Accepted		Solicitud aceptada. La definición de actualización está en curso. Encabezados Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de error comunes: OperationNotSupportedForItem: no se admite la operación para el elemento solicitado. CorruptedPayload: la carga proporcionada está dañada.

Nombre

Tipo

Description

200 OK

Solicitud completada correctamente.

202 Accepted

Solicitud aceptada. La definición de actualización está en curso.

Encabezados

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Códigos de error comunes:

OperationNotSupportedForItem: no se admite la operación para el elemento solicitado.
CorruptedPayload: la carga proporcionada está dañada.

Ejemplos

Update a VariableLibrary public definition example

Solicitud de ejemplo

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/VariableLibraries/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "definition": {
    "parts": [
      {
        "path": "variables.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "valueSets/valueSet1.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "settings.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Respuesta de muestra

status code:: 200

status code:: 202

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Definiciones

Nombre	Description
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
PayloadType	Tipo de la carga de la parte de definición. Se pueden agregar tipos de carga adicionales a lo largo del tiempo.
UpdateVariableLibraryDefinitionRequest	Actualice la carga de la solicitud de definición pública variableLibrary.
VariableLibraryPublicDefinition	Objeto de definición pública VariableLibrary. Consulte este artículo para obtener más información sobre cómo crear una definición pública variableLibrary.
VariableLibraryPublicDefinitionPart	VariableLibrary definition part object.

ErrorRelatedResource

Object

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

Object

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	Identificador de la solicitud asociada al error.

ErrorResponseDetails

Object

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.

PayloadType

Enumeración

Tipo de la carga de la parte de definición. Se pueden agregar tipos de carga adicionales a lo largo del tiempo.

Valor	Description
InlineBase64	Base 64 insertada.

UpdateVariableLibraryDefinitionRequest

Object

Actualice la carga de la solicitud de definición pública variableLibrary.

Nombre	Tipo	Description
definition	VariableLibraryPublicDefinition	Objeto de definición pública VariableLibrary. Consulte este artículo para obtener más información sobre cómo crear una definición pública variableLibrary.

VariableLibraryPublicDefinition

Object

Objeto de definición pública VariableLibrary. Consulte este artículo para obtener más información sobre cómo crear una definición pública variableLibrary.

Nombre	Tipo	Description
format	string	Formato de la definición de elemento. Formato admitido: `VariableLibraryV1`.
parts	VariableLibraryPublicDefinitionPart[]	Lista de elementos de definición.

VariableLibraryPublicDefinitionPart

Object

VariableLibrary definition part object.

Nombre	Tipo	Description
path	string	Ruta de acceso de elemento de definición pública VariableLibrary.
payload	string	La carga de la parte de definición pública VariableLibrary.
payloadType	PayloadType	Tipo de carga.

Compartir a través de

Items - Update Variable Library Definition

Permisos

Ámbitos delegados necesarios

Identidades admitidas de Microsoft Entra

Interfaz

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Ejemplos

Update a VariableLibrary public definition example

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

PayloadType

UpdateVariableLibraryDefinitionRequest

VariableLibraryPublicDefinition

VariableLibraryPublicDefinitionPart