Compartir a través de

Items - Update KQL Database Definition

Servicio:
KQLDatabase
Versión de la API:
v1

Invalida la definición de la base de datos KQL especificada.
Esta API admite operaciones de larga duración (LRO).

Permisos

El autor de la llamada debe tener permisos de lectura y escritura para la base de datos KQL.

Ámbitos delegados necesarios

KQLDatabase.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í
Entidad de servicio e Identidades administradas Sí

Interfaz

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/kqlDatabases/{kqlDatabaseId}/updateDefinition
Con parámetros opcionales: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/kqlDatabases/{kqlDatabaseId}/updateDefinition?updateMetadata={updateMetadata}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
kqlDatabaseId
 path True

string (uuid)

Identificador de base de datos KQL.
workspaceId
 path True

string (uuid)

El 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

KQLDatabaseDefinition

Objeto de definición pública de base de datos KQL.

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.

Ejemplos

Update a ReadWrite KQL database definition example

Solicitud de ejemplo

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

{
  "definition": {
    "parts": [
      {
        "path": "DatabaseProperties.json",
        "payload": "ewogICJkYXRhYmFzZVR5cGUiOiAiUmVhZFdyaXRlIiwKICAicGFyZW50RXZlbnRob3VzZUl0ZW1JZCI6ICI1YjIxODc3OC1lN2E1LTRkNzMtODE4Ny1mMTA4MjQwNDc4MzYiLAogICJvbmVMYWtlQ2FjaGluZ1BlcmlvZCI6ICJQMzY1MDBEIiwKICAib25lTGFrZVN0YW5kYXJkU3RvcmFnZVBlcmlvZCI6ICJQMzY1MDBEIgp9",
        "payloadType": "InlineBase64"
      },
      {
        "path": "DatabaseSchema.kql",
        "payload": "Ly8gS1FMIHNjcmlwdAovLyBVc2UgbWFuYWdlbWVudCBjb21tYW5kcyBpbiB0aGlzIHNjcmlwdCB0byBjb25maWd1cmUgeW91ciBkYXRhYmFzZSBpdGVtcywgc3VjaCBhcyB0YWJsZXMsIGZ1bmN0aW9ucywgbWF0ZXJpYWxpemVkIHZpZXdzLCBhbmQgbW9yZS4KCi5jcmVhdGUtbWVyZ2UgdGFibGUgTXlMb2dzIChMZXZlbDpzdHJpbmcsIFRpbWVzdGFtcDpkYXRldGltZSwgVXNlcklkOnN0cmluZywgVHJhY2VJZDpzdHJpbmcsIE1lc3NhZ2U6c3RyaW5nLCBQcm9jZXNzSWQ6aW50KQ==",
        "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/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
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.
KQLDatabaseDefinition

Objeto de definición pública de base de datos KQL.
KQLDatabaseDefinitionPart

Objeto de elemento de definición de base de datos KQL.
PayloadType

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

Actualice la carga de la solicitud de definición pública de la base de datos KQL.

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.

KQLDatabaseDefinition

Object

Objeto de definición pública de base de datos KQL.

Nombre Tipo Description
format

string

Formato de la definición de elemento.
parts

KQLDatabaseDefinitionPart[]

Lista de elementos de definición.

KQLDatabaseDefinitionPart

Object

Objeto de elemento de definición de base de datos KQL.

Nombre Tipo Description
path

string

Ruta de acceso del elemento de base de datos KQL.
payload

string

Carga del elemento de base de datos KQL.
payloadType

PayloadType

Tipo de carga.

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.

UpdateKQLDatabaseDefinitionRequest

Object

Actualice la carga de la solicitud de definición pública de la base de datos KQL.

Nombre Tipo Description
definition

KQLDatabaseDefinition

Objeto de definición pública de base de datos KQL.