Items - Update KQL Database

Serviço:

KQLDatabase

Versão da API:

v1

Atualiza as propriedades do banco de dados KQL especificado.

Permissões

O chamador deve ter função de colaborador ou de espaço de trabalho superior.

Escopos delegados necessários

KQLDatabase.ReadWrite.All ou Item.ReadWrite.All

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identidade	Apoio
Utilizador	Sim
entidade de serviço e identidades gerenciadas	Sim

Interface

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/kqlDatabases/{kqlDatabaseId}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
kqlDatabaseId	path	True	string uuid	A ID do banco de dados KQL.
workspaceId	path	True	string uuid	A ID do workspace.

Corpo da solicitação

Nome	Tipo	Description
description	string	A descrição do banco de dados KQL. O comprimento máximo é de 256 caracteres.
displayName	string	O nome de exibição do banco de dados KQL. O nome do banco de dados pode conter caracteres alfanuméricos, sublinhados, períodos e hifens. Não há suporte para caracteres especiais.

Respostas

Nome	Tipo	Description
200 OK	KQLDatabase	Solicitação concluída com êxito.
Other Status Codes	ErrorResponse	Códigos de erro comuns: ItemNotFound - O item solicitado não foi encontrado InvalidRequest – Solicitação de atualização inválida.

Exemplos

Update a KQL database example

Solicitação de exemplo

HTTP

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

{
  "displayName": "KQLDatabase_New_Name",
  "description": "A new description for KQL database."
}

Resposta de exemplo

Código de status:

200

{
  "displayName": "KQLDatabase_New_Name",
  "description": "A new description for KQL database.",
  "type": "KQLDatabase",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Definições

Nome	Description
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
ItemType	O tipo do item. Tipos de item adicionais podem ser adicionados ao longo do tempo.
KQLDatabase	Um objeto de banco de dados KQL.
KQLDatabaseProperties	As propriedades do banco de dados KQL.
KqlDatabaseType	O tipo do banco de dados.
UpdateKQLDatabaseRequest	Atualizar solicitação de banco de dados KQL.

ErrorRelatedResource

Objeto

O objeto de detalhes do recurso relacionado ao erro.

Nome	Tipo	Description
resourceId	string	A ID do recurso envolvida no erro.
resourceType	string	O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.
requestId	string	ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.

ItemType

Enumeração

O tipo do item. Tipos de item adicionais podem ser adicionados ao longo do tempo.

Valor	Description
Dashboard	Painel do PowerBI.
DataPipeline	Um pipeline de dados.
Datamart	Datamart do PowerBI.
Environment	Um ambiente.
Eventhouse	Uma casa de eventos.
Eventstream	Um fluxo de eventos.
GraphQLApi	Um item de API para GraphQL.
KQLDashboard	Um painel KQL.
KQLDatabase	Um banco de dados KQL.
KQLQueryset	Um conjunto de consultas KQL.
Lakehouse	Uma casa no lago.
MLExperiment	Um experimento de aprendizado de máquina.
MLModel	Um modelo de machine learning.
MirroredDatabase	Um banco de dados espelhado.
MirroredWarehouse	Um armazém espelhado.
MountedDataFactory	Um MountedDataFactory.
Notebook	Um bloco de anotações.
PaginatedReport	Relatório paginado do PowerBI.
Reflex	Um Reflexo.
Report	Relatório do PowerBI.
SQLDatabase	Um SQLDatabase.
SQLEndpoint	Um ponto de extremidade SQL.
SemanticModel	Modelo semântico do PowerBI.
SparkJobDefinition	Uma definição de trabalho do Spark.
Warehouse	Um armazém.

KQLDatabase

Objeto

Um objeto de banco de dados KQL.

Nome	Tipo	Description
description	string	A descrição do item.
displayName	string	O nome de exibição do item.
id	string uuid	A ID do item.
properties	KQLDatabaseProperties	As propriedades do banco de dados KQL.
type	ItemType	O tipo de item.
workspaceId	string uuid	A ID do workspace.

KQLDatabaseProperties

Objeto

As propriedades do banco de dados KQL.

Nome	Tipo	Description
databaseType	KqlDatabaseType	O tipo do banco de dados.
ingestionServiceUri	string	URI do serviço de ingestão.
parentEventhouseItemId	string	ID da casa de eventos pai.
queryServiceUri	string	URI do serviço de consulta.

KqlDatabaseType

Enumeração

O tipo do banco de dados.

Valor	Description
ReadWrite	Permite operações de leitura e gravação no banco de dados.
Shortcut	Um atalho é uma referência inserida que permite operações somente leitura em um banco de dados de origem. A origem pode estar nos mesmos locatários ou em locatários diferentes, seja em um cluster do Azure Data Explorer ou em um Fabric Eventhouse.

UpdateKQLDatabaseRequest

Objeto

Atualizar solicitação de banco de dados KQL.

Nome	Tipo	Description
description	string	A descrição do banco de dados KQL. O comprimento máximo é de 256 caracteres.
displayName	string	O nome de exibição do banco de dados KQL. O nome do banco de dados pode conter caracteres alfanuméricos, sublinhados, períodos e hifens. Não há suporte para caracteres especiais.